-
Notifications
You must be signed in to change notification settings - Fork 436
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
Docs on ZenML setup #3100
base: develop
Are you sure you want to change the base?
Docs on ZenML setup #3100
Conversation
Co-authored-by: Hamza Tahir <[email protected]>
…zenml into docs/docker-skip-build
Co-authored-by: Alex Strick van Linschoten <[email protected]>
…zenml into docs/docker-skip-build
…into docs/set-up-zenml
…into docs/set-up-zenml
…into docs/set-up-zenml
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.
VERY useful docs , and im looking forward to this being live!! Left comments
docs/book/how-to/customize-docker-builds/how-to-use-a-private-pypi-repository.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/setting-up-a-project-repository/access-management.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/setting-up-a-project-repository/stacks-pipelines-models.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/setting-up-a-project-repository/stacks-pipelines-models.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/setting-up-a-project-repository/stacks-pipelines-models.md
Outdated
Show resolved
Hide resolved
|
||
## So how do I put this all together? | ||
|
||
![Diagram showing how Models bring together Pipelines and Artifacts](../../.gitbook/assets/model_pipeline_artifact.png) |
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.
This diagram doesnt really relate to the text below. might be worth spending a bit of effort making it match)
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.
@strickvl are you working on this one?
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.
i can take this
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.
how about something like this? @htahir1
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.
it's in the Media Assets file with name "Model Stacks 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.
|
||
This is a very simple example, but it shows how you can use ZenML to structure your ML workflow. You can use the same principles for more complex workflows. | ||
|
||
|
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.
It would be nice to end with some general "rules of thumb" like:
- Create a model per machine learning use-cases
- Create a staging and production stack that is shared across models and pipelines
- Make sure everything is "tagged" properly, use tags to organize
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.
drafted something along these lines
Co-authored-by: Hamza Tahir <[email protected]>
Co-authored-by: Hamza Tahir <[email protected]>
Co-authored-by: Hamza Tahir <[email protected]>
@htahir1 updated with all my fixes. |
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.
Some minor comments on latest changes
docs/book/how-to/setting-up-a-project-repository/shared-components-for-teams.md
Outdated
Show resolved
Hide resolved
|
||
## So how do I put this all together? | ||
|
||
![Diagram showing how Models bring together Pipelines and Artifacts](../../.gitbook/assets/model_pipeline_artifact.png) |
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.
@strickvl are you working on this one?
docs/book/how-to/setting-up-a-project-repository/stacks-pipelines-models.md
Outdated
Show resolved
Hide resolved
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
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 13.9%, saving 14.92 KB.
365 images did not require optimisation. Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions. |
Learn more about the best practices in managing credentials and recommended roles in our [Managing Stacks and Components guide](../stack-deployment/README.md). | ||
|
||
|
||
## ZenML Server Upgrades |
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.
Maybe you should then title it "Who is responsible for upgrading the ZenML server?"
and more. Read in detail about the best practices for upgrading your ZenML server in the [Best Practices for Upgrading ZenML Servers](../manage-the-zenml-server/best-practices-upgrading-zenml.md) guide. | ||
|
||
|
||
## Pipeline Migration and Maintenance |
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.
Maybe "Who is responsible for migrating and maintaining pipelines?"
docs/book/how-to/setting-up-a-project-repository/shared-components-for-teams.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/setting-up-a-project-repository/stacks-pipelines-models.md
Outdated
Show resolved
Hide resolved
|
||
## So how do I put this all together? | ||
|
||
![Diagram showing how Models bring together Pipelines and Artifacts](../../.gitbook/assets/model_pipeline_artifact.png) |
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.
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 29.4%, saving 64.14 KB.
366 images did not require optimisation. Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions. |
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