Skip to content

Update model signature docs to center automatic signature inference#9036

Merged
jerrylian-db merged 2 commits intomasterfrom
update_signature_docs
Jul 10, 2023
Merged

Update model signature docs to center automatic signature inference#9036
jerrylian-db merged 2 commits intomasterfrom
update_signature_docs

Conversation

@jerrylian-db
Copy link
Collaborator

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Automatic signature inference from model input examples is now the recommended approach for logging model signatures. This PR updates the documentation to reflect that.

How is this patch tested?

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

I manually ran the code examples to verify that they work.

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 <[email protected]>
Signed-off-by: Jerry Liang <[email protected]>
@jerrylian-db jerrylian-db self-assigned this Jul 10, 2023
@jerrylian-db jerrylian-db requested a review from smurching July 10, 2023 18:21
@github-actions github-actions bot added area/docs Documentation issues rn/none List under Small Changes in Changelogs. labels Jul 10, 2023
@mlflow-automation
Copy link
Contributor

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

More info

Copy link
Collaborator

@smurching smurching left a comment

Choose a reason for hiding this comment

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

LGTM!

@jerrylian-db jerrylian-db merged commit 236b678 into master Jul 10, 2023
@jerrylian-db jerrylian-db deleted the update_signature_docs branch July 11, 2023 20:06
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.

3 participants