Update README.md
#3783
Merged
Update README.md
#3783
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
strickvl
commented
Jun 30, 2025
strickvl
commented
- Updated README
- new images
- Revised section titles for improved readability, changing "Stack-agnostic: keep your code the same" to "Write Code Once, Run Anywhere" and "Built for platform teams" to "Automatic Versioning for MLOps and LLMOps". - Expanded descriptions to better articulate ZenML's functionality, including examples of code snippets for pipelines and steps. - Added visual ideas to illustrate key features and workflows, enhancing the documentation's engagement and usability. - Included new sections on integrating tools and building production-grade AI workflows, showcasing ZenML's versatility in MLOps and LLMOps contexts.
- Updated the section title from "The Hidden Complexity of Production AI" to "Beyond the Demo: The Reality of Production AI" to better reflect the content. - Enhanced the description of challenges faced when transitioning from POC to production, emphasising the complexities of evaluation pipelines, document processing, cost tracking, and compliance. - Added specific target audiences for ZenML, highlighting its benefits for platform teams, enterprises, and organisations in regulated industries. - Removed outdated sections to streamline the document and improve focus on ZenML's orchestration capabilities.
- Modified the `my_training_pipeline` function to return the trained model, improving the pipeline's utility. - Updated the description of automatic versioning to include code formatting for `scikit-learn`, enhancing readability. - Replaced the `Client().active_step_run.log_metadata` call with `log_metadata` for logging evaluation costs, streamlining the logging process. - Renamed the `training_pipeline_with_integrations` to `llm_finetuning_pipeline` for better alignment with its purpose. - Added an `on_failure` hook to the `llm_trainer` step, improving error handling in the pipeline. - Ensured consistent formatting and clarity throughout the README for better user understanding.
strickvl
added
documentation
|
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 Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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
|
Documentation Link Check Results✅ Absolute links check passed |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 28.9%, saving 252.30 KB.
361 images did not require optimisation. Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions. |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 46.5%, saving 201.02 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. |
|
im gonna merge this and do an updated PR for refinement |
htahir1
approved these changes
Jul 9, 2025
htahir1
added a commit
that referenced
this pull request
Jul 9, 2025
* initial * more * interim * Update README.md to enhance clarity and detail on ZenML's capabilities - Revised section titles for improved readability, changing "Stack-agnostic: keep your code the same" to "Write Code Once, Run Anywhere" and "Built for platform teams" to "Automatic Versioning for MLOps and LLMOps". - Expanded descriptions to better articulate ZenML's functionality, including examples of code snippets for pipelines and steps. - Added visual ideas to illustrate key features and workflows, enhancing the documentation's engagement and usability. - Included new sections on integrating tools and building production-grade AI workflows, showcasing ZenML's versatility in MLOps and LLMOps contexts. * Revise README.md to clarify ZenML's role in production AI - Updated the section title from "The Hidden Complexity of Production AI" to "Beyond the Demo: The Reality of Production AI" to better reflect the content. - Enhanced the description of challenges faced when transitioning from POC to production, emphasising the complexities of evaluation pipelines, document processing, cost tracking, and compliance. - Added specific target audiences for ZenML, highlighting its benefits for platform teams, enterprises, and organisations in regulated industries. - Removed outdated sections to streamline the document and improve focus on ZenML's orchestration capabilities. * Update README.md to enhance clarity and functionality of ZenML pipelines - Modified the `my_training_pipeline` function to return the trained model, improving the pipeline's utility. - Updated the description of automatic versioning to include code formatting for `scikit-learn`, enhancing readability. - Replaced the `Client().active_step_run.log_metadata` call with `log_metadata` for logging evaluation costs, streamlining the logging process. - Renamed the `training_pipeline_with_integrations` to `llm_finetuning_pipeline` for better alignment with its purpose. - Added an `on_failure` hook to the `llm_trainer` step, improving error handling in the pipeline. - Ensured consistent formatting and clarity throughout the README for better user understanding. * update README(s) * More README updates * README improvements * remove zenml go * Small update for LLM support * update header * use other version's line * improve secrets section * Remove excess * Remove decision maker section * Footer changes * Update README * Optimised images with calibre/image-actions * Update the use case example so that it all connects * Update README with improved MLOps messaging * Add version 0.83.1 release notes to README * Update latest release link in README.md * Update README with new content about AI agent development * Delete compliance, RAG pipeline, architecture, and orchestrator images * Add images for problem and development lifecycle * Optimised images with calibre/image-actions --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Hamza Tahir <[email protected]> Co-authored-by: Hamza Tahir <[email protected]> (cherry picked from commit c049143)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.