Skip to content

Commit 10e7454

Browse files
authored
Merge pull request #67 from doringeman/fix-docs
Fix docs
2 parents f7fd3d9 + 67b0ef1 commit 10e7454

File tree

8 files changed

+99
-0
lines changed

8 files changed

+99
-0
lines changed

docs/reference/docker_model.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,38 @@ long: Docker Model Runner
44
pname: docker
55
plink: docker.yaml
66
cname:
7+
- docker model df
78
- docker model inspect
89
- docker model install-runner
910
- docker model list
1011
- docker model logs
1112
- docker model package
13+
- docker model ps
1214
- docker model pull
1315
- docker model push
1416
- docker model rm
1517
- docker model run
1618
- docker model status
1719
- docker model tag
1820
- docker model uninstall-runner
21+
- docker model unload
1922
- docker model version
2023
clink:
24+
- docker_model_df.yaml
2125
- docker_model_inspect.yaml
2226
- docker_model_install-runner.yaml
2327
- docker_model_list.yaml
2428
- docker_model_logs.yaml
2529
- docker_model_package.yaml
30+
- docker_model_ps.yaml
2631
- docker_model_pull.yaml
2732
- docker_model_push.yaml
2833
- docker_model_rm.yaml
2934
- docker_model_run.yaml
3035
- docker_model_status.yaml
3136
- docker_model_tag.yaml
3237
- docker_model_uninstall-runner.yaml
38+
- docker_model_unload.yaml
3339
- docker_model_version.yaml
3440
deprecated: false
3541
hidden: false

docs/reference/docker_model_df.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
command: docker model df
2+
short: Show Docker Model Runner disk usage
3+
long: Show Docker Model Runner disk usage
4+
usage: docker model df
5+
pname: docker model
6+
plink: docker_model.yaml
7+
deprecated: false
8+
hidden: false
9+
experimental: false
10+
experimentalcli: true
11+
kubernetes: false
12+
swarm: false
13+

docs/reference/docker_model_ps.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
command: docker model ps
2+
short: List running models
3+
long: List running models
4+
usage: docker model ps
5+
pname: docker model
6+
plink: docker_model.yaml
7+
deprecated: false
8+
hidden: false
9+
experimental: false
10+
experimentalcli: true
11+
kubernetes: false
12+
swarm: false
13+
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
command: docker model unload
2+
short: Unload running models
3+
long: Unload running models
4+
usage: docker model unload (MODEL [--backend BACKEND] | --all)
5+
pname: docker model
6+
plink: docker_model.yaml
7+
options:
8+
- option: all
9+
value_type: bool
10+
default_value: "false"
11+
description: Unload all running models
12+
deprecated: false
13+
hidden: false
14+
experimental: false
15+
experimentalcli: false
16+
kubernetes: false
17+
swarm: false
18+
- option: backend
19+
value_type: string
20+
description: Optional backend to target
21+
deprecated: false
22+
hidden: false
23+
experimental: false
24+
experimentalcli: false
25+
kubernetes: false
26+
swarm: false
27+
deprecated: false
28+
hidden: false
29+
experimental: false
30+
experimentalcli: true
31+
kubernetes: false
32+
swarm: false
33+

docs/reference/model.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,21 @@ Docker Model Runner (EXPERIMENTAL)
77

88
| Name | Description |
99
|:------------------------------------------------|:-----------------------------------------------------------------------|
10+
| [`df`](model_df.md) | Show Docker Model Runner disk usage |
1011
| [`inspect`](model_inspect.md) | Display detailed information on one model |
1112
| [`install-runner`](model_install-runner.md) | Install Docker Model Runner |
1213
| [`list`](model_list.md) | List the available models that can be run with the Docker Model Runner |
1314
| [`logs`](model_logs.md) | Fetch the Docker Model Runner logs |
1415
| [`package`](model_package.md) | package a model |
16+
| [`ps`](model_ps.md) | List running models |
1517
| [`pull`](model_pull.md) | Download a model |
1618
| [`push`](model_push.md) | Upload a model |
1719
| [`rm`](model_rm.md) | Remove models downloaded from Docker Hub |
1820
| [`run`](model_run.md) | Run a model with the Docker Model Runner |
1921
| [`status`](model_status.md) | Check if the Docker Model Runner is running |
2022
| [`tag`](model_tag.md) | Tag a model |
2123
| [`uninstall-runner`](model_uninstall-runner.md) | Uninstall Docker Model Runner |
24+
| [`unload`](model_unload.md) | Unload running models |
2225
| [`version`](model_version.md) | Show the Docker Model Runner version |
2326

2427

docs/reference/model_df.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# docker model df
2+
3+
<!---MARKER_GEN_START-->
4+
Show Docker Model Runner disk usage
5+
6+
7+
<!---MARKER_GEN_END-->
8+

docs/reference/model_ps.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# docker model ps
2+
3+
<!---MARKER_GEN_START-->
4+
List running models
5+
6+
7+
<!---MARKER_GEN_END-->
8+

docs/reference/model_unload.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# docker model unload
2+
3+
<!---MARKER_GEN_START-->
4+
Unload running models
5+
6+
### Options
7+
8+
| Name | Type | Default | Description |
9+
|:------------|:---------|:--------|:---------------------------|
10+
| `--all` | `bool` | | Unload all running models |
11+
| `--backend` | `string` | | Optional backend to target |
12+
13+
14+
<!---MARKER_GEN_END-->
15+

0 commit comments

Comments
 (0)