Docs on ZenML setup #3100

strickvl · 2024-10-18T12:24:59Z

Describe changes

I implemented/fixed _ to achieve _.

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 your branch wasn't based on develop read Contribution guide on rebasing branch to 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)
Other (add details above)

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

htahir1

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

docs/book/how-to/setting-up-a-project-repository/access-management.md

docs/book/how-to/setting-up-a-project-repository/README.md

docs/book/how-to/setting-up-a-project-repository/stacks-pipelines-models.md

htahir1 · 2024-10-21T15:10:53Z

docs/book/how-to/setting-up-a-project-repository/stacks-pipelines-models.md

+
+## So how do I put this all together?
+
+![Diagram showing how Models bring together Pipelines and Artifacts](../../.gitbook/assets/model_pipeline_artifact.png)


This diagram doesnt really relate to the text below. might be worth spending a bit of effort making it match)

@strickvl are you working on this one?

i can take this

how about something like this? @htahir1

it's in the Media Assets file with name "Model Stacks Pipelines"

Can you ask @znegrin to take a crack at it? not sure about the Bob and Alice logos and zuri probably has some ideas.. @znegrin can you read the text below and give input as to how to model this?

htahir1 · 2024-10-21T15:11:56Z

docs/book/how-to/setting-up-a-project-repository/stacks-pipelines-models.md

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


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

drafted something along these lines

Co-authored-by: Hamza Tahir <[email protected]>

strickvl · 2024-10-23T15:31:38Z

@htahir1 updated with all my fixes.

htahir1

Some minor comments on latest changes

docs/book/how-to/setting-up-a-project-repository/shared-components-for-teams.md

htahir1 · 2024-10-23T20:25:27Z

docs/book/how-to/setting-up-a-project-repository/stacks-pipelines-models.md

+
+## So how do I put this all together?
+
+![Diagram showing how Models bring together Pipelines and Artifacts](../../.gitbook/assets/model_pipeline_artifact.png)


@strickvl are you working on this one?

docs/book/how-to/setting-up-a-project-repository/stacks-pipelines-models.md

coderabbitai · 2024-10-24T04:49:11Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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>, please review it.
- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @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.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

github-actions · 2024-10-24T04:51:49Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 13.9%, saving 14.92 KB.

Filename	Before	After	Improvement	Visual comparison
`docs/book/.gitbook/assets/data_scientist_connector_role.png`	49.99 KB	43.14 KB	-13.7%	View diff
`docs/book/.gitbook/assets/platform_engineer_connector_role.png`	57.44 KB	49.36 KB	-14.1%	View diff

365 images did not require optimisation.

Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.

htahir1 · 2024-10-24T08:56:46Z

docs/book/how-to/setting-up-a-project-repository/access-management.md

+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


Maybe you should then title it "Who is responsible for upgrading the ZenML server?"

htahir1 · 2024-10-24T08:57:03Z

docs/book/how-to/setting-up-a-project-repository/access-management.md

+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


Maybe "Who is responsible for migrating and maintaining pipelines?"

docs/book/how-to/setting-up-a-project-repository/shared-components-for-teams.md

docs/book/how-to/setting-up-a-project-repository/stacks-pipelines-models.md

htahir1 · 2024-10-24T09:01:36Z

docs/book/how-to/setting-up-a-project-repository/stacks-pipelines-models.md

+
+## So how do I put this all together?
+
+![Diagram showing how Models bring together Pipelines and Artifacts](../../.gitbook/assets/model_pipeline_artifact.png)


Can you ask @znegrin to take a crack at it? not sure about the Bob and Alice logos and zuri probably has some ideas.. @znegrin can you read the text below and give input as to how to model this?

…cs/set-up-zenml

github-actions · 2024-10-24T12:03:35Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 29.4%, saving 64.14 KB.

Filename	Before	After	Improvement	Visual comparison
`docs/book/.gitbook/assets/argilla_annotator.png`	218.51 KB	154.37 KB	-29.4%	View diff

366 images did not require optimisation.

Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.

wjayesh and others added 30 commits October 8, 2024 09:12

add some info on docker skip build

ae03fd1

add docs on not building a docker image

73dd4e0

update toc and title

7687aae

added text to stress that this doesnt always happen

ddf105c

Apply suggestions from code review

057aa73

Co-authored-by: Hamza Tahir <[email protected]>

restructure headings

1df5ba3

Merge branch 'docs/docker-skip-build' of https://github.com/zenml-io/…

b69e138

…zenml into docs/docker-skip-build

more english

bbe9e95

Apply suggestions from code review

516a214

Co-authored-by: Alex Strick van Linschoten <[email protected]>

Merge branch 'docs/docker-skip-build' of https://github.com/zenml-io/…

0b966c1

…zenml into docs/docker-skip-build

apply review changes

d373e44

add how to reuse builds page

563cb04

aoply hamza comments

75d947c

add redirect for new page name

44dc550

apply review changes

e5cd75e

move the artifact store block to the top

a369a8c

update redirect

b626e21

Merge remote-tracking branch 'origin/develop' into docs/set-up-zenml

a29cc1e

Merge remote-tracking branch 'origin/develop' into docs/set-up-zenml

4ff9e52

add shared components section

f8f00af

Merge remote-tracking branch 'origin/develop' into docs/set-up-zenml

01ec508

scarf

3486fe7

update toc

6255e08

Merge branch 'develop' into docs/set-up-zenml

7c06cf9

add stacks, pipelines, and models page

5af3cb9

Merge branch 'docs/set-up-zenml' of https://github.com/zenml-io/zenml …

0e8946b

…into docs/set-up-zenml

add overview page

f9167b8

add access management guide

a0e982f

Merge branch 'docs/set-up-zenml' of https://github.com/zenml-io/zenml …

263e40c

…into docs/set-up-zenml

Merge branch 'docs/set-up-zenml' of https://github.com/zenml-io/zenml …

30369f8

…into docs/set-up-zenml

minor changes

6110920

htahir1 requested changes Oct 21, 2024

View reviewed changes

strickvl and others added 11 commits October 21, 2024 17:26

Update docs/book/how-to/setting-up-a-project-repository/README.md

51a9814

Co-authored-by: Hamza Tahir <[email protected]>

Update docs/book/how-to/setting-up-a-project-repository/README.md

059624f

Co-authored-by: Hamza Tahir <[email protected]>

Apply suggestions from code review

804306b

Co-authored-by: Hamza Tahir <[email protected]>

add info about roles zenml pro

6b5364a

Merge branch 'develop' into docs/set-up-zenml

fcec800

add link

b3a1367

address review feedback

cf3bc74

extra spaces

3daaa41

fix naming

f7a76cd

add links and update pypi registry example

7baebc0

add example of connector roles

1ff2dad

htahir1 requested changes Oct 23, 2024

View reviewed changes

Optimised images with calibre/image-actions

2c5aba4

strickvl added 2 commits October 24, 2024 10:17

small fix

732d4ab

update section name

cdc5220

strickvl requested review from htahir1 and wjayesh October 24, 2024 08:18

strickvl and others added 2 commits October 24, 2024 10:19

Merge branch 'develop' into docs/set-up-zenml

959b973

apply reviews

b9be47a

htahir1 approved these changes Oct 24, 2024

View reviewed changes

strickvl and others added 3 commits October 24, 2024 13:41

update second location for pypi docs

d12cd86

Merge branch 'docs/set-up-zenml' of github.com:zenml-io/zenml into do…

d396182

…cs/set-up-zenml

Optimised images with calibre/image-actions

cd18cf8

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs on ZenML setup #3100

Docs on ZenML setup #3100

strickvl commented Oct 18, 2024

htahir1 left a comment

htahir1 Oct 21, 2024

htahir1 Oct 23, 2024

wjayesh Oct 24, 2024

wjayesh Oct 24, 2024

wjayesh Oct 24, 2024

htahir1 Oct 24, 2024

htahir1 Oct 21, 2024

strickvl Oct 23, 2024

strickvl commented Oct 23, 2024

htahir1 left a comment

htahir1 Oct 23, 2024

coderabbitai bot commented Oct 24, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

github-actions bot commented Oct 24, 2024

htahir1 Oct 24, 2024

htahir1 Oct 24, 2024

htahir1 Oct 24, 2024

github-actions bot commented Oct 24, 2024


		## So how do I put this all together?

		![Diagram showing how Models bring together Pipelines and Artifacts](../../.gitbook/assets/model_pipeline_artifact.png)


		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.

		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

		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

Docs on ZenML setup #3100

Are you sure you want to change the base?

Docs on ZenML setup #3100

Conversation

strickvl commented Oct 18, 2024

Describe changes

Pre-requisites

Types of changes

htahir1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

strickvl commented Oct 23, 2024

htahir1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coderabbitai bot commented Oct 24, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

github-actions bot commented Oct 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Oct 24, 2024