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 setting model signatures #8490

Merged
merged 5 commits into from
May 23, 2023
Merged

Conversation

jerrylian-db
Copy link
Collaborator

Related Issues/PRs

#8476

What changes are proposed in this pull request?

This PR adds documentation to demonstrate how to set model signatures on logged models, saved models, and model versions. It also improves model signature documentation to clarify use-cases, moving content around, and emphasizing that users set a signatures corresponding to the PyFunc model flavor.

How is this patch tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests (describe details, including test results, below)

Built the doc locally and manually inspected that it looks good.

Does this PR change the documentation?

  • No. You can skip the rest of this section.
  • Yes. Make sure the changed pages / sections render correctly in the documentation preview.

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.

(Details in 1-2 sentences. You can just refer to another PR with a description if this PR is part of a larger change.)

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/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/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: Jerry Liang <jerry.liang@databricks.com>
Signed-off-by: Jerry Liang <jerry.liang@databricks.com>
@jerrylian-db jerrylian-db self-assigned this May 22, 2023
Signed-off-by: Jerry Liang <jerry.liang@databricks.com>
@mlflow-automation
Copy link
Collaborator

mlflow-automation commented May 22, 2023

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

More info

@github-actions github-actions bot added area/docs Documentation issues rn/none List under Small Changes in Changelogs. labels May 22, 2023
Signed-off-by: Jerry Liang <jerry.liang@databricks.com>
docs/source/models.rst Outdated Show resolved Hide resolved
docs/source/models.rst Outdated Show resolved Hide resolved
Signed-off-by: Jerry Liang <jerry.liang@databricks.com>
@jerrylian-db jerrylian-db enabled auto-merge (squash) May 23, 2023 19:26
@jerrylian-db jerrylian-db merged commit 06db825 into master May 23, 2023
26 checks passed
@jerrylian-db jerrylian-db deleted the set_signature_doc branch May 26, 2023 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation issues 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