Skip to content

Rename df arg in deploy predict abstract method#6681

Merged
BenWilson2 merged 5 commits intobranch-2.0from
deploy-predict-arg-rename
Sep 2, 2022
Merged

Rename df arg in deploy predict abstract method#6681
BenWilson2 merged 5 commits intobranch-2.0from
deploy-predict-arg-rename

Conversation

@BenWilson2
Copy link
Copy Markdown
Member

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

rename the argument from df to data to reflect the broad allowable input types for pyfunc deployment serving in the .predict() abstract method.

How is this patch tested?

Existing tests

  • I have written tests (not required for typo or doc fix) and confirmed the proposed feature/bug-fix/change works.

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. Click the Details link on the Preview docs check.
  2. 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.

(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/pipelines: Pipelines, Pipeline APIs, Pipeline configs, Pipeline 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

@BenWilson2 BenWilson2 changed the base branch from master to branch-2.0 September 1, 2022 21:01
@github-actions github-actions bot added area/scoring MLflow Model server, model deployment tools, Spark UDFs rn/breaking-change Mention under Breaking Changes in Changelogs. labels Sep 1, 2022
Signed-off-by: Ben Wilson <[email protected]>

:param deployment_name: Name of deployment to predict against
:param df: Pandas DataFrame to use for inference
:param inputs: Input data (or arguments) used to generate inference from a model endpoint
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
:param inputs: Input data (or arguments) used to generate inference from a model endpoint
:param inputs: Input data (or arguments) to pass to the deployment or model endpoint for inference.

Note that the input/output types of this method matches that of `mlflow pyfunc predict`
(we accept a pandas DataFrame as input and return either a pandas DataFrame,
pandas Series, or numpy array as output).
Compute predictions on input data using the specified deployment.
Copy link
Copy Markdown
Collaborator

@dbczumar dbczumar Sep 2, 2022

Choose a reason for hiding this comment

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

Suggested change
Compute predictions on input data using the specified deployment.
Compute predictions on inputs using the specified deployment or model endpoint.

(we accept a pandas DataFrame as input and return either a pandas DataFrame,
pandas Series, or numpy array as output).
Compute predictions on input data using the specified deployment.
Note that the input/output types of this method matches that of `mlflow pyfunc predict`.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Note that the input/output types of this method matches that of `mlflow pyfunc predict`.
Note that the input/output types of this method match those of `mlflow pyfunc predict`.

Copy link
Copy Markdown
Collaborator

@dbczumar dbczumar left a comment

Choose a reason for hiding this comment

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

LGTM with two nitty docs comments. Thanks @BenWilson2 !

@BenWilson2 BenWilson2 merged commit 7c2a4bd into branch-2.0 Sep 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/scoring MLflow Model server, model deployment tools, Spark UDFs rn/breaking-change Mention under Breaking Changes in Changelogs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants