-
Notifications
You must be signed in to change notification settings - Fork 4k
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
[Custom Metrics] Enabled support for logging of numerical metrics #5389
[Custom Metrics] Enabled support for logging of numerical metrics #5389
Conversation
Signed-off-by: Mark Zhang <mark.zhang@databricks.com>
Hey @apurvakoti @dbczumar @jinzhang21 @WeichenXu123, can you all take a look? It seems like I don't have permission to add reviewers. So I'm tagging you all here. Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added some initial comment on the API. I'll review the rest later today.
Signed-off-by: Mark Zhang <mark.zhang@databricks.com>
Signed-off-by: Mark Zhang <mark.zhang@databricks.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some small comments, will do a full review again
Signed-off-by: Mark Zhang <mark.zhang@databricks.com>
Signed-off-by: Mark Zhang <mark.zhang@databricks.com>
…. Since DefaultEvaluator saves Dataframe as CSV. And CSV files can also be viewed in the MLflow UI Signed-off-by: Mark Zhang <mark.zhang@databricks.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Let's use []
as the default argument for custom_metrics
rather than None
.
Thanks! I think we should avoid using mutable default argument in python due to issues described here. Although, I could initialize it to a list inside the constructor, but considering other default arguments like mlflow/mlflow/models/evaluation/base.py Line 655 in 2c0d13d
are not initialized, I think it might be good idea just to leave it as is. |
Ah good catch @MarkYHZhang ! Let's keep it |
Signed-off-by: Mark Zhang <mark.zhang@databricks.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM once all comments addressed!
Signed-off-by: Mark Zhang <mark.zhang@databricks.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@MarkYHZhang This looks great! Left a few small comments - should be ready to merge soon!
…ate_custom_metric function. Modified docstring to only include metrics support Signed-off-by: Mark Zhang <markzhang.inbox@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@MarkYHZhang Do we plan to add an example to the examples
section or extend one of the existing examples? Can we do that as part of this PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM when small docs nits have been addressed and example has been included. Thanks @MarkYHZhang ! Awesome stuff!
…urn validation. Plus a few minor stylistic changes Signed-off-by: Mark Zhang <markzhang.inbox@gmail.com>
…builtin_metrics per custom metric function Signed-off-by: Mark Zhang <markzhang.inbox@gmail.com>
Signed-off-by: Mark Zhang mark.zhang@databricks.com
What changes are proposed in this pull request?
Added support for users to pass in custom metric functions into mlflow.evaluate. This PR is a part of more PRs to come for custom metrics support. Specifically, this PR focuses on enabling logging of numerical metrics generated by user's custom metric functions into MLflow.
How is this patch tested?
Wrote unit tests located in mlflow/tests/models/test_default_evaluator.py
Does this PR change the documentation?
Updates to the documentation will be done once the entire feature of custom metrics is complete.
ci/circleci: build_doc
check. If it's successful, proceed to thenext step, otherwise fix it.
Details
on the right to open the job page of CircleCI.Artifacts
tab.docs/build/html/index.html
.Release Notes
Is this a user-facing change?
Enables MLflow tracking of custom metrics produced by user-provided metric functions.
(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 loggingarea/build
: Build and test infrastructure for MLflowarea/docs
: MLflow documentation pagesarea/examples
: Example codearea/model-registry
: Model Registry service, APIs, and the fluent client calls for Model Registryarea/models
: MLmodel format, model serialization/deserialization, flavorsarea/projects
: MLproject format, project running backendsarea/scoring
: MLflow Model server, model deployment tools, Spark UDFsarea/server-infra
: MLflow Tracking server backendarea/tracking
: Tracking Service, tracking client APIs, autologgingInterface
area/uiux
: Front-end, user experience, plotting, JavaScript, JavaScript dev serverarea/docker
: Docker use across MLflow's components, such as MLflow Projects and MLflow Modelsarea/sqlalchemy
: Use of SQLAlchemy in the Tracking Service or Model Registryarea/windows
: Windows supportLanguage
language/r
: R APIs and clientslanguage/java
: Java APIs and clientslanguage/new
: Proposals for new client languagesIntegrations
integrations/azure
: Azure and Azure ML integrationsintegrations/sagemaker
: SageMaker integrationsintegrations/databricks
: Databricks integrationsHow should the PR be classified in the release notes? Choose one:
rn/breaking-change
- The PR will be mentioned in the "Breaking Changes" sectionrn/none
- No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" sectionrn/feature
- A new user-facing feature worth mentioning in the release notesrn/bug-fix
- A user-facing bug fix worth mentioning in the release notesrn/documentation
- A user-facing documentation change worth mentioning in the release notes