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.

Sign up for GitHub

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

Jump to bottom

Allow visualizing and comparing nested params #13012

Merged
merged 7 commits into from
Oct 3, 2024
Merged

Allow visualizing and comparing nested params #13012

merged 7 commits into from
Oct 3, 2024

Conversation

jescalada
Copy link
Contributor

@jescalada jescalada commented Aug 26, 2024 •
edited
Loading

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

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

Checkout with GitHub CLI

gh pr checkout 13012

Related Issues/PRs

Resolve #2838

What changes are proposed in this pull request?

In this PR, I added support for nested params (which would be logged directly as Python dictionaries). These are converted into JSON and then spread out in nested tables.

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.

Added support for visualizing nested params (when logging Python dictionaries directly for model configuration, etc.).

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)

@github-actions GitHub Actions
Copy link

@jescalada 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.

@github-actions GitHub Actions
Copy link

github-actions bot commented Aug 26, 2024 •
edited
Loading

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

More info

@github-actions github-actions bot added area/uiux Front-end, user experience, plotting, JavaScript, JavaScript dev server rn/feature Mention under Features in Changelogs. labels Aug 26, 2024
@jescalada jescalada mentioned this pull request Aug 26, 2024
Closed
2 tasks
@jescalada jescalada mentioned this pull request Sep 13, 2024
Closed
23 tasks
@jescalada
Copy link
Contributor Author

Pinging @daniellok-db for visibility... Thank you! :)

@daniellok-db
Copy link
Collaborator

Oops, i must have missed this one, sorry! I'll get to reviewing soon

daniellok-db
daniellok-db reviewed Sep 27, 2024
View reviewed changes
Copy link
Collaborator

@daniellok-db daniellok-db left a comment

Choose a reason for hiding this comment

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

i agree with having a solution for visualizing nested dicts, but i wonder if it might be confusing for users to see a table. i wonder if it's more conventional to just have pretty-printed JSON instead.

cc @hubertzub-db any thoughts?

@jescalada
Copy link
Contributor Author

jescalada commented Oct 2, 2024 •
edited
Loading

@daniellok-db I implemented the pretty-printed version and it honestly looks better than the tabular format (not to mention that the code is a lot more readable)!

Right now, the Python dict parser is at the bottom, but once the refactoring changes are merged I can just move the function into the component (rather than calling this.parsePythonDictString).

image

daniellok-db
daniellok-db approved these changes Oct 3, 2024
View reviewed changes
Copy link
Collaborator

@daniellok-db daniellok-db left a comment

Choose a reason for hiding this comment

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

lgtm!

@daniellok-db
Copy link
Collaborator

/rr

@daniellok-db
Copy link
Collaborator

merging as the test failure is unrelated

@daniellok-db daniellok-db merged commit 63ca2de into mlflow:master Oct 3, 2024
45 of 47 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@daniellok-db daniellok-db daniellok-db approved these changes

Assignees
No one assigned
Labels
area/uiux Front-end, user experience, plotting, JavaScript, JavaScript dev server patch-2.15.2 patch-2.16.3 patch-2.17.0 rn/feature Mention under Features in Changelogs.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[FR] Better visualization of nested params
2 participants
@jescalada @daniellok-db