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

Simplify Metadata handling #3096

Merged
merged 38 commits into from
Nov 7, 2024
Merged

Simplify Metadata handling #3096

merged 38 commits into from
Nov 7, 2024

Conversation

AlexejPenner
Copy link
Contributor

@AlexejPenner AlexejPenner commented Oct 17, 2024

Describe changes

The fact that run metadata is stored in a separate table with a row per key-value pair is business logic. I don't see the benefit of exposing this to the user/client. As a user when I run model_version.run_metadata i expect to get a simple
metadata dictionary, instead I get a fulminant RunMetadataResponseBody.

On top of that, the run_metadata lead to bloating of the api response sizes.

Example response body:
response_1729171061701.json

Time to list 100 hydrated model versions with the state on develop:

image

Time to list 100 hydrated model versions after this change:

image

Breaking Change

All code that accesses run_metadata now needs to be changed:

metadata_value = current_model_version.run_metadata["key"].value

-->

metadata_value = current_model_version.run_metadata["key"]

Metadata is now a familiar python dictionary.

Pre-requisites

Please ensure you have done the following:

  • I have read the CONTRIBUTING.md document.
  • If my change requires a change to docs, I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
  • If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (add details above)

@github-actions github-actions bot added internal To filter out internal PRs and issues enhancement New feature or request labels Oct 17, 2024
@AlexejPenner AlexejPenner changed the title Initial commit, nuking all metadata responses and seeing what breaks Simplify Metadata handling Oct 18, 2024
AlexejPenner added a commit to zenml-io/template-starter that referenced this pull request Oct 21, 2024
Copy link
Contributor

Classification template updates in examples/mlops_starter have been pushed.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

AlexejPenner added a commit to zenml-io/template-e2e-batch that referenced this pull request Oct 21, 2024
AlexejPenner added a commit to zenml-io/template-nlp that referenced this pull request Oct 21, 2024
Copy link
Contributor

@schustmi schustmi left a comment

Choose a reason for hiding this comment

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

A more general comment: Do you think it makes sense to remove these run_metadata attributes on all the responses to just metadata? Especially run.run_metadata seems very weird, and now that we're already breaking this by changing the type, might be a good opportunity to take a look at the names as well?

src/zenml/cli/model.py Outdated Show resolved Hide resolved
src/zenml/models/v2/core/model_version.py Outdated Show resolved Hide resolved
src/zenml/zen_stores/schemas/run_metadata_schemas.py Outdated Show resolved Hide resolved
Copy link
Contributor

coderabbitai bot commented Oct 28, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@bcdurak bcdurak requested a review from schustmi October 29, 2024 11:41
@AlexejPenner
Copy link
Contributor Author

🦭

@bcdurak bcdurak merged commit 11503e4 into develop Nov 7, 2024
70 of 71 checks passed
@bcdurak bcdurak deleted the feature/better-metadata branch November 7, 2024 08:14
bcdurak pushed a commit to zenml-io/template-starter that referenced this pull request Nov 7, 2024
bcdurak pushed a commit to zenml-io/template-e2e-batch that referenced this pull request Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change enhancement New feature or request internal To filter out internal PRs and issues requires-frontend-changes run-slow-ci
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants