Skip to content

Implement model evaluation API (part 1)#5069

Merged
WeichenXu123 merged 61 commits into
mlflow:masterfrom
WeichenXu123:eval_api
Dec 7, 2021
Merged

Implement model evaluation API (part 1)#5069
WeichenXu123 merged 61 commits into
mlflow:masterfrom
WeichenXu123:eval_api

Conversation

@WeichenXu123

@WeichenXu123 WeichenXu123 commented Nov 15, 2021

Copy link
Copy Markdown
Collaborator

What changes are proposed in this pull request?

Implement basic APIs:
class EvaluationDataset/EvaluationResult/EvaluationMetrics/EvaluationArtifact, evaluate API, class ModelEvaluator (base evaluator class) and plugin interface

How is this patch tested?

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.

(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/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: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Comment thread mlflow/evaluation.py Outdated
Comment thread mlflow/evaluation.py Outdated
@WeichenXu123 WeichenXu123 changed the title [WIP][ML-18754] Implement model evaluation API (part 1) [ML-18754] Implement model evaluation API (part 1) Nov 16, 2021
@WeichenXu123

Copy link
Copy Markdown
Collaborator Author

I will add more tests, but the PR is ready for first pass review.

@github-actions github-actions Bot added area/tracking Tracking service, tracking client APIs, autologging rn/feature Mention under Features in Changelogs. labels Nov 16, 2021
Comment thread mlflow/evaluation.py Outdated
Comment thread mlflow/evaluation.py Outdated
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Comment thread mlflow/evaluation.py Outdated
Comment thread mlflow/evaluation.py Outdated
Comment thread mlflow/evaluation.py Outdated
Comment thread mlflow/evaluation.py Outdated
Comment thread mlflow/evaluation.py Outdated
Comment thread mlflow/evaluation.py Outdated
Comment thread mlflow/evaluation.py Outdated
Comment thread mlflow/evaluation.py Outdated
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
@WeichenXu123 WeichenXu123 changed the title [ML-18754] Implement model evaluation API (part 1) Implement model evaluation API (part 1) Nov 20, 2021
Comment thread mlflow/models/evaluation/base.py Outdated
Comment thread mlflow/models/evaluation/base.py Outdated
Comment thread mlflow/models/evaluation/base.py Outdated
Comment thread mlflow/models/evaluation/base.py Outdated
Comment thread mlflow/models/evaluation/base.py
Comment thread mlflow/models/evaluation/base.py
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Comment thread mlflow/models/evaluation/base.py Outdated
Comment thread mlflow/models/__init__.py
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>

@dbczumar dbczumar left a comment

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.

@WeichenXu123 LGTM once remaining comments are addressed. Can we also address https://github.com/mlflow/mlflow/pull/5069/files#r760773789? This is excellent work! I tried it out manually with the test plugin, and it behaves as expected.

Comment thread mlflow/models/evaluation/base.py Outdated
Comment thread mlflow/models/__init__.py
Comment thread mlflow/models/evaluation/base.py Outdated
Comment thread mlflow/models/evaluation/base.py Outdated
Comment thread mlflow/models/evaluation/base.py Outdated
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>

@harupy harupy left a comment

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.

LGTM!

@WeichenXu123 WeichenXu123 merged commit c630d6d into mlflow:master Dec 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/tracking Tracking service, tracking client APIs, autologging rn/feature Mention under Features in Changelogs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants