Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Return Model from log_model #5230

Merged
merged 12 commits into from Jan 12, 2022
Merged

Return Model from log_model #5230

merged 12 commits into from Jan 12, 2022

Conversation

liangz1
Copy link
Collaborator

@liangz1 liangz1 commented Jan 6, 2022

What changes are proposed in this pull request?

Provide a return value from mlflow.*.log_model() that contains model metadata such as model_uri, run_id,...
This metadata makes it easier for the user to do follow-up model loading.

How is this patch tested?

Existing tests + tests/models/test_model.py test_model_info()

Does this PR change the documentation?

  • No. You can skip the rest of this section.
  • Yes. Make sure the changed pages / sections render correctly by following the steps below.
  1. Check the status of the ci/circleci: build_doc check. If it's successful, proceed to the
    next step, otherwise fix it.
  2. Click Details on the right to open the job page of CircleCI.
  3. Click the Artifacts tab.
  4. Click docs/build/html/index.html.
  5. Find the changed pages / sections and make sure they render correctly.

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

mlflow.*.log_model() returns a ModelInfo instance that contains the metadata of the logged model.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/artifacts: Artifact stores and artifact logging
  • area/build: Build and test infrastructure for MLflow
  • area/docs: MLflow documentation pages
  • area/examples: Example code
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/projects: MLproject format, project running backends
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/server-infra: MLflow Tracking server backend
  • area/tracking: Tracking Service, tracking client APIs, autologging

Interface

  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Models
  • area/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registry
  • area/windows: Windows support

Language

  • language/r: R APIs and clients
  • language/java: Java APIs and clients
  • language/new: Proposals for new client languages

Integrations

  • integrations/azure: Azure and Azure ML integrations
  • integrations/sagemaker: SageMaker integrations
  • integrations/databricks: Databricks integrations

How should the PR be classified in the release notes? Choose one:

  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes

Signed-off-by: Liang Zhang <liang.zhang@databricks.com>
Signed-off-by: Liang Zhang <liang.zhang@databricks.com>
Signed-off-by: Liang Zhang <liang.zhang@databricks.com>
@github-actions github-actions bot added area/models MLmodel format, model serialization/deserialization, flavors rn/none List under Small Changes in Changelogs. labels Jan 6, 2022
mlflow/models/model.py Outdated Show resolved Hide resolved
mlflow/models/model.py Outdated Show resolved Hide resolved
@liangz1 liangz1 requested a review from dbczumar January 10, 2022 21:04
Copy link
Collaborator

@dbczumar dbczumar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM once all model flavors are updated!

Signed-off-by: Liang Zhang <liang.zhang@databricks.com>
Signed-off-by: Liang Zhang <liang.zhang@databricks.com>
Signed-off-by: Liang Zhang <liang.zhang@databricks.com>
Signed-off-by: Liang Zhang <liang.zhang@databricks.com>
mlflow/catboost.py Outdated Show resolved Hide resolved
Copy link
Member

@harupy harupy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM once #5230 (comment) is addressed.

Signed-off-by: Liang Zhang <liang.zhang@databricks.com>
…Info

Signed-off-by: Liang Zhang <liang.zhang@databricks.com>
mlflow/models/model.py Outdated Show resolved Hide resolved
@@ -109,6 +135,22 @@ def saved_input_example_info(self, value: Dict[str, Any]):
# pylint: disable=attribute-defined-outside-init
self._saved_input_example_info = value

def get_model_info(self):
"""
Create a :py:class:`ModelInfo <mlflow.models.model.ModelInfo>` instance that contains the
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@harupy Also,

:py:class:`ModelInfo <mlflow.models.model.ModelInfo>`

works while the following does not:

:py:class:`ModelInfo`

Thanks for helping!

mlflow/models/model.py Outdated Show resolved Hide resolved
flavors: Dict[str, Any]
model_uuid: str
saved_input_example_info: Dict[str, Any]
signature: ModelSignature
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
signature: ModelSignature
signature: Optional[ModelSignature]

Can we use Optional for properties that can be None?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed it to a native python dictionary that is ModelSignature.to_dict() to avoid importing pandas in mlflow skinny. Another reason is that for the user's information, there is no need to return the ModelSignature object. A dictionary should be sufficient for the purpose of information reading.

Signed-off-by: Liang Zhang <liang.zhang@databricks.com>

#: The UTC time that the logged model is created, e.g., ``'2022-01-12 05:17:31.634689'``.
utc_time_created: str

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added example values for some attributes.

Signed-off-by: Liang Zhang <liang.zhang@databricks.com>
Signed-off-by: Liang Zhang <liang.zhang@databricks.com>
"""
A dictionary that contains the metadata of the saved input example, e.g.,
``{"artifact_path": "input_example.json", "type": "dataframe", "pandas_orient": "split"}``.
"""
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Improve the Model class property docstring.

@liangz1 liangz1 merged commit 364aca7 into mlflow:master Jan 12, 2022
@liangz1 liangz1 deleted the return-log-model branch January 12, 2022 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/models MLmodel format, model serialization/deserialization, flavors rn/none List under Small Changes in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants