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

Support specifying 'latest' in model URI to get the latest version of a model regardless of the stage #5027

Merged
merged 4 commits into from Jan 10, 2022

Conversation

lichenran1234
Copy link
Contributor

@lichenran1234 lichenran1234 commented Nov 9, 2021

Signed-off-by: Chenran Li chenran.li@databricks.com

What changes are proposed in this pull request?

Support specifying 'latest' in model URI like models:/<model_name>/latest to get the latest version of a model regardless of the stage.

Also fix a bug in sqlalchemy_store.get_latest_versions(): when no stage argument is specified, it should return the latest versions of all stages. Now it's only returning latest versions for active stages.

  • according to the top-level comment in the proto file, it should return the latest version of all stages when no stage argument is specified
  • also fixed the contradictory comments in the docstring of the function:

Screen Shot 2021-11-08 at 17 48 52

In #4250, Anil also suggested supporting model URI formats like models:/<model_name>/latest-n to get the nth to last model version. But it requires too big of a change (e.g. extending the RegisteredModel class and the corresponding proto message to store not only the latest versions of a model, but also all versions). It may not be worth it to make such a big change for this small "latest-n" feature. So I'm not doing this in this PR.

How is this patch tested?

unit tests

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.

Now users can specify 'latest' in model URI like models:/<model_name>/latest to get the latest version of a model regardless of the stage. Previously users can only specify models:/<model_name>/<Stage> to get the latest version of a model on a specific stage.

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

… a model regardless of the stage

Signed-off-by: Chenran Li <chenran.li@databricks.com>
@github-actions github-actions bot added area/model-registry Model registry, model registry APIs, and the fluent client calls for model registry rn/feature Mention under Features in Changelogs. labels Nov 9, 2021
Signed-off-by: Chenran Li <chenran.li@databricks.com>
Signed-off-by: Chenran Li <chenran.li@databricks.com>
@lichenran1234 lichenran1234 requested review from wentinghu and removed request for arjundc-db November 9, 2021 19:08
@lichenran1234 lichenran1234 requested review from sueann and removed request for mparkhe November 17, 2021 19:46
Copy link
Collaborator

@ankit-db ankit-db left a comment

Choose a reason for hiding this comment

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

The change looks good to me - just a few questions! I do think it may qualify as a breaking change though, so we should make sure to change the label

mlflow/store/artifact/utils/models.py Outdated Show resolved Hide resolved
)
return latest[0].version
return max(map(lambda x: int(x.version), latest))
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just curious - why do we need to call int() here? I'm not opposed just for safety reasons, but x.version is already a number right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually model version is str: link. So it's safer to convert it into int here.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Got it

@@ -46,12 +59,16 @@ def _parse_model_uri(uri):

if parts[1].isdigit():
Copy link
Collaborator

Choose a reason for hiding this comment

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

Given the added complexity, it may be good to have an example of each URI type in the branch so that it's clear exactly which case maps to which tuple

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done, thanks!

Signed-off-by: Chenran Li <chenran.li@databricks.com>
@lichenran1234 lichenran1234 deleted the version branch January 7, 2022 22:43
@lichenran1234 lichenran1234 restored the version branch January 7, 2022 22:43
@lichenran1234 lichenran1234 reopened this Jan 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/model-registry Model registry, model registry APIs, and the fluent client calls for model registry area/sqlalchemy Use of SQL alchemy in tracking service or model registry rn/feature Mention under Features in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants