[go: nahoru, domu]
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.

Sign up for GitHub

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

Jump to bottom

Update the client to allow for retrieving the latest alias #12342

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update the client to allow for retrieving the latest alias #12342

wants to merge 1 commit into from

Conversation

kriscon-db
Copy link
Collaborator
@kriscon-db kriscon-db commented Jun 13, 2024 •
edited
Loading

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

How is this PR tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests

Does this PR require documentation update?

  • No. You can skip the rest of this section.
  • Yes. I've updated:
    • Examples
    • API references
    • Instructions

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.

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/deployments: MLflow Deployments client APIs, server, and third-party Deployments integrations
  • 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/recipes: Recipes, Recipe APIs, Recipe configs, Recipe Templates
  • 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/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/breaking-change - The PR will be mentioned in the "Breaking Changes" 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

Should this PR be included in the next patch release?

Yes should be selected for bug fixes, documentation updates, and other small changes. No should be selected for new features and larger changes. If you're unsure about the release classification of this PR, leave this unchecked to let the maintainers decide.

What is a minor/patch release?
  • Minor release: a release that increments the second part of the version number (e.g., 1.2.0 -> 1.3.0).
    Bug fixes, doc updates and new features usually go into minor releases.
  • Patch release: a release that increments the third part of the version number (e.g., 1.2.0 -> 1.2.1).
    Bug fixes and doc updates usually go into patch releases.
  • Yes (this PR will be cherry-picked and included in the next patch release)
  • No (this PR will be included in the next minor release)

@github-actions GitHub Actions
Copy link

@kriscon-db Thank you for the contribution! Could you fix the following issue(s)?

⚠ DCO check

The DCO check failed. Please sign off your commit(s) by following the instructions here. See https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md#sign-your-work for more details.

@github-actions github-actions bot added area/artifacts Artifact stores and artifact logging area/model-registry Model registry, model registry APIs, and the fluent client calls for model registry rn/none List under Small Changes in Changelogs. and removed area/model-registry Model registry, model registry APIs, and the fluent client calls for model registry labels Jun 13, 2024
kriscon-db
kriscon-db commented Jun 13, 2024
View reviewed changes
tests/utils/test_validation.py
@@ -165,6 +167,14 @@ def test_validate_model_alias_name_bad(alias_name):
_validate_model_alias_name(alias_name)
assert e.value.error_code == ErrorCode.Name(INVALID_PARAMETER_VALUE)

@pytest.mark.parametrize("alias_name", BAD_ALIAS_NAMES_WITHOUT_LATEST)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Update this to just be BAD_ALIAS_NAMES

artjen
artjen reviewed Jun 13, 2024
View reviewed changes
tests/utils/test_validation.py
"v123",
"V1",
]

LATEST_TESTS = ["latest", "Latest"]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we want all caps as well?

Suggested change
LATEST_TESTS = ["latest", "Latest"]
LATEST_TESTS = ["latest", "Latest", "LATEST"]

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sure. I can add.

smurching
smurching reviewed Jun 14, 2024
View reviewed changes
mlflow/store/model_registry/file_store.py
@@ -942,7 +942,7 @@ def delete_model_version_tag(self, name, version, key):

def _get_registered_model_alias_path(self, name, alias):
_validate_model_name(name)
_validate_model_alias_name(alias)
_validate_model_alias_name(alias, perform_latest_check=False)
Copy link
Collaborator

Choose a reason for hiding this comment

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

From offline discussion, we don't want to remove validation from the OSS storage backends (file/SQL store)

smurching
smurching reviewed Jun 14, 2024
View reviewed changes
mlflow/tracking/client.py
@@ -4729,5 +4729,5 @@ def print_model_version_info(mv):
Aliases: ["test-alias"]
"""
_validate_model_name(name)
_validate_model_alias_name(alias)
_validate_model_alias_name(alias, perform_latest_check=False)
Copy link
Collaborator
@smurching smurching Jun 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

It does make sense to remove validation from this client codepath (and in rest_store etc if we have validation there). I think on reads just removing validation entirely is fine, we can let the backend throw on an invalid name etc. For removing client-side write validation, we should make sure analogous logic is first present in all backends we maintain for at least one OSS release

smurching
smurching reviewed Jun 14, 2024
View reviewed changes
mlflow/utils/validation.py
@@ -397,7 +397,7 @@ def _validate_model_version(model_version):
)


def _validate_model_alias_name(model_alias_name):
def _validate_model_alias_name(model_alias_name, perform_latest_check=True):
Copy link
Collaborator
@smurching smurching Jun 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

We can probably get rid of this boolean / latest-specific logic if we switch to removing validation on reads + enforcing it on writes. And then this PR can be about removing client-side validation on fetching model versions by alias

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@smurching smurching smurching left review comments

@artjen artjen artjen left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
area/artifacts Artifact stores and artifact logging rn/none List under Small Changes in Changelogs.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@kriscon-db @smurching @artjen