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 documentation for copy_model_version API #10140

Merged
merged 3 commits into from
Oct 26, 2023

Conversation

jerrylian-db
Copy link
Collaborator

@jerrylian-db jerrylian-db commented Oct 25, 2023

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

pip install git+https://github.com/mlflow/mlflow.git@refs/pull/10140/merge

Checkout with GitHub CLI

gh pr checkout 10140

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

As title.

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/docs: MLflow documentation pages
  • area/examples: Example code
  • area/gateway: AI Gateway service, Gateway client APIs, third-party Gateway integrations
  • 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

Signed-off-by: Jerry Liang <[email protected]>
@jerrylian-db jerrylian-db self-assigned this Oct 25, 2023
@github-actions github-actions bot added area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs. labels Oct 25, 2023
@github-actions
Copy link

github-actions bot commented Oct 25, 2023

Documentation preview for dd65d3c will be available here when this CircleCI job completes successfully.

More info

Signed-off-by: Jerry Liang <[email protected]>
and deployment for the model. In MLflow, you can use registered models to set up environments for your
MLflow Models, where each registered model corresponds to a specific environment. Furthermore, you can
configure access controls for the registered models using :ref:`MLflow Authentication <auth>`. Then,
to promote MLflow Models across environments, you can use the :meth:`~mlflow.client.MlflowClient.copy_model_version` method
Copy link
Member

Choose a reason for hiding this comment

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

do we need to use :py:meth: here instead of :meth: to get the proper reference? I'm actually not sure.
spoiler alert: it renders just fine. Pretty good inference on the part of sphinx.

Copy link
Member

@BenWilson2 BenWilson2 left a comment

Choose a reason for hiding this comment

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

LGTM after the typo is corrected!

Co-authored-by: Ben Wilson <[email protected]>
Signed-off-by: Jerry Liang <[email protected]>
@jerrylian-db jerrylian-db merged commit 51467d7 into master Oct 26, 2023
34 checks passed
@jerrylian-db jerrylian-db deleted the copy_model_version_docs branch October 26, 2023 21:16
BenWilson2 added a commit to BenWilson2/mlflow that referenced this pull request Oct 26, 2023
Signed-off-by: Jerry Liang <[email protected]>
Signed-off-by: Jerry Liang <[email protected]>
Co-authored-by: Ben Wilson <[email protected]>
KonakanchiSwathi pushed a commit to KonakanchiSwathi/mlflow that referenced this pull request Nov 29, 2023
Signed-off-by: Jerry Liang <[email protected]>
Signed-off-by: Jerry Liang <[email protected]>
Co-authored-by: Ben Wilson <[email protected]>
Signed-off-by: swathi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants