| Command | Description |
|---|---|
base-models get | Show details of one supported base model by name. |
base-models list | List the base models the platform can fine-tune. |
delete | Permanently delete a model and all of its versions. |
download | Download a model’s weights to local disk. |
get | Show details of one model by ID. |
hosted-models list | List the hosted models suggested as judges and synthesis generators. |
import | Import model weights from HuggingFace or a presigned URL. |
list | List the models a project owns, trained, imported, or registered. |
register | Register an existing pretrained model without copying weights. |
supported-inference-models list | List the models you can send inference requests to, by oumi canonical name. |
train | Train a new model from a recipe; long-running, waits for the run by default. |
update | Update a model’s display name. |
versions get | Show a single version of a model, including its full config. |
versions list | List version history for one model, newest first by default. |
BASE-MODELS GET
Show details of one supported base model by name.oumi-cli models base-models get [OPTIONS] NAME
| Argument | Type | Required | Description |
|---|---|---|---|
NAME | text | ✓ | Base model name, exact match (see models base-models list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project to look up the base model in; falls back to OUMI_PROJECT_ID or the active profile. |
BASE-MODELS LIST
List the base models the platform can fine-tune.oumi-cli models base-models list [OPTIONS]
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project to list base models from; falls back to OUMI_PROJECT_ID or the active profile. | |
--limit | integer range | Return at most N base models (default 100). The server returns the full catalog in one response, so this is a client-side cap. | |
--all | flag | Return every base model (bounded by --max-items). Mutually exclusive with --limit. | |
--max-items | integer range | Hard safety cap on rows fetched, in any mode (default 10000). |
DELETE
Permanently delete a model and all of its versions.oumi-cli models delete [OPTIONS] MODEL_ID
| Argument | Type | Required | Description |
|---|---|---|---|
MODEL_ID | integer | ✓ | ID of the model (see oumi-cli models list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the model; falls back to OUMI_PROJECT_ID or the active profile. | |
--force | flag | Skip the confirmation prompt. Without a TTY or under --no-input, this (or --yes) is required; otherwise the command exits 2 without changing anything. | |
--yes | flag | Same as --force. |
DOWNLOAD
Download a model’s weights to local disk.oumi-cli models download [OPTIONS] MODEL_ID
| Argument | Type | Required | Description |
|---|---|---|---|
MODEL_ID | integer | ✓ | ID of the model to download (see oumi-cli models list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the model; falls back to OUMI_PROJECT_ID or the active profile. | |
--model-version | integer | Version ID to download. Defaults to the latest version. (Named --model-version to avoid colliding with the global --version flag.) | |
--out | path | Destination file or directory. Defaults to ./model-<id>-<ver>.<ext> in the current directory. | |
--expiration | integer | Lifetime of the download’s presigned URL, in seconds (default 3600). |
GET
Show details of one model by ID.oumi-cli models get [OPTIONS] MODEL_ID
| Argument | Type | Required | Description |
|---|---|---|---|
MODEL_ID | integer | ✓ | ID of the model (see oumi-cli models list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the model; falls back to OUMI_PROJECT_ID or the active profile. |
HOSTED-MODELS LIST
List the hosted models suggested as judges and synthesis generators.oumi-cli models hosted-models list [OPTIONS]
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project to list hosted models from; falls back to OUMI_PROJECT_ID or the active profile. | |
--limit | integer range | Return at most N hosted models (default 100). The server returns the full catalog in one response, so this is a client-side cap. | |
--all | flag | Return every hosted model (bounded by --max-items). Mutually exclusive with --limit. | |
--max-items | integer range | Hard safety cap on rows fetched, in any mode (default 10000). | |
--include-gpu-models / --no-include-gpu-models | flag | Include GPU pretrained-baseline rows (isPretrained=true) alongside hosted API suggestions. |
IMPORT
Import model weights from HuggingFace or a presigned URL.oumi-cli models import [OPTIONS]
| Option | Type | Required | Description |
|---|---|---|---|
--name | text | ✓ | Display name for the imported model. |
--hf-repo | text | HuggingFace repo to copy weights from (e.g. ‘org/model’). Exactly one of --hf-repo or --url is required. | |
--url | text | Presigned URL to copy weights from. Exactly one of --hf-repo or --url is required. | |
--base-model | text | Base model the weights derive from (see models base-models list). Optional: omit it to have it detected from the imported weights. | |
--project | text | Project that owns the model; falls back to OUMI_PROJECT_ID or the active profile. | |
--wait / --no-wait | flag | Wait for the weight copy to finish (default); --no-wait returns the operation ID immediately. |
LIST
List the models a project owns, trained, imported, or registered.oumi-cli models list [OPTIONS]
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project to list models from; falls back to OUMI_PROJECT_ID or the active profile. | |
--limit | integer range | Maximum number of models to return (default 100). | |
--all | flag | Return all models, following pages until none are left (capped by --max-items). Cannot be combined with --limit. | |
--max-items | integer range | Cap on how many models --all returns (default 10000). | |
--search | text | Filter models by a free-text search over their display name. | |
--sort-by | choice | Field to sort by. One of: created_at, updated_at. | |
--sort-direction | choice | Sort order (asc is oldest-first). |
REGISTER
Register an existing pretrained model without copying weights.oumi-cli models register [OPTIONS]
| Option | Type | Required | Description |
|---|---|---|---|
--name | text | ✓ | Display name for the registered model. |
--pretrained | text | ✓ | Existing HuggingFace baseline to register by name (e.g. ‘org/model’), with no weight copy. |
--project | text | Project that owns the model; falls back to OUMI_PROJECT_ID or the active profile. |
SUPPORTED-INFERENCE-MODELS LIST
List the models you can send inference requests to, by oumi canonical name.oumi-cli models supported-inference-models list [OPTIONS]
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project to list inference models from; falls back to OUMI_PROJECT_ID or the active profile. | |
--limit | integer range | Return at most N inference models (default 100). The server returns the full catalog in one response, so this is a client-side cap. | |
--all | flag | Return every inference model (bounded by --max-items). Mutually exclusive with --limit. | |
--max-items | integer range | Hard safety cap on rows fetched, in any mode (default 10000). |
TRAIN
Train a new model from a recipe; long-running, waits for the run by default.oumi-cli models train [OPTIONS]
| Option | Type | Required | Description |
|---|---|---|---|
--name | text | ✓ | Display name for the trained model. |
--recipe, -r | text | Recipe ID (integer), or path to a JSON recipe file, read as a path when it ends in ‘.json’ or contains a ’/’. Prompted for on a TTY if omitted. Required when non-interactive. | |
--project | text | Project that owns the model; falls back to OUMI_PROJECT_ID or the active profile. | |
--wait / --no-wait | flag | Wait for the run to finish before returning (default); --no-wait returns the operation ID immediately, and oumi-cli operations wait <id> resumes waiting. |
UPDATE
Update a model’s display name.oumi-cli models update [OPTIONS] MODEL_ID
| Argument | Type | Required | Description |
|---|---|---|---|
MODEL_ID | integer | ✓ | ID of the model (see oumi-cli models list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the model; falls back to OUMI_PROJECT_ID or the active profile. | |
--display-name | text | New display name for the model. Required: the command exits 2 without it. |
VERSIONS GET
Show a single version of a model, including its full config.oumi-cli models versions get [OPTIONS] MODEL_ID VERSION_ID
| Argument | Type | Required | Description |
|---|---|---|---|
MODEL_ID | text | ✓ | ID of the model (see oumi-cli models list). |
VERSION_ID | integer | ✓ | ID of the version to inspect (see models versions list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the model; falls back to OUMI_PROJECT_ID or the active profile. |
VERSIONS LIST
List version history for one model, newest first by default.oumi-cli models versions list [OPTIONS] MODEL_ID
| Argument | Type | Required | Description |
|---|---|---|---|
MODEL_ID | text | ✓ | ID of the model (see oumi-cli models list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the model; falls back to OUMI_PROJECT_ID or the active profile. | |
--limit | integer range | Maximum number of versions to return (default 100). | |
--all | flag | Return all versions, following pages until none are left (capped by --max-items). Cannot be combined with --limit. | |
--max-items | integer range | Cap on how many versions --all returns (default 10000). | |
--sort-by | choice | Field to sort by. One of: created_at, updated_at, version_id. | |
--sort-direction | choice | Sort order (asc is oldest-first). |