-
Notifications
You must be signed in to change notification settings - Fork 441
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
Extended register artifact docs #3165
base: develop
Are you sure you want to change the base?
Conversation
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
|
||
|
||
@step(enable_cache=True) | ||
def load_v1(): |
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.
Is that best practice really to do this in a step? This rather seems like a one-time execution, which happens manually?
@@ -46,6 +46,61 @@ with open(os.path.join(temp_artifact_folder_path,test_file_name),"r") as f: | |||
The artifact produced from the preexisting data will have a `pathlib.Path` type, once loaded or passed as input to another step. The path will be pointing to a temporary location in the executing environment and ready for use as a normal local `Path` (passed into `from_pretrained` or `open` functions to name a few examples). | |||
{% endhint %} | |||
|
|||
## Register Existing folder as a ZenML Artifact and use in Pipeline | |||
|
|||
For datasets in a folder structure, that you don't want to materialize in the pipeline, you can register the folder as a ZenML Artifact and use it in subsequent steps or other pipelines. |
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.
What's the meaning of don't want to materialize in the pipeline
here?
- IMO
load
is not just shorter, it's also the better and more clear verb that people actually understand - The data gets loaded in the same pipeline. I think this refers to the first step, but I think in general this probably should not happen in the pipeline at all, see my other comment
Describe changes
I implemented/fixed _ to achieve _.
Pre-requisites
Please ensure you have done the following:
develop
and the open PR is targetingdevelop
. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.Types of changes