> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tuneplane.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# tp model

> A named version line that outlives the run that produced it.

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
tp model register alice/support-agent --run run-4f2a91 --notes "kl 0.01, 500 steps"
tp model promote alice/support-agent 3
tp model ls
```

A run id is a fact about an experiment. A model version is a decision: this is the one we are
willing to serve. The walkthrough is
[registering and promoting a model](https://docs.tuneplane.ai/en/guides/model-registry.md).

Version numbers increment on their own — there is no flag to pick one.

## Worked examples

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
tp model register alice/support-agent --run run-4f2a91 --notes "new data mix"
tp model register alice/support-agent --path /shared/models/qwen-base \
  --notes "base model" --desc "Customer support assistant"

tp model ls                                  # every model, and which version each runs
tp model ls alice/support-agent              # the full version line
tp model promote alice/support-agent 3       # model and version are two arguments
tp model archive alice/support-agent 2
tp model card alice/support-agent 3          # the acceptance card
tp model card alice/support-agent 3 --export card.md
```

Promoting archives the previous production version. There is exactly one production version at a
time.

`--desc` is the model's description and belongs on the first registration. `--notes` is
per-version.

## `tp model`

Manage the model registry

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
tp model <subcommand>
```

| Command | Description |
| - | - |
| `tp model archive` | Archive one version |
| `tp model card` | Show or export the acceptance card |
| `tp model ls` | List models and their versions |
| `tp model promote` | Promote one version to production |
| `tp model register` | Record a run's artifact as a version |

### `tp model archive`

Archive one version

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
tp model archive <MODEL> <VERSION>
```

| Argument | Description |
| - | - |
| `MODEL` | Model id (\<owner>/\<name>) (**required**) |
| `VERSION` | Version number (**required**) |

No options beyond `--help`.

### `tp model card`

Show or export the acceptance card

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
tp model card <MODEL> <VERSION> [options]
```

| Argument | Description |
| - | - |
| `MODEL` | Model id (\<owner>/\<name>) (**required**) |
| `VERSION` | Version number (**required**) |

| Option | Description |
| - | - |
| `--export` | Write the card as Markdown to this path |

### `tp model ls`

List models and their versions

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
tp model ls [MODEL]
```

| Argument | Description |
| - | - |
| `MODEL` | Model id (\<owner>/\<name>); omit to list them all |

No options beyond `--help`.

### `tp model promote`

Promote one version to production

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
tp model promote <MODEL> <VERSION>
```

| Argument | Description |
| - | - |
| `MODEL` | Model id (\<owner>/\<name>) (**required**) |
| `VERSION` | Version number (**required**) |

No options beyond `--help`.

### `tp model register`

Record a run's artifact as a version

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
tp model register <MODEL> [options]
```

| Argument | Description |
| - | - |
| `MODEL` | Model name (lands in your own namespace) or a full \<owner>/\<name> (**required**) |

| Option | Description |
| - | - |
| `--run`, `-r` | Register from this run's hf\_export artifact |
| `--path` | Record a weights path directly (a base model, external weights) |
| `--notes`, `-n` | What changed in this version |
| `--desc` | Model description (write it on the first registration) |
| `--project` | Release project key for external weights, e.g. @alice/assistant; inferred for a training run |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.