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

A docs update for incorrect import in docs/book/user-guide/starter-guide/track-ml-models.md #2279

Merged
merged 3 commits into from
Jan 13, 2024

Conversation

yo-harsh
Copy link
Contributor

@yo-harsh yo-harsh commented Jan 13, 2024

Describe changes

I implemented/fixed docs for zenml for incorrect import which is leading to error.

from zenml.model import ModelVersion
"TypeError: object is not callable,"

fixed it with just-
from zenml import ModelVersion

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 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)
  • Documentation (add details above)

Summary by CodeRabbit

  • Documentation
    • Updated the import statement in the user guide for tracking ML models.

Copy link
Contributor

coderabbitai bot commented Jan 13, 2024

Walkthrough

Walkthrough

The change involves updating the documentation to fix an incorrect import statement in the ZenML guide for tracking machine learning models. The update is straightforward, correcting the source of ModelVersion to ensure users import it correctly in their code. This minor yet crucial fix aligns the documentation with the correct usage of the library.

Changes

File Path Change Summary
docs/.../track-ml-models.md Updated the import statement for ModelVersion and made a minor edit to an HTML comment.

Related issues

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.

@CLAassistant
Copy link

CLAassistant commented Jan 13, 2024

CLA assistant check
All committers have signed the CLA.

@yo-harsh
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 5420095 and 28dd94f.
Files selected for processing (1)
  • docs/book/user-guide/starter-guide/track-ml-models.md (2 hunks)
Additional comments: 2
docs/book/user-guide/starter-guide/track-ml-models.md (2)
  • 45-45: The import statement has been corrected from from zenml.model import ModelVersion to from zenml import ModelVersion. This change should resolve the TypeError that was occurring due to the incorrect import path. Ensure that this new import path is consistent with the ZenML package structure.

  • 271-271: There is a mention of a minor change in an HTML comment, but it's not visible in the provided code snippet. If the change is within the provided lines, please ensure that the HTML comment is appropriate and does not contain any sensitive information or broken links.

Verification successful

The output from the shell script indicates that there is an HTML comment <!-- For scarf --> within the track-ml-models.md file. This suggests that the minor change in an HTML comment mentioned in the AI-generated summary likely pertains to this comment.

Based on the provided information, it seems that the review comment has been addressed correctly, as the HTML comment change is indeed present and has been identified. There are no indications of sensitive information or broken links within this specific comment.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Verify if there are any changes in HTML comments within the file
rg --type md '<!--' 'docs/book/user-guide/starter-guide/track-ml-models.md'

Length of output: 94

@yo-harsh yo-harsh changed the title A docs update for incorrect import in docs/book/user-guide/starter-guide/track-ml-models.md #2278 A docs update for incorrect import in docs/book/user-guide/starter-guide/track-ml-models.md Jan 13, 2024
Copy link
Contributor

@htahir1 htahir1 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 the contribution! Ill get this fixed in the main docs

@htahir1 htahir1 merged commit 1fb6966 into zenml-io:develop Jan 13, 2024
4 checks passed
htahir1 pushed a commit that referenced this pull request Jan 13, 2024
…ide/track-ml-models.md (#2279)

* Remove manual linkage from docs (#2272) (#2273)

(cherry picked from commit 625c46c)

* Update track-ml-models.md

---------

Co-authored-by: Alex Strick van Linschoten <[email protected]>
(cherry picked from commit 1fb6966)
kabinja pushed a commit to kabinja/zenml that referenced this pull request Jan 29, 2024
…ide/track-ml-models.md (zenml-io#2279)

* Remove manual linkage from docs (zenml-io#2272) (zenml-io#2273)

(cherry picked from commit 625c46c)

* Update track-ml-models.md

---------

Co-authored-by: Alex Strick van Linschoten <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants