Skip to content

Conversation

@bergwolf
Copy link
Member

Add a simple getting-started guide for the CNCF ModelPack Specification, detailing its purpose, ecosystem components, key benefits, and practical steps to package and deploy AI models using OCI standards.

This starts with the model CSI driver usage. More usages (like oci volume source) can be added in future PRs.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @bergwolf, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a foundational 'Getting Started' guide for the CNCF ModelPack Specification. The guide aims to provide a clear understanding of the specification's role in the AI/ML ecosystem and offers practical instructions for packaging and deploying AI models using OCI standards, with an initial focus on leveraging the Model CSI driver for Kubernetes integration.

Highlights

  • New Getting Started Guide: A comprehensive 'getting-started.md' guide has been added to the documentation, detailing the CNCF ModelPack Specification's purpose, ecosystem, benefits, and practical usage.
  • README Update: The main README.md file has been updated to include a new 'Getting Started' section with a direct link to the newly added guide.
  • Ecosystem Overview: The new guide includes a high-level architecture diagram and descriptions of the ModelPack ecosystem components, covering core infrastructure, model management tools, and Kubernetes integration.
  • Practical Implementation Steps: The guide provides step-by-step instructions for installing modctl and the Model CSI Driver, packaging models, and deploying them in Kubernetes using a practical YAML example.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@bergwolf bergwolf added the documentation Improvements or additions to documentation label Sep 19, 2025
@gemini-code-assist
Copy link
Contributor

Warning

Gemini encountered an error creating the review. You can try again by commenting /gemini review.

Copy link

@sabre1041 sabre1041 left a comment

Choose a reason for hiding this comment

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

This is a great start. Added a number of comments

A similar walkthrough should be added to the website as that workstream evolves

@bergwolf bergwolf force-pushed the getting-started branch 2 times, most recently from bd14ee1 to 5d80f61 Compare October 9, 2025 15:31
@bergwolf
Copy link
Member Author

@sabre1041 Updated. Please give it another spin. Thanks!

@sabre1041
Copy link

@sabre1041 Updated. Please give it another spin. Thanks!

This is really good. Thank you for not only providing updates based on the feedback, but putting together a thorough walkthrough.

I added one small comment. Once its addressed, we should be good to merge!

Add a simple getting-started guide for the CNCF ModelPack Specification, detailing
its purpose, ecosystem components, key benefits, and practical steps to package
and deploy AI models using the ModelPack standard.

Signed-off-by: Peng Tao <[email protected]>
@bergwolf
Copy link
Member Author

@sabre1041 Updated. Please take a look.

Copy link

@sabre1041 sabre1041 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@gaius-qi gaius-qi left a comment

Choose a reason for hiding this comment

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

LGTM

@gaius-qi gaius-qi merged commit 59785a0 into modelpack:main Oct 20, 2025
6 checks passed
@bergwolf bergwolf deleted the getting-started branch October 20, 2025 04:09
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants