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

Extend notebook source replacement code to other objects apart from ZenML steps #2919

Merged
merged 7 commits into from
Aug 28, 2024
Merged

Extend notebook source replacement code to other objects apart from ZenML steps #2919

merged 7 commits into from
Aug 28, 2024

Conversation

schustmi
Copy link
Contributor

@schustmi schustmi commented Aug 8, 2024

Describe changes

Extend notebook source replacement code to other objects apart from ZenML steps.

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)

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 8, 2024 •
edited
Loading

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

@github-actions github-actions bot added the internal To filter out internal PRs and issues label Aug 8, 2024
@schustmi schustmi changed the title WIP: Rework notebook code upload Extend notebook source replacement code to other objects apart from ZenML steps. Aug 8, 2024
@github-actions github-actions bot added the enhancement New feature or request label Aug 8, 2024
@schustmi schustmi force-pushed the feature/improve-notebook-source-resolving branch from 65d4d8d to 6cc2495 Compare August 8, 2024 09:16
@schustmi schustmi changed the title Extend notebook source replacement code to other objects apart from ZenML steps. Extend notebook source replacement code to other objects apart from ZenML steps Aug 8, 2024
@schustmi schustmi requested a review from bcdurak August 22, 2024 12:21
@schustmi schustmi marked this pull request as ready for review August 22, 2024 12:28
bcdurak
bcdurak reviewed Aug 27, 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.

I added some minor comments.

One small feedback regarding the workflow over notebooks in general: As I was going through the PR, at some point, I went to our docs because I thought it would be a nice idea to add some links to some of the error messages to make the issue clearer. However, I think the docs are lacking some examples and some tutorials on what is possible and what is impossible.

src/zenml/utils/source_utils.py
from zenml.utils import code_utils

artifact_store = Client().active_stack.artifact_store

if (
Copy link
Contributor

Choose a reason for hiding this comment

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

If the notebook cell content is stored in a different artifact store than the active one we are failing here. Similar to what we did with the pipeline artifacts, could we not try to initialize this other artifact store and use it to load it?

Copy link
Contributor

Choose a reason for hiding this comment

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

+1, seems like the old bug we had

Copy link
Contributor

Choose a reason for hiding this comment

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

I would use active only in case source.artifact_store_id is None, otherwise will work with that one. Is this what you meant @bcdurak or something else?

src/zenml/utils/source_utils.py
except FileNotFoundError:
if not source.artifact_store_id:
raise FileNotFoundError(
"Unable to find notebook code file. This might be because "
Copy link
Contributor

Choose a reason for hiding this comment

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

With the error message above, this one is now a bit misleading as it will fail if the file is stored in a different artifact store.

src/zenml/utils/source_utils.py Outdated Show resolved Hide resolved
src/zenml/utils/source_utils.py Show resolved Hide resolved
@schustmi schustmi merged commit 21301c8 into develop Aug 28, 2024
69 of 71 checks passed
@schustmi schustmi deleted the feature/improve-notebook-source-resolving branch August 28, 2024 08:10
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

@avishniakov avishniakov avishniakov approved these changes

Assignees
No one assigned
Labels
enhancement New feature or request internal To filter out internal PRs and issues run-slow-ci
Projects
None yet
Milestone
No milestone
Development

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