Skip to content

Commit df41305

Browse files
authored
DMR: GUI docs (#22781)
Reverts #22780
1 parent a8e975a commit df41305

File tree

3 files changed

+66
-22
lines changed

3 files changed

+66
-22
lines changed

content/manuals/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ params:
3939
- title: Docker Model Runner
4040
description: View and manage your local models.
4141
icon: view_in_ar
42-
link: /model-runner/
42+
link: /ai/model-runner/
4343
- title: MCP Catalog and Toolkit
4444
description: Augment your AI workflow with MCP servers.
4545
icon: /icons/toolkit.svg

content/manuals/ai/model-runner.md renamed to content/manuals/ai/model-runner/_index.md

Lines changed: 63 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,27 @@ description: Learn how to use Docker Model Runner to manage and run AI models.
1111
keywords: Docker, ai, model runner, docker desktop, docker engine, llm
1212
aliases:
1313
- /desktop/features/model-runner/
14-
- /ai/model-runner/
14+
- /model-runner/
1515
---
1616

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

19-
The Docker Model Runner plugin lets you:
19+
## Key features
2020

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

2727
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).
2828

2929
> [!TIP]
3030
>
31-
> 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.
31+
> Using Testcontainers or Docker Compose?
32+
> [Testcontainers for Java](https://java.testcontainers.org/modules/docker_model_runner/)
33+
> and [Go](https://golang.testcontainers.org/modules/dockermodelrunner/), and
34+
> [Docker Compose](/manuals/compose/how-tos/model-runner.md) now support Docker Model Runner.
3235
3336
## Enable Docker Model Runner
3437

@@ -76,7 +79,58 @@ You can now use the `docker model` command in the CLI and view and interact with
7679
$ docker model run ai/smollm2
7780
```
7881

79-
## Integrate the Docker Model Runner into your software development lifecycle
82+
## Pull a model
83+
84+
Models are cached locally.
85+
86+
{{< tabs >}}
87+
{{< tab name="From Docker Desktop">}}
88+
89+
1. Select **Models** and select the **Docker Hub** tab.
90+
2. Find the model of your choice and select **Pull**.
91+
92+
{{< /tab >}}
93+
{{< tab name="From the Docker CLI">}}
94+
95+
Use the [`docker model pull` command](/reference/cli/docker/).
96+
97+
{{< /tab >}}
98+
{{< /tabs >}}
99+
100+
## Run a model
101+
102+
{{< tabs >}}
103+
{{< tab name="From Docker Desktop">}}
104+
105+
Select **Models** and select the **Local** tab and click the play button.
106+
The interactive chat screen opens.
107+
108+
{{< /tab >}}
109+
{{< tab name="From the Docker CLI">}}
110+
111+
Use the [`docker model run` command](/reference/cli/docker/).
112+
113+
{{< /tab >}}
114+
{{< /tabs >}}
115+
116+
## Troubleshooting
117+
118+
To troubleshoot potential issues, display the logs:
119+
120+
{{< tabs >}}
121+
{{< tab name="From Docker Desktop">}}
122+
123+
Select **Models** and select the **Logs** tab.
124+
125+
{{< /tab >}}
126+
{{< tab name="From the Docker CLI">}}
127+
128+
Use the [`docker model log` command](/reference/cli/docker/).
129+
130+
{{< /tab >}}
131+
{{< /tabs >}}
132+
133+
## Example: Integrate Docker Model Runner into your software development lifecycle
80134

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

@@ -164,7 +218,6 @@ with `/exp/vDD4.40`.
164218
> [!NOTE]
165219
> You can omit `llama.cpp` from the path. For example: `POST /engines/v1/chat/completions`.
166220
167-
168221
### How do I interact through the OpenAI API?
169222
170223
#### From within a container
@@ -280,12 +333,3 @@ The Docker Model CLI currently lacks consistent support for specifying models by
280333
## Share feedback
281334
282335
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.
283-
284-
## Disable the feature
285-
286-
To disable Docker Model Runner:
287-
288-
1. Open the **Settings** view in Docker Desktop.
289-
2. Navigate to the **Beta** tab in **Features in development**.
290-
3. Clear the **Enable Docker Model Runner** checkbox.
291-
4. Select **Apply & restart**.

data/redirects.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,8 @@
284284
- /go/mcp-toolkit/
285285

286286
# Desktop DMR
287-
"/model-runner/":
287+
288+
"/ai/model-runner/":
288289
- /go/model-runner/
289290

290291
# Docker Desktop - volumes cloud backup
@@ -338,4 +339,3 @@
338339
- /go/permissions/
339340
"/desktop/setup/install/mac-permission-requirements/#binding-privileged-ports":
340341
- /go/port-mapping/
341-

0 commit comments

Comments
 (0)