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

Docs on ZenML setup #3100

Merged
merged 77 commits into from
Oct 25, 2024
Merged

Docs on ZenML setup #3100

merged 77 commits into from
Oct 25, 2024

Conversation

strickvl
Copy link
Contributor

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)

wjayesh and others added 30 commits October 8, 2024 09:12
Co-authored-by: Hamza Tahir <hamza@zenml.io>
Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
@strickvl
Copy link
Contributor Author

@htahir1 updated with all my fixes.

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.

Some minor comments on latest changes


## So how do I put this all together?

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

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?

Copy link
Contributor

coderabbitai bot commented Oct 24, 2024

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.

Copy link
Contributor

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.

@strickvl strickvl requested review from htahir1 and wjayesh October 24, 2024 08:18
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
Copy link
Contributor

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
Copy link
Contributor

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?"


## So how do I put this all together?

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor

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.

Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 43.1%, saving 711.53 KB.

Filename Before After Improvement Visual comparison
docs/book/.gitbook/assets/argilla_annotator.png 218.51 KB 154.37 KB -29.4% View diff
docs/book/.gitbook/assets/model_pipeline_artifact.png 1.40 MB 785.12 KB -45.2% 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.

@strickvl strickvl merged commit 128b32f into develop Oct 25, 2024
7 checks passed
@strickvl strickvl deleted the docs/set-up-zenml branch October 25, 2024 16:00
htahir1 pushed a commit that referenced this pull request Oct 26, 2024
* add some info on docker skip build

* add docs on not building a docker image

* update toc and title

* added text to stress that this doesnt always happen

* Apply suggestions from code review

Co-authored-by: Hamza Tahir <hamza@zenml.io>

* restructure headings

* more english

* Apply suggestions from code review

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

* apply review changes

* add how to reuse builds page

* aoply hamza comments

* add redirect for new page name

* apply review changes

* move the artifact store block to the top

* update redirect

* add shared components section

* scarf

* update toc

* add stacks, pipelines, and models page

* add overview page

* add access management guide

* update setup repository

* update text

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

Co-authored-by: Hamza Tahir <hamza@zenml.io>

* update

* a tags become markdown links

* add artifacts and real life example

* fix typos

* add scarf

* update toc

* remove first md

* split pypi section out

* restructure

* add scarf

* add diagram

* Optimised images with calibre/image-actions

* fix spelling

* add descriptions

* rename some sections

* minor changes

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

Co-authored-by: Hamza Tahir <hamza@zenml.io>

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

Co-authored-by: Hamza Tahir <hamza@zenml.io>

* Apply suggestions from code review

Co-authored-by: Hamza Tahir <hamza@zenml.io>

* add info about roles zenml pro

* add link

* address review feedback

* extra spaces

* fix naming

* add links and update pypi registry example

* add example of connector roles

* Optimised images with calibre/image-actions

* small fix

* update section name

* apply reviews

* update second location for pypi docs

* Optimised images with calibre/image-actions

* replace image

* Optimised images with calibre/image-actions

---------

Co-authored-by: Jayesh Sharma <wjayesh@outlook.com>
Co-authored-by: Hamza Tahir <hamza@zenml.io>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
(cherry picked from commit 128b32f)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal To filter out internal PRs and issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants