From 4174e54dfc92169d9d06f459f1e6549bc50d76eb Mon Sep 17 00:00:00 2001 From: Arthur Date: Wed, 4 Jun 2025 15:55:29 +0200 Subject: [PATCH] DMR: GUI docs (#22685) ## Description Add GUI docs for Docker Models. https://deploy-preview-22685--docsdocker.netlify.app/ai/model-runner/ --- content/manuals/_index.md | 2 +- .../_index.md} | 82 ++++++++++++++----- data/redirects.yml | 4 +- 3 files changed, 66 insertions(+), 22 deletions(-) rename content/manuals/ai/{model-runner.md => model-runner/_index.md} (83%) diff --git a/content/manuals/_index.md b/content/manuals/_index.md index f90b12bc48..43eb7dc6ce 100644 --- a/content/manuals/_index.md +++ b/content/manuals/_index.md @@ -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 diff --git a/content/manuals/ai/model-runner.md b/content/manuals/ai/model-runner/_index.md similarity index 83% rename from content/manuals/ai/model-runner.md rename to content/manuals/ai/model-runner/_index.md index 279336575d..56dc11dcae 100644 --- a/content/manuals/ai/model-runner.md +++ b/content/manuals/ai/model-runner/_index.md @@ -11,24 +11,27 @@ description: Learn how to use Docker Model Runner to manage and run AI models. 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 @@ -76,7 +79,58 @@ You can now use the `docker model` command in the CLI and view and interact with $ 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. +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 You can now start building your Generative AI application powered by the Docker Model Runner. @@ -164,7 +218,6 @@ with `/exp/vDD4.40`. > [!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 @@ -280,12 +333,3 @@ The Docker Model CLI currently lacks consistent support for specifying models by ## 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**. diff --git a/data/redirects.yml b/data/redirects.yml index aed83e6b26..2fa714d311 100644 --- a/data/redirects.yml +++ b/data/redirects.yml @@ -284,7 +284,8 @@ - /go/mcp-toolkit/ # Desktop DMR -"/model-runner/": + +"/ai/model-runner/": - /go/model-runner/ # Docker Desktop - volumes cloud backup @@ -338,4 +339,3 @@ - /go/permissions/ "/desktop/setup/install/mac-permission-requirements/#binding-privileged-ports": - /go/port-mapping/ - \ No newline at end of file