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 warning in MLflow pytorch docs to include signature #5347

Merged
merged 19 commits into from
Feb 7, 2022

Conversation

mehtayogita
Copy link
Collaborator

What changes are proposed in this pull request?

Updates MLFlow pytorch documentation to add warning suggesting to add signature while logging model to avoid float precision errors.

How is this patch tested?

Building docs locally and verifying the change.

Does this PR change the documentation?

  • No. You can skip the rest of this section.
  • Yes. Make sure the changed pages / sections render correctly by following the steps below.
  1. Check the status of the ci/circleci: build_doc check. If it's successful, proceed to the
    next step, otherwise fix it.
  2. Click Details on the right to open the job page of CircleCI.
  3. Click the Artifacts tab.
  4. Click docs/build/html/index.html.
  5. Find the changed pages / sections and make sure they render correctly.

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.

Updates the MLFlow pytorch documentation.

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

Add one line in the model signature introduction section and add link to detailed section in the introduction.

Signed-off-by: Yogita Mehta <yogita.mehta@databricks.com>
Signed-off-by: Yogita Mehta <yogita.mehta@databricks.com>
…g sphinx build locally.

Signed-off-by: Yogita Mehta <yogita.mehta@databricks.com>
…e while logging model to avoid float precision errors.

Signed-off-by: Yogita Mehta <yogita.mehta@databricks.com>
@github-actions github-actions bot added area/docs Documentation issues rn/none List under Small Changes in Changelogs. labels Feb 4, 2022
mehtayogita and others added 3 commits February 4, 2022 11:19
Signed-off-by: Yogita Mehta <yogita.mehta@databricks.com>
Signed-off-by: Yogita Mehta <yogita.mehta@databricks.com>
Signed-off-by: Yogita Mehta <yogita.mehta@databricks.com>
Signed-off-by: Yogita Mehta <yogita.mehta@databricks.com>
@mehtayogita
Copy link
Collaborator Author

autoformat

mlflow-automation and others added 3 commits February 4, 2022 20:24
Signed-off-by: mlflow-automation <mlflow-automation@users.noreply.github.com>
Signed-off-by: Yogita Mehta <yogita.mehta@databricks.com>
Signed-off-by: Yogita Mehta <yogita.mehta@databricks.com>
@mehtayogita
Copy link
Collaborator Author

autoformat

Signed-off-by: Yogita Mehta <yogita.mehta@databricks.com>
@mehtayogita
Copy link
Collaborator Author

autoformat

Signed-off-by: mlflow-automation <mlflow-automation@users.noreply.github.com>
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.

Good start - a few notes

mlflow/pytorch/__init__.py Show resolved Hide resolved
mlflow/pytorch/__init__.py Outdated Show resolved Hide resolved
.. warning::

Log the model with signature to avoid inference errors. Pytorch float precision default
is float32, while numpy float precision default is float64. Adding the signature will
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would maybe re-frame this a bit and say:

For models without signatures, the MLflow Model Server relies on the default inferred data type from NumPy. However, PyTorch often expects different defaults, particularly when parsing floats.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Updated as suggested.

mlflow/pytorch/__init__.py Show resolved Hide resolved
Signed-off-by: Yogita Mehta <yogita.mehta@databricks.com>
Signed-off-by: Yogita Mehta <yogita.mehta@databricks.com>
Signed-off-by: Yogita Mehta <yogita.mehta@databricks.com>
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.

One minor nit, but looks great otherwise!

mlflow/pytorch/__init__.py Outdated Show resolved Hide resolved
Signed-off-by: Yogita Mehta <yogita.mehta@databricks.com>
For models without signatures, the MLflow Model Server relies on the default inferred
data type from NumPy. However, PyTorch often expects different defaults, particularly
when parsing floats. Include the signature to ensure that the model is logged with the
correct data type so that the MLflow model server can correctly provide valid input
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
correct data type so that the MLflow model server can correctly provide valid input
correct data type so that the MLflow model server correctly provides valid input

Copy link
Collaborator

Choose a reason for hiding this comment

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

Just to clarify @andreakress - one thing I think would be good to emphasize is that by logging a signature, the user is making it possible for the model server to provide valid input. Correctly inferring the correct data types without the signature is an impossible problem. Maybe just me, but, in your suggested phrasing, it kind of feels like we're saying that there's a bug where it won't provide it correctly.

Copy link
Contributor

Choose a reason for hiding this comment

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

WDYT of something like this:

If the model is logged without a signature, the MLflow Model Server relies on the default inferred data type from NumPy. However, PyTorch often expects different defaults, particularly when parsing floats. You must include the signature to ensure that the model is logged with the correct data type so that the MLflow model server can correctly provide valid input.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Sounds good!

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks for helping iterate on this one!

Copy link
Contributor

@andreakress andreakress left a comment

Choose a reason for hiding this comment

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

Approved with one suggestion.

Signed-off-by: Yogita Mehta <yogita.mehta@databricks.com>
@mehtayogita mehtayogita merged commit 1389683 into mlflow:master Feb 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation issues autoformat 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