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

Update notebook and fix pyyaml-include dependency issue #16

Merged
merged 4 commits into from
Apr 5, 2024
Merged

Conversation

strickvl
Copy link
Contributor

@strickvl strickvl commented Apr 3, 2024

Made the zenml cloud use stand out a bit more

Summary by CodeRabbit

  • New Features
    • Integrated pyyaml-include<2.0 for improved YAML processing.
  • Documentation
    • Enhanced the Quickstart guide with detailed instructions on:
      • Connecting to ZenML Cloud
      • Data loading and feature engineering
      • Setting up training pipelines
      • Associating models with pipelines
      • Consuming models in production

@strickvl strickvl added enhancement New feature or request internal labels Apr 3, 2024
@strickvl strickvl requested a review from htahir1 April 3, 2024 11:29
Copy link

coderabbitai bot commented Apr 3, 2024

Walkthrough

The recent update brings notable changes aimed at enhancing YAML processing capabilities with the addition of pyyaml-include<2.0 in the requirements.txt file. Moreover, the Jupyter notebook template has undergone significant revisions to streamline interactions with ZenML Cloud, improve data handling, feature engineering, and model training processes, along with guidance on model deployment for production use.

Changes

File(s) Change Summary
requirements.txt Added pyyaml-include<2.0 to the requirements.txt file.
template/.../quickstart.ipynb Semantic changes related to connecting to ZenML Cloud, data loading, feature engineering, training pipeline, associating models with pipelines, and deploying models in production.

🐰✨
In the realm of code, where changes abound,
A rabbit hopped in, with new dependencies found.
"To the cloud!" it cheered, with a leap and a bound,
Making pipelines and models, profoundly sound.
🚀 Deploy with ease, let your data astound!
🌟🐾

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.

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.
  • Please see the configuration documentation for more information.
  • 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

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.

@strickvl strickvl changed the title Update notebook Update notebook and fix pyyaml-include dependency issue Apr 5, 2024
@strickvl strickvl requested review from bcdurak and removed request for avishniakov April 5, 2024 11:52
Copy link

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

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 30398e6 and f3811d6.
Files selected for processing (2)
  • requirements.txt (1 hunks)
  • template/quickstart.ipynb (5 hunks)
Files skipped from review as they are similar to previous changes (1)
  • template/quickstart.ipynb
Additional comments not posted (1)
requirements.txt (1)

6-6: Ensure compatibility of pyyaml-include<2.0 with other project dependencies and future upgrade plans.

Copy link

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

Actionable comments posted: 4

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between f3811d6 and cda64e9.
Files selected for processing (1)
  • .github/actions/starter_template_test/action.yml (1 hunks)
Additional comments not posted (6)
.github/actions/starter_template_test/action.yml (6)

39-43: Ensure the Git configuration commands are executed correctly in non-Windows environments.


46-50: Ensure the Git configuration commands are executed correctly in Windows environments.


72-73: Ensure the concatenation of requirements files is done correctly to manage dependencies efficiently.


33-36: Ensure the Python setup step is configured correctly with the specified Python version.


26-30: Ensure the checkout step is configured correctly with the specified repository and reference.


80-85: Ensure the pytest command is executed correctly to run the tests, with the ZENML_STACK_NAME environment variable set appropriately.

- name: Install wheel
shell: bash
run: |
pip install wheel uv
Copy link

Choose a reason for hiding this comment

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

Replace uv with python -m before pip commands to ensure correct syntax and standard practice.

-      pip install wheel uv
+      python -m pip install wheel

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
pip install wheel uv
python -m pip install wheel

if: ${{ inputs.ref-zenml != '' }}
shell: bash
run: |
uv pip install --system "git+https://github.com/zenml-io/zenml.git@${{ inputs.ref-zenml }}" "zenml[server]@git+https://github.com/zenml-io/zenml.git@${{ inputs.ref-zenml }}"
Copy link

Choose a reason for hiding this comment

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

Correct the use of uv before pip commands and remove the redundant --system flag.

-      uv pip install --system "git+https://github.com/zenml-io/zenml.git@${{ inputs.ref-zenml }}" "zenml[server]@git+https://github.com/zenml-io/zenml.git@${{ inputs.ref-zenml }}"
+      python -m pip install "git+https://github.com/zenml-io/zenml.git@${{ inputs.ref-zenml }}" "zenml[server]@git+https://github.com/zenml-io/zenml.git@${{ inputs.ref-zenml }}"

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
uv pip install --system "git+https://github.com/zenml-io/zenml.git@${{ inputs.ref-zenml }}" "zenml[server]@git+https://github.com/zenml-io/zenml.git@${{ inputs.ref-zenml }}"
python -m pip install "git+https://github.com/zenml-io/zenml.git@${{ inputs.ref-zenml }}" "zenml[server]@git+https://github.com/zenml-io/zenml.git@${{ inputs.ref-zenml }}"

if: ${{ inputs.ref-zenml == '' }}
shell: bash
run: |
uv pip install --system zenml "zenml[server]"
Copy link

Choose a reason for hiding this comment

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

Correct the use of uv before pip commands and remove the redundant --system flag.

-      uv pip install --system zenml "zenml[server]"
+      python -m pip install zenml "zenml[server]"

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
uv pip install --system zenml "zenml[server]"
python -m pip install zenml "zenml[server]"

- name: Install requirements
shell: bash
run: |
uv pip install --system -r ./local_checkout/all-requirements.txt
Copy link

Choose a reason for hiding this comment

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

Correct the use of uv before pip commands and remove the redundant --system flag.

-      uv pip install --system -r ./local_checkout/all-requirements.txt
+      python -m pip install -r ./local_checkout/all-requirements.txt

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
uv pip install --system -r ./local_checkout/all-requirements.txt
python -m pip install -r ./local_checkout/all-requirements.txt

@strickvl strickvl merged commit 3eee18c into main Apr 5, 2024
13 checks passed
@strickvl strickvl deleted the 2024.04.03 branch April 5, 2024 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request internal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants