Skip to content

Revert "Revert "DMR: GUI docs"" #22769

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 4, 2025
Merged

Revert "Revert "DMR: GUI docs"" #22769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/manuals/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ params:
- title: Docker Model Runner
description: View and manage your local models.
icon: view_in_ar
link: /model-runner/
link: /ai/model-runner/
- title: MCP Catalog and Toolkit
description: Augment your AI workflow with MCP servers.
icon: /icons/toolkit.svg
Expand Down
82 changes: 63 additions & 19 deletions content/manuals/ai/model-runner.md → content/manuals/ai/model-runner/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,27 @@
keywords: Docker, ai, model runner, docker desktop, docker engine, llm
aliases:
- /desktop/features/model-runner/
- /ai/model-runner/
- /model-runner/
---

{{< summary-bar feature_name="Docker Model Runner" >}}

The Docker Model Runner plugin lets you:
## Key features

- [Pull models from Docker Hub](https://hub.docker.com/u/ai)
- Run AI models directly from the command line
- Manage local models (add, list, remove)
- Interact with models using a submitted prompt or in chat mode in the CLI or Docker Desktop Dashboard
- Push models to Docker Hub
- [Pull and push models to and from Docker Hub](https://hub.docker.com/u/ai)
- Run and interact with AI models directly from the command line or from the Docker Desktop GUI
- Manage local models and display logs

## How it works

Models are pulled from Docker Hub the first time they're used and stored locally. They're loaded into memory only at runtime when a request is made, and unloaded when not in use to optimize resources. Since models can be large, the initial pull may take some time — but after that, they're cached locally for faster access. You can interact with the model using [OpenAI-compatible APIs](#what-api-endpoints-are-available).

> [!TIP]
>
> Using Testcontainers or Docker Compose? [Testcontainers for Java](https://java.testcontainers.org/modules/docker_model_runner/) and [Go](https://golang.testcontainers.org/modules/dockermodelrunner/), and [Docker Compose](/manuals/compose/how-tos/model-runner.md) now support Docker Model Runner.
> Using Testcontainers or Docker Compose?
> [Testcontainers for Java](https://java.testcontainers.org/modules/docker_model_runner/)
> and [Go](https://golang.testcontainers.org/modules/dockermodelrunner/), and
> [Docker Compose](/manuals/compose/how-tos/model-runner.md) now support Docker Model Runner.

## Enable Docker Model Runner

Expand Down Expand Up @@ -76,7 +79,58 @@
$ docker model run ai/smollm2
```

## Integrate the Docker Model Runner into your software development lifecycle
## Pull a model

Models are cached locally.

{{< tabs >}}
{{< tab name="From Docker Desktop">}}

1. Select **Models** and select the **Docker Hub** tab.
2. Find the model of your choice and select **Pull**.

{{< /tab >}}
{{< tab name="From the Docker CLI">}}

Use the [`docker model pull` command](/reference/cli/docker/).

{{< /tab >}}
{{< /tabs >}}

## Run a model

{{< tabs >}}
{{< tab name="From Docker Desktop">}}

Select **Models** and select the **Local** tab and click the play button.

Check warning on line 105 in content/manuals/ai/model-runner/_index.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Docker.RecommendedWords] Consider using 'select' instead of 'click'

Raw Output:
{"message": "[Docker.RecommendedWords] Consider using 'select' instead of 'click'", "location": {"path": "content/manuals/ai/model-runner/_index.md", "range": {"start": {"line": 105, "column": 52}}}, "severity": "INFO"}
The interactive chat screen opens.

{{< /tab >}}
{{< tab name="From the Docker CLI">}}

Use the [`docker model run` command](/reference/cli/docker/).

{{< /tab >}}
{{< /tabs >}}

## Troubleshooting

To troubleshoot potential issues, display the logs:

{{< tabs >}}
{{< tab name="From Docker Desktop">}}

Select **Models** and select the **Logs** tab.

{{< /tab >}}
{{< tab name="From the Docker CLI">}}

Use the [`docker model log` command](/reference/cli/docker/).

{{< /tab >}}
{{< /tabs >}}

## Example: Integrate Docker Model Runner into your software development lifecycle

Check warning on line 133 in content/manuals/ai/model-runner/_index.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Docker.HeadingLength] Try to keep headings short (< 8 words).

Raw Output:
{"message": "[Docker.HeadingLength] Try to keep headings short (\u003c 8 words).", "location": {"path": "content/manuals/ai/model-runner/_index.md", "range": {"start": {"line": 133, "column": 4}}}, "severity": "INFO"}

You can now start building your Generative AI application powered by the Docker Model Runner.

Expand Down Expand Up @@ -164,7 +218,6 @@
> [!NOTE]
> You can omit `llama.cpp` from the path. For example: `POST /engines/v1/chat/completions`.


### How do I interact through the OpenAI API?

#### From within a container
Expand Down Expand Up @@ -280,12 +333,3 @@
## Share feedback

Thanks for trying out Docker Model Runner. Give feedback or report any bugs you may find through the **Give feedback** link next to the **Enable Docker Model Runner** setting.

## Disable the feature

To disable Docker Model Runner:

1. Open the **Settings** view in Docker Desktop.
2. Navigate to the **Beta** tab in **Features in development**.
3. Clear the **Enable Docker Model Runner** checkbox.
4. Select **Apply & restart**.
4 changes: 2 additions & 2 deletions data/redirects.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,8 @@
- /go/mcp-toolkit/

# Desktop DMR
"/model-runner/":

"/ai/model-runner/":
- /go/model-runner/

# Docker Desktop - volumes cloud backup
Expand Down Expand Up @@ -338,4 +339,3 @@
- /go/permissions/
"/desktop/setup/install/mac-permission-requirements/#binding-privileged-ports":
- /go/port-mapping/