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

Add model registration argument for autolog #5395

Merged
merged 8 commits into from
Feb 25, 2022

Conversation

WeichenXu123
Copy link
Collaborator

@WeichenXu123 WeichenXu123 commented Feb 20, 2022

Signed-off-by: Weichen Xu weichen.xu@databricks.com

What changes are proposed in this pull request?

Add model registration argument for autolog

How is this patch tested?

Unit tests.

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.

Add model registration argument for autolog

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: Weichen Xu <weichen.xu@databricks.com>
@WeichenXu123 WeichenXu123 marked this pull request as draft February 20, 2022 12:08
@WeichenXu123 WeichenXu123 linked an issue Feb 20, 2022 that may be closed by this pull request
23 tasks
mlflow/lightgbm.py Outdated Show resolved Hide resolved
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
@WeichenXu123 WeichenXu123 marked this pull request as ready for review February 22, 2022 14:38
Comment on lines 656 to 664
with patch("mlflow.register_model") as mock_register_model, mlflow.start_run():
model.fit(X, y)

if registered_model_name is None:
mock_register_model.assert_not_called()
else:
mock_register_model.assert_called_once_with(
ANY, registered_model_name, await_registration_for=ANY
)
Copy link
Member

Choose a reason for hiding this comment

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

why not check the model is registered with the specified name?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

that might requires more code to write, and register_model functionality should be covered by the model registry testing code.

Copy link
Member

@harupy harupy Feb 23, 2022

Choose a reason for hiding this comment

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

that might require more code to write.

Are you sure? Can we just call get_registered_model? Let me know if I'm missing something. And why is writing more code an issue?

MlflowClient().get_registered_model(name)

seems (much) shorter (and more strict because assert_called_once_with doesn't guarantee register_model succeeded) than:

from unittest.mock import patch, ANY

with patch("mlflow.register_model") as mock_register_model:
  mock_register_model.assert_called_once_with(
    ANY, registered_model_name, await_registration_for=ANY
  )

Copy link
Member

Choose a reason for hiding this comment

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

register_model functionality should be covered by the model registry testing code.

Yes, but how do we ensure we don't pass incorrect arguments?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

updated using MlflowClient().get_registered_model(name) for test

@github-actions github-actions bot added area/tracking Tracking service, tracking client APIs, autologging rn/feature Mention under Features in Changelogs. labels Feb 22, 2022
mlflow/fastai/__init__.py Outdated Show resolved Hide resolved
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.

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
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 the lint check failure is fixed

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
@WeichenXu123
Copy link
Collaborator Author

A weird error in CI tensorflow 2.0.0 / 2.0.4
https://github.com/mlflow/mlflow/runs/5319733965?check_suite_focus=true#step:12:80

but I cannot reproduce it in my local machine. might be CI env setup issue.
shall this block the PR ?

@harupy
Copy link
Member

harupy commented Feb 25, 2022

shall this block the PR?

I think it does because the failed test (test_tf_keras_model_autolog_registering_model) was added by this PR.

@harupy
Copy link
Member

harupy commented Feb 25, 2022

@WeichenXu123 clear_tf_keras_imports might be the root cause. We could try running test_tf_keras_model_autolog_registering_model before clear_tf_keras_imports.

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
@harupy harupy merged commit 2e8a3c5 into mlflow:master Feb 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/tracking Tracking service, tracking client APIs, autologging rn/feature Mention under Features in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FR] Simplify model registration in autolog
3 participants