Skip to content
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

Validate metric key length in _validate_metric #11209

Merged
merged 1 commit into from Feb 21, 2024

Conversation

harupy
Copy link
Member

@harupy harupy commented Feb 21, 2024

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

_validate_metric doesn't validate the metric key length. It should because log_metrics does.

import mlflow

mlflow.set_tracking_uri("sqlite:///:memory:")

try:
    mlflow.log_metric("m" * 1000, 0)  # should throw, but doesn't on master, does on this PR
except Exception as e:
    print(e)
else:
    assert False, "Expected an exception"

try:
    mlflow.log_metrics({"m" * 1000: 0})  # throws
except Exception as e:
    print(e)
else:
    assert False, "Expected an exception"

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/deployments: MLflow Deployments client APIs, server, and third-party Deployments integrations
  • 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/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

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
Copy link

Documentation preview for f7683ba will be available when this CircleCI job
completes successfully.

More info

@github-actions github-actions bot added the rn/none List under Small Changes in Changelogs. label Feb 21, 2024
Comment on lines -318 to -323
# TODO: move _validate_length_limit calls into _validate_metric etc. This would be a
# breaking change as _validate_metric is also used in the single-entry log_metric API. Thus
# we defer it for now to allow for a release of the batched logging APIs without breaking
# changes to other APIs. See related discussion in
# https://github.com/mlflow/mlflow/issues/985
_validate_length_limit("Metric name", MAX_ENTITY_KEY_LENGTH, metric.key)
Copy link
Member Author

Choose a reason for hiding this comment

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

This comment was added 5 years ago.

@@ -163,6 +163,8 @@ def _validate_metric(key, value, timestamp, step):
INVALID_PARAMETER_VALUE,
)

_validate_length_limit("Metric name", MAX_ENTITY_KEY_LENGTH, key)
Copy link
Member Author

@harupy harupy Feb 21, 2024

Choose a reason for hiding this comment

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

This would break code that logs metrics with key exceeding MAX_ENTITY_KEY_LENGTH (250) characters.

Copy link
Collaborator

@WeichenXu123 WeichenXu123 left a comment

Choose a reason for hiding this comment

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

LGTM, good fix!

@harupy harupy merged commit 81f813f into mlflow:master Feb 21, 2024
52 checks passed
@harupy harupy deleted the fix-validate-metric branch February 21, 2024 11:56
artjen pushed a commit to artjen/mlflow that referenced this pull request Mar 26, 2024
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
Signed-off-by: Arthur Jenoudet <arthur.jenoudet@databricks.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rn/none List under Small Changes in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants