docs: add Docker Model Runner usage guide for ModelPack artifacts#183
docs: add Docker Model Runner usage guide for ModelPack artifacts#183rishi-jat wants to merge 1 commit intomodelpack:mainfrom
Conversation
Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Summary of ChangesHello, 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 comprehensive documentation to guide users on integrating ModelPack artifacts with Docker Model Runner. It clarifies the concept of ModelPack compatibility, outlines the necessary steps for running ModelPack models, and provides a practical example. This enhancement aims to improve user understanding and discoverability of this functionality, addressing a previously identified documentation gap. Highlights
Changelog
Activity
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
Code Review
This pull request introduces new documentation for running ModelPack models using Docker Model Runner. A new guide, docs/modelpack.md, has been added, which explains ModelPack compatibility, provides steps for running models, includes an example workflow, and lists compatibility notes. Additionally, a link to this new guide has been integrated into docs/getting-started.md under the core infrastructure components section.
There was a problem hiding this comment.
Pull request overview
Adds end-user documentation for running ModelPack (OCI) artifacts with Docker Model Runner, and links it from the Getting Started guide to improve discoverability.
Changes:
- Add a new guide describing ModelPack compatibility in Docker Model Runner and a minimal
docker model runexample. - Add a link to the new guide from the “Model Management Tools” list in Getting Started.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/modelpack.md | New guide explaining Docker Model Runner usage with ModelPack artifacts and basic compatibility notes. |
| docs/getting-started.md | Adds a link to the new Docker Model Runner guide for discoverability. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ## Compatibility notes | ||
|
|
||
| - Use a Docker Model Runner version that includes [docker/model-runner#516](https://github.com/docker/model-runner/pull/516) or newer. |
| Docker Model Runner includes ModelPack compatibility introduced in [docker/model-runner#516](https://github.com/docker/model-runner/pull/516). | ||
|
|
|
/cc @bergwolf |
|
Add documentation describing how ModelPack artifacts can be used with Docker Model Runner.
This PR adds a guide explaining:
A link to this guide is also added in the Getting Started documentation to improve discoverability.
This addresses part of the remaining work discussed in:
#151