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

Scalability improvements: Reduce misc/hydration server requests #3093

Merged
merged 19 commits into from
Oct 29, 2024
Merged

Scalability improvements: Reduce misc/hydration server requests #3093

merged 19 commits into from
Oct 29, 2024

Conversation

schustmi
Copy link
Contributor

@schustmi schustmi commented Oct 17, 2024 •
edited
Loading

Describe changes

This PR contains some improvements that reduce the amount of server requests that we send when running a step

  • All SQLZenStore methods now correctly include the resources of a model
  • The active workspace is only fetched once
  • The active stack model is only fetched once
  • Hydrating a response model now sets both the resources and metadata, which before would require two separate requests
  • When trying to fetch the model version for a step: Instead of sending one hydration request per already executed step of the pipeline run, we now send a single request instead
  • Only register a new active filesystem if it doesn't match the active artifact store
  • Add flavor to ComponentResponseResources

Breaking changes (still requires frontend changes):

  • Move ArtifactVersionResponse.artifact_store_id from metadata to body
  • Move FlavorResponse.source from metadata to body
  • Rename ComponentResponse.flavor to ComponentResponse.flavor_name

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
@schustmi schustmi changed the title Scalability improvements Scalability improvements 1 Oct 17, 2024
@schustmi schustmi changed the title Scalability improvements 1 Scalability improvements: Misc Oct 17, 2024
@schustmi schustmi requested a review from bcdurak October 17, 2024 12:38
@schustmi schustmi marked this pull request as ready for review October 17, 2024 12:38
@schustmi schustmi changed the title Scalability improvements: Misc Scalability improvements: Reduce misc/hydration server requests Oct 17, 2024
bcdurak
bcdurak requested changes Oct 25, 2024
View reviewed changes
Copy link
Contributor

@bcdurak bcdurak left a comment

Choose a reason for hiding this comment

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

A huge fan of the Clean Up PRs series by @schustmi ❤️

src/zenml/models/v2/core/component.py Show resolved Hide resolved
src/zenml/models/v2/core/component.py Outdated Show resolved Hide resolved
src/zenml/models/v2/core/component.py Show resolved Hide resolved
src/zenml/models/v2/core/step_run.py Show resolved Hide resolved
src/zenml/cli/stack_components.py Show resolved Hide resolved
src/zenml/cli/stack_components.py Show resolved Hide resolved
src/zenml/client.py Show resolved Hide resolved
@coderabbitai coderabbitai
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.

@schustmi schustmi requested a review from bcdurak October 28, 2024 10:28
bcdurak
bcdurak approved these changes Oct 29, 2024
View reviewed changes
src/zenml/analytics/utils.py Show resolved Hide resolved
@schustmi schustmi merged commit ab53d9c into develop Oct 29, 2024
68 of 69 checks passed
@schustmi schustmi deleted the feature/scalability-improvements branch October 29, 2024 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bcdurak bcdurak bcdurak approved these changes

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@schustmi @bcdurak