Skip to content
This repository was archived by the owner on Oct 6, 2025. It is now read-only.

Commit d146886

Browse files
ekcaseyekcasey
committed
update docs
Signed-off-by: Emily Casey <[email protected]>
1 parent c3466c3 commit d146886

File tree

3 files changed

+30
-29
lines changed

3 files changed

+30
-29
lines changed

‎docs/reference/docker_model_package.yaml‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
command: docker model package
22
short: |
3-
Package a GGUF file into a Docker model OCI artifact, with optional licenses, and pushes it to the specified registry
3+
Package a GGUF file into a Docker model OCI artifact, with optional licenses. The package is sent to the model-runner, unless --push is specified
44
long: |
5-
Package a GGUF file into a Docker model OCI artifact, with optional licenses, and pushes it to the specified registry
6-
usage: docker model package --gguf <path> [--license <path>...] [--context-size <tokens>] --push TARGET
5+
Package a GGUF file into a Docker model OCI artifact, with optional licenses. The package is sent to the model-runner, unless --push is specified
6+
usage: docker model package --gguf <path> [--license <path>...] [--context-size <tokens>] [--push] [<tag>]
77
pname: docker model
88
plink: docker_model.yaml
99
options:
@@ -40,7 +40,8 @@ options:
4040
- option: push
4141
value_type: bool
4242
default_value: "false"
43-
description: push to registry (required)
43+
description: |
44+
push to registry (if not set, the model is loaded into the Model Runner content store.
4445
deprecated: false
4546
hidden: false
4647
experimental: false

‎docs/reference/model.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,24 @@ Docker Model Runner (EXPERIMENTAL)
55

66
### Subcommands
77

8-
| Name | Description |
9-
|:------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------|
10-
| [`df`](model_df.md) | Show Docker Model Runner disk usage |
11-
| [`inspect`](model_inspect.md) | Display detailed information on one model |
12-
| [`install-runner`](model_install-runner.md) | Install Docker Model Runner (Docker Engine only) |
13-
| [`list`](model_list.md) | List the models pulled to your local environment |
14-
| [`logs`](model_logs.md) | Fetch the Docker Model Runner logs |
15-
| [`package`](model_package.md) | Package a GGUF file into a Docker model OCI artifact, with optional licenses, and pushes it to the specified registry |
16-
| [`ps`](model_ps.md) | List running models |
17-
| [`pull`](model_pull.md) | Pull a model from Docker Hub or HuggingFace to your local environment |
18-
| [`push`](model_push.md) | Push a model to Docker Hub |
19-
| [`rm`](model_rm.md) | Remove local models downloaded from Docker Hub |
20-
| [`run`](model_run.md) | Run a model and interact with it using a submitted prompt or chat mode |
21-
| [`status`](model_status.md) | Check if the Docker Model Runner is running |
22-
| [`tag`](model_tag.md) | Tag a model |
23-
| [`uninstall-runner`](model_uninstall-runner.md) | Uninstall Docker Model Runner |
24-
| [`unload`](model_unload.md) | Unload running models |
25-
| [`version`](model_version.md) | Show the Docker Model Runner version |
8+
| Name | Description |
9+
|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------|
10+
| [`df`](model_df.md) | Show Docker Model Runner disk usage |
11+
| [`inspect`](model_inspect.md) | Display detailed information on one model |
12+
| [`install-runner`](model_install-runner.md) | Install Docker Model Runner (Docker Engine only) |
13+
| [`list`](model_list.md) | List the models pulled to your local environment |
14+
| [`logs`](model_logs.md) | Fetch the Docker Model Runner logs |
15+
| [`package`](model_package.md) | Package a GGUF file into a Docker model OCI artifact, with optional licenses. The package is sent to the model-runner, unless --push is specified |
16+
| [`ps`](model_ps.md) | List running models |
17+
| [`pull`](model_pull.md) | Pull a model from Docker Hub or HuggingFace to your local environment |
18+
| [`push`](model_push.md) | Push a model to Docker Hub |
19+
| [`rm`](model_rm.md) | Remove local models downloaded from Docker Hub |
20+
| [`run`](model_run.md) | Run a model and interact with it using a submitted prompt or chat mode |
21+
| [`status`](model_status.md) | Check if the Docker Model Runner is running |
22+
| [`tag`](model_tag.md) | Tag a model |
23+
| [`uninstall-runner`](model_uninstall-runner.md) | Uninstall Docker Model Runner |
24+
| [`unload`](model_unload.md) | Unload running models |
25+
| [`version`](model_version.md) | Show the Docker Model Runner version |
2626

2727

2828

‎docs/reference/model_package.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# docker model package
22

33
<!---MARKER_GEN_START-->
4-
Package a GGUF file into a Docker model OCI artifact, with optional licenses, and pushes it to the specified registry
4+
Package a GGUF file into a Docker model OCI artifact, with optional licenses. The package is sent to the model-runner, unless --push is specified
55

66
### Options
77

8-
| Name | Type | Default | Description |
9-
|:------------------|:--------------|:--------|:--------------------------------------|
10-
| `--context-size` | `uint64` | `0` | context size in tokens |
11-
| `--gguf` | `string` | | absolute path to gguf file (required) |
12-
| `-l`, `--license` | `stringArray` | | absolute path to a license file |
13-
| `--push` | `bool` | | push to registry (required) |
8+
| Name | Type | Default | Description |
9+
|:------------------|:--------------|:--------|:---------------------------------------------------------------------------------------|
10+
| `--context-size` | `uint64` | `0` | context size in tokens |
11+
| `--gguf` | `string` | | absolute path to gguf file (required) |
12+
| `-l`, `--license` | `stringArray` | | absolute path to a license file |
13+
| `--push` | `bool` | | push to registry (if not set, the model is loaded into the Model Runner content store. |
1414

1515

1616
<!---MARKER_GEN_END-->

0 commit comments

Comments
 (0)