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

Show images in the metric tab #15034

Merged
merged 2 commits into from
Mar 24, 2025
Merged

Conversation

TomeHirata
Copy link
Collaborator

@TomeHirata TomeHirata commented Mar 18, 2025

Related Issues/PRs

Resolve #15013

What changes are proposed in this pull request?

There is an issue that images are not displayed correctly on the run metrics tab. This is caused by incorrectly decoding the file name that uses "%" as the separator. The full resolution needs replacing the separator, but this PR fixes the immediate issue.

image

How is this PR tested?

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

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.

Show images in the run metrics tab.

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

Should this PR be included in the next patch release?

Yes should be selected for bug fixes, documentation updates, and other small changes. No should be selected for new features and larger changes. If you're unsure about the release classification of this PR, leave this unchecked to let the maintainers decide.

What is a minor/patch release?
  • Minor release: a release that increments the second part of the version number (e.g., 1.2.0 -> 1.3.0).
    Bug fixes, doc updates and new features usually go into minor releases.
  • Patch release: a release that increments the third part of the version number (e.g., 1.2.0 -> 1.2.1).
    Bug fixes and doc updates usually go into patch releases.
  • Yes (this PR will be cherry-picked and included in the next patch release)
  • No (this PR will be included in the next minor release)

Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
@TomeHirata TomeHirata requested review from Copilot and daniellok-db and removed request for Copilot March 18, 2025 13:05
@github-actions github-actions bot added rn/bug-fix Mention under Bug Fixes in Changelogs. v2.21.1 labels Mar 18, 2025
Copy link

github-actions bot commented Mar 18, 2025

Documentation preview for 930ff1a will be available when this CircleCI job
completes successfully. You may encounter a {"message":"not found"} error when reloading
a page. If so, add /index.html to the URL.

More info

@TomeHirata TomeHirata requested a review from B-Step62 March 18, 2025 13:07
// The variables retrieved here are not reliable on OSS due to the usage of "%" as the separator.
// Need to switch to a different separator on the backend to fully resolve the issue.
const [serializedImageKey, stepLabel, stepString, timestampLabel, timestampString, ..._] = fileKey.split(delimiter);
const isCompressed = fileKey.includes('compressed');
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there any additional rule to limit the false positive here? E.g. what if the original users' image name is pic_compressed.png. Maybe we can limit the match target here to the ..._ part not the entire fileKey?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Images logged through log_image(artifact_path="...") is not relevant to this change as this logic is for images with key and step. To handle the case where "key" includes "compressed" keyword, I changed "includes" to "endWith"

Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
Copy link
Collaborator

@B-Step62 B-Step62 left a comment

Choose a reason for hiding this comment

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

LGTM!

@TomeHirata TomeHirata added this pull request to the merge queue Mar 24, 2025
Merged via the queue into mlflow:master with commit f47037b Mar 24, 2025
47 checks passed
@TomeHirata TomeHirata deleted the fix/image-metric branch March 24, 2025 10:43
BenWilson2 pushed a commit to BenWilson2/mlflow that referenced this pull request Mar 25, 2025
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
BenWilson2 pushed a commit that referenced this pull request Mar 25, 2025
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rn/bug-fix Mention under Bug Fixes in Changelogs. v2.21.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Images are not displayed in Experiment model metric tab
2 participants