Skip to content

docs: add Docker Model Runner usage guide for ModelPack artifacts#183

Open
rishi-jat wants to merge 1 commit intomodelpack:mainfrom
rishi-jat:docs/docker-model-runner-guide
Open

docs: add Docker Model Runner usage guide for ModelPack artifacts#183
rishi-jat wants to merge 1 commit intomodelpack:mainfrom
rishi-jat:docs/docker-model-runner-guide

Conversation

@rishi-jat
Copy link

Add documentation describing how ModelPack artifacts can be used with Docker Model Runner.

This PR adds a guide explaining:

  • what ModelPack compatibility in Docker Model Runner means
  • how to run ModelPack artifacts using the Docker Model Runner workflow
  • a simple example workflow using an OCI artifact reference

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

Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Copilot AI review requested due to automatic review settings March 13, 2026 07:37
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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

  • New Documentation: A new guide was added explaining how to use ModelPack artifacts with Docker Model Runner.
  • ModelPack Compatibility: The guide clarifies what ModelPack compatibility means within Docker Model Runner.
  • Usage Workflow: Steps are provided for packaging, pushing, and running ModelPack artifacts using the Docker Model Runner workflow.
  • Example Workflow: A simple example demonstrating an OCI artifact reference with Docker Model Runner is included.
  • Improved Discoverability: A link to the new guide was added to the existing Getting Started documentation.
Changelog
  • docs/getting-started.md
    • Added a new entry linking to the Docker Model Runner guide for ModelPack artifacts.
  • docs/modelpack.md
    • Created a new markdown file detailing how to run ModelPack models with Docker Model Runner.
    • Included sections on ModelPack compatibility, a step-by-step guide, an example workflow, and compatibility notes.
Activity
  • No human activity has been recorded for this pull request yet.
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
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

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.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 run example.
  • 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.
Comment on lines +7 to +8
Docker Model Runner includes ModelPack compatibility introduced in [docker/model-runner#516](https://github.com/docker/model-runner/pull/516).

@rishi-jat
Copy link
Author

/cc @bergwolf
/cc @gorkem
/cc @aftersnow
/cc @chlins

@aftersnow
Copy link
Contributor

  1. The example flow seems to skip an explicit docker model pull. Docker’s CLI docs describe docker model run as loading a model on demand once it is already available locally, so following this example as written may fail with a “model not found” style error. Please add a docker model pull "$MODEL_REF" step, or explicitly note that the model must already be pulled before run.

  2. The wording here feels a bit too broad: “pull and run model artifacts that follow the ModelPack specification” reads as if any spec-compliant ModelPack artifact is directly runnable in Docker Model Runner. In practice, runtime support still depends on the model format / inference engine combinations that DMR supports. Could we tighten this wording to avoid conflating packaging compatibility with runtime compatibility?

  3. Minor docs suggestion: if Docker Model Runner has already released a version containing feat(distribution): add CNCF ModelPack format compatibility docker/model-runner#516, it would be clearer to reference the minimum released version instead of only the PR number.

  4. Minor naming nit: modelpack.md is a bit generic and may be confused with the project’s broader ModelPack docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants