Model control plane technical documentation

[strickvl]

A first draft of the MCP technical docs. Preview most of the changes here on Gitbook.

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.
• If I have added an integration, I have updated the integrations table and the corresponding website section.
• 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.

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)

Summary by CodeRabbit

• Documentation
  • Updated hyperlinks in the "Core Concepts" section for better navigation.
  • Added a new "Models" section in "Core Concepts" explaining the role and handling of models in ZenML.
  • Included a new "Model Management" entry in the table of contents and the advanced guide.
  • Created a comprehensive guide on model management, covering registration, versioning, and promotion of models within ZenML.

[github-actions]

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 27.3%, saving 51.53 KB.

Filename	Before	After	Improvement	Visual comparison
docs/book/.gitbook/assets/model-control-plane-dashboard.png	188.62 KB	137.10 KB	-27.3%	View diff

221 images did not require optimisation.

[avishniakov]

Didn't go through all the lines, just making a checkpoint before our planning meeting.

[coderabbitai]

Walkthrough

Walkthrough

ZenML documentation has been updated to include new sections on model management. Hyperlinks in the core concepts have been corrected, and a comprehensive explanation of model handling in ZenML, including API and cloud dashboard interactions, has been added. The table of contents and advanced guide reflect these updates by introducing model management entries, and a new detailed guide on model management is now available.

Changes

File Path	Change Summary
docs/book/getting-started/core-concepts.md	Updated hyperlinks; added section on Models with API and Cloud details.
docs/book/toc.md docs/book/user-guide/advanced-guide/advanced-guide.md	Added "Model management" entries.
.../advanced-guide/artifact-management/model-management.md	New file on managing ML models with ZenML; details on model versions, registration, versioning, stages, promotion, and artifact linking; added functions and data structures.

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

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• You can reply to a review comment made by CodeRabbit.
• You can tag CodeRabbit on specific lines of code or files in the PR by tagging @coderabbitai in a comment.
• You can tag @coderabbitai in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

[strickvl]

@coderabbitai review

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between e1e6f2d and 237344e.

Files selected for processing (4)

• docs/book/getting-started/core-concepts.md (2 hunks)
• docs/book/toc.md (1 hunks)
• docs/book/user-guide/advanced-guide/advanced-guide.md (1 hunks)
• docs/book/user-guide/advanced-guide/artifact-management/model-management.md (1 hunks)

Files skipped from review due to trivial changes (2)

• docs/book/getting-started/core-concepts.md
• docs/book/toc.md

Additional comments: 7

docs/book/user-guide/advanced-guide/advanced-guide.md (1)

• 9-9: The addition of "Model management" to the table is consistent with the PR objectives and enhances the guide by including this important topic. Ensure that the hyperlink to model-management.md is functional and leads to the correct documentation section.

docs/book/user-guide/advanced-guide/artifact-management/model-management.md (6)

• 1-12: The introduction to model management clearly defines the scope and importance of models within ZenML. It's well-written and provides a good starting point for understanding the concept.

• 24-32: The section on Model Versions is informative and aligns with the overall documentation structure. Verify that the hyperlinks, such as the one to the ZenML Cloud dashboard, are accurate and lead to the intended pages.

• 34-55: The instructions for registering models using the CLI are clear. Confirm that the command zenml model register and its options are correctly documented and match the actual CLI functionality.

• 79-89: The section on implicit registration by ZenML is well-explained. The code example provided should be verified for correctness and practicality within the context of a ZenML pipeline.

• 267-311: The section on linking artifacts to models is crucial and appears to be well-documented. Verify that the code examples and configurations mentioned are accurate and align with the current capabilities of ZenML.

• 325-325: Confirm that the image linked at the end of the document is displayed correctly and does not raise any privacy concerns, as it includes a tracking pixel (x-pxid).

[avishniakov]

Beautiful, thanks!