-
Notifications
You must be signed in to change notification settings - Fork 445
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
Conversation
WalkthroughWalkthroughThe 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 Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
@coderabbitai review |
There was a problem hiding this 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
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
tofrom zenml import ModelVersion
. This change should resolve theTypeError
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 thetrack-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
There was a problem hiding this 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
…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]>
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:
develop
and the open PR is targetingdevelop
.Types of changes
Summary by CodeRabbit