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

Fix to file path for notebook quickstart #2288

Merged

Conversation

jacksandom
Copy link
Contributor

@jacksandom jacksandom commented Jan 15, 2024

Describe changes

When running zenml go for the guided quickstart as instructed in Readme, I get following:

FileNotFoundError: [Errno 2] No such file or directory: '~/.../zenml_tutorial/notebooks'

notebooks path does not get created in files download so I have removed from Jupyter notebook call.

Link to issue: #2289

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)

Summary by CodeRabbit

  • Refactor
    • Streamlined the process for launching Jupyter notebooks within the app.

Copy link
Contributor

coderabbitai bot commented Jan 15, 2024

Walkthrough

Walkthrough

The update to the go function in the ZenML CLI streamlines the process of launching Jupyter notebooks. It does this by eliminating an intermediate step that involved the creation of a notebook_path. Now, the function directly opens the Jupyter notebook within the zenml_tutorial_path directory, simplifying the code and potentially reducing the risk of path-related errors.

Changes

File Path Change Summary
src/zenml/cli/base.py Removed creation of notebook_path and modified the Jupyter notebook launch command to use zenml_tutorial_path directly.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@jacksandom jacksandom force-pushed the bugfix/quickstart-notebook-wrong-path branch from 44e6215 to d24d486 Compare January 15, 2024 16:39
@jacksandom
Copy link
Contributor Author

@coderabbitai review

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 21543ef and d24d486.
Files selected for processing (1)
  • src/zenml/cli/base.py (1 hunks)
Additional comments: 1
src/zenml/cli/base.py (1)
  • 473-473: The change to call Jupyter notebook directly with zenml_tutorial_path seems correct. However, we should verify that zenml_tutorial_path is properly defined and that the removal of notebook_path does not impact other parts of the code.
Verification successful

The corrected rg command did not produce any output, which indicates that the string notebook_path does not appear elsewhere in the .py files of the codebase. This suggests that the removal of notebook_path from the go function in src/zenml/cli/base.py likely does not impact other parts of the code.

Given this information, the change to use zenml_tutorial_path directly in the subprocess.check_call within the go function is verified and does not seem to affect other areas of the codebase.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Verify that zenml_tutorial_path is defined and used correctly
ast-grep --lang python --pattern $'zenml_tutorial_path = $_'
# Ensure notebook_path is not used elsewhere in the codebase
rg --type python 'notebook_path'

Length of output: 227



Script:

#!/bin/bash
# Correcting the file type and searching for 'notebook_path' in .py files
rg --type py 'notebook_path'

Length of output: 28

@safoinme safoinme self-requested a review January 15, 2024 18:46
Copy link
Contributor

@safoinme safoinme left a comment

Choose a reason for hiding this comment

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

Thank you for opening this PR, looks good one minor comment
zenml_tutorial_path should probably be defined outside of the with statement

@strickvl strickvl added the bug Something isn't working label Jan 15, 2024
@safoinme safoinme merged commit 835c862 into zenml-io:develop Jan 15, 2024
16 of 23 checks passed
@jacksandom jacksandom deleted the bugfix/quickstart-notebook-wrong-path branch January 15, 2024 21:18
kabinja pushed a commit to kabinja/zenml that referenced this pull request Jan 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants