Skip to content

Add a Python API to load model input examples#5212

Merged
ankit-db merged 5 commits into
mlflow:masterfrom
maitre-matt:master
Jan 4, 2022
Merged

Add a Python API to load model input examples#5212
ankit-db merged 5 commits into
mlflow:masterfrom
maitre-matt:master

Conversation

@maitre-matt

@maitre-matt maitre-matt commented Jan 2, 2022

Copy link
Copy Markdown
Contributor

What changes are proposed in this pull request?

This change adds a new Python API Model.load_input_example(), which wraps the internal-only method _read_example(). It allows tools which consume MLflow models to correctly load model input examples.

Associated Feature Request: #5211

How is this patch tested?

Added unit tests.

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.

Add a Python API to load model input examples

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

@maitre-matt
Add method to load model input example
e0f0c44 
Signed-off-by: Matthieu Maitre <mmaitre@microsoft.com>
@github-actions github-actions Bot added area/models MLmodel format, model serialization/deserialization, flavors rn/feature Mention under Features in Changelogs. labels Jan 2, 2022
@maitre-matt
Try fixing doc and lint failures
f17c180 
Signed-off-by: Matthieu Maitre <mmaitre@microsoft.com>
@ankit-db ankit-db self-requested a review January 3, 2022 21:52
@ankit-db

ankit-db commented Jan 3, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor

Thanks for filing the PR @maitre-matt - I'll add this to my review queue. It's a great idea!

ankit-db
ankit-db reviewed Jan 3, 2022
View reviewed changes

@ankit-db ankit-db left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Just a few brief comments

Comment thread tests/models/test_model.py
Comment thread mlflow/models/model.py Outdated
@maitre-matt maitre-matt requested a review from ankit-db January 4, 2022 00:56
ankit-db
ankit-db approved these changes Jan 4, 2022
View reviewed changes

@ankit-db ankit-db left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you so much for the contribution! This one's going to be super useful for people 😄

Comment thread tests/models/test_model.py Outdated
@ankit-db

ankit-db commented Jan 4, 2022

Copy link
Copy Markdown
Contributor

@maitre-matt I think I may have messed up the signoff by accepting a suggestion which creates a commit. Will fix it tmm and merge!

@maitre-matt

maitre-matt commented Jan 4, 2022

Copy link
Copy Markdown
Contributor Author

@maitre-matt I think I may have messed up the signoff by accepting a suggestion which creates a commit. Will fix it tmm and merge!

Thanks for the quick turnaround on that PR! Much appreciated. We are building ML tools and MLflow's standardization is making things a lot simpler.

harupy
harupy reviewed Jan 4, 2022
View reviewed changes
Comment thread mlflow/models/model.py Outdated
Comment on lines +85 to +87
from mlflow.models.utils import (
_read_example,
)

@harupy harupy Jan 4, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Not a big issue, but we can remove the comma.

Suggested change
from mlflow.models.utils import (
_read_example,
)
from mlflow.models.utils import _read_example

@mmaitre314 mmaitre314 Jan 4, 2022

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Reformatted to remove the comma

Liang Zhang and others added 3 commits January 4, 2022 08:20
@maitre-matt
Remove param 'evals_result' 'early_stopping_rounds' in lightgbm versi…
3f5913d 
…on > 3.3.1 (#5206)

The parameter evals_result is removed in the master of lightgbm: lightgbm-org/LightGBM#4882.
The parameter early_stopping_rounds is removed in the master of lightgbm: lightgbm-org/LightGBM#4908.

We should also remove this param in our test.

This PR also fixed the sagemaker test failure.

Signed-off-by: Liang Zhang <liang.zhang@databricks.com>
@maitre-matt
Address PR feedback
549254c 
Signed-off-by: Matthieu Maitre <mmaitre@microsoft.com>
@maitre-matt
Merge branch 'mlflow:master' into master
ff0f885
@ankit-db ankit-db merged commit 04e6c82 into mlflow:master Jan 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@harupy harupy harupy left review comments

+2 more reviewers

@mmaitre314 mmaitre314 mmaitre314 left review comments

@ankit-db ankit-db ankit-db approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

area/models MLmodel format, model serialization/deserialization, flavors rn/feature Mention under Features in Changelogs.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@maitre-matt @ankit-db @mmaitre314 @harupy