Refactor metrics_definitions.py

[bbqiu]

🛠 DevTools 🛠

Install mlflow from this PR

pip install git+https://github.com/mlflow/mlflow.git@refs/pull/10059/merge

Checkout with GitHub CLI

gh pr checkout 10059

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

• refactor metric_definitions.py slightly
• fix this jira issue as well
• the new logging messages looks like this:

2023/10/25 19:04:56 WARNING mlflow.metrics.metric_definitions: Cannot calculate rougeL for non-string inputs. Non-string found for the column specified by the `predictions` parameter or the model output column on row 0. Skipping metric logging.

2023/10/25 19:07:43 WARNING mlflow.metrics.metric_definitions: Cannot calculate rougeL for non-string inputs. Non-string found for the column specified by the `targets` parameter on row 0. Skipping metric logging.

link to notebook used for testing

How is this PR tested?

• Existing unit/integration tests
• New unit/integration tests
• Manual tests

Does this PR require documentation update?

• No. You can skip the rest of this section.
• Yes. I've updated:
  • Examples
  • API references
  • Instructions

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.

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/gateway: AI Gateway service, Gateway client APIs, third-party Gateway integrations
• area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
• area/models: MLmodel format, model serialization/deserialization, flavors
• area/recipes: Recipes, Recipe APIs, Recipe configs, Recipe 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/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/breaking-change - The PR will be mentioned in the "Breaking Changes" 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

[github-actions]

Documentation preview for 7de1c0e will be available here when this CircleCI job completes successfully.

More info

• Ignore this comment if this PR does not change the documentation.
• It takes a few minutes for the preview to be available.
• The preview is updated when a new commit is pushed to this PR.
• This comment was created by https://github.com/mlflow/mlflow/actions/runs/6646547010.

[github-actions]

@bbqiu Thank you for the contribution! Could you fix the following issue(s)?

⚠ DCO check

The DCO check failed. Please sign off your commit(s) by following the instructions here. See https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md#sign-your-work for more details.

[jessechancy]

LGTM

Just one small thing, this change would mean if predictions is None it would return None. Let's just make sure that's the desired behaviour.

[bbqiu]

Just one small thing, this change would mean if predictions is None it would return None. Let's just make sure that's the desired behaviour.

If we're going through the evaluate API, predictions will never be None.

In the niche case that they're using this metric directly as a function, it is possible to pass predictions in as None, which results in the following behavior:

• before: we will error out if predictions is None
• after: we will return None and log an error message

Is this okay with everyone?

cc @sunishsheth2009 @annzhang-db @prithvikannan