Skip to content

Commit 96d7f4d

Browse files
ArthurFlagArthurFlag
committed
dmr: gui docs
1 parent 4678e93 commit 96d7f4d

File tree

3 files changed

+68
-23
lines changed

3 files changed

+68
-23
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: /assets/icons/toolbox.svg

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

Lines changed: 64 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,30 @@ params:
88
group: AI
99
weight: 20
1010
description: Learn how to use Docker Model Runner to manage and run AI models.
11-
keywords: Docker, ai, model runner, docker deskotp, llm
11+
keywords: Docker, ai, model runner, docker desktop, 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

@@ -45,7 +48,58 @@ Models are pulled from Docker Hub the first time they're used and stored locally
4548

4649
You can now use the `docker model` command in the CLI and view and interact with your local models in the **Models** tab in the Docker Desktop Dashboard.
4750

48-
## Integrate the Docker Model Runner into your software development lifecycle
51+
## Pull a model
52+
53+
Models are cached locally.
54+
55+
{{< tabs >}}
56+
{{< tab name="From Docker Desktop">}}
57+
58+
1. Select **Models** and select the **Docker Hub** tab.
59+
2. Find the model of your choice and select **Pull**.
60+
61+
{{< /tab >}}
62+
{{< tab name="From the Docker CLI">}}
63+
64+
Use the [`docker model pull` command](/reference/cli/docker/).
65+
66+
{{< /tab >}}
67+
{{< /tabs >}}
68+
69+
## Run a model
70+
71+
{{< tabs >}}
72+
{{< tab name="From Docker Desktop">}}
73+
74+
Select **Models** and select the **Local** tab and click the play button.
75+
The interactive chat screen opens.
76+
77+
{{< /tab >}}
78+
{{< tab name="From the Docker CLI">}}
79+
80+
Use the [`docker model run` command](/reference/cli/docker/).
81+
82+
{{< /tab >}}
83+
{{< /tabs >}}
84+
85+
## Troubleshooting
86+
87+
To troubleshoot potential issues, display the logs:
88+
89+
{{< tabs >}}
90+
{{< tab name="From Docker Desktop">}}
91+
92+
Select **Models** and select the **Logs** tab.
93+
94+
{{< /tab >}}
95+
{{< tab name="From the Docker CLI">}}
96+
97+
Use the [`docker model log` command](/reference/cli/docker/).
98+
99+
{{< /tab >}}
100+
{{< /tabs >}}
101+
102+
## Example: Integrate Docker Model Runner into your software development lifecycle
49103

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

@@ -109,7 +163,6 @@ with `/exp/vDD4.40`.
109163
> [!NOTE]
110164
> You can omit `llama.cpp` from the path. For example: `POST /engines/v1/chat/completions`.
111165
112-
113166
### How do I interact through the OpenAI API?
114167

115168
#### From within a container
@@ -225,12 +278,3 @@ The Docker Model CLI currently lacks consistent support for specifying models by
225278
## Share feedback
226279

227280
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.
228-
229-
## Disable the feature
230-
231-
To disable Docker Model Runner:
232-
233-
1. Open the **Settings** view in Docker Desktop.
234-
2. Navigate to the **Beta** tab in **Features in development**.
235-
3. Clear the **Enable Docker Model Runner** checkbox.
236-
4. Select **Apply & restart**.

‎data/redirects.yml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -298,9 +298,10 @@
298298
- /go/hub-pull-limits/
299299

300300
# Desktop DMR
301-
"/model-runner/":
301+
302+
"/ai/model-runner/":
302303
- /go/model-runner/
303-
304+
304305
# Desktop MCP Toolkit
305306
"/ai/mcp-toolkit/":
306307
- /go/mcp-toolkit/

0 commit comments

Comments
 (0)