> ## Documentation Index > Fetch the complete documentation index at: https://docs.oumi.ai/llms.txt > Use this file to discover all available pages before exploring further. # MODELS > Launch training runs and manage trained models | Command | Description | | ------------------------------------------- | -------------------------------------------------------------- | | [`base-models get`](#base-models-get) | Show details of one supported base model by name. | | [`base-models list`](#base-models-list) | List the base models the platform can fine-tune. | | [`delete`](#delete) | Delete a model and all of its versions. | | [`download`](#download) | Download a model's weights to local disk. | | [`get`](#get) | Show details of one model by ID. | | [`hosted-models list`](#hosted-models-list) | List suggested hosted models for judges and dataset synthesis. | | [`import`](#import) | Import model weights from HuggingFace or a presigned URL. | | [`list`](#list) | List models in a project, optionally filtered and sorted. | | [`register`](#register) | Register an existing pretrained model without copying weights. | | [`train`](#train) | Train a model from a recipe and wait for the run to finish. | | [`update`](#update) | Update a model's display name. | *** ## BASE-MODELS GET Show details of one supported base model by name. ```bash theme={null} oumi-cli models base-models get [OPTIONS] {name} ``` **Arguments** | Argument | Type | Required | Description | | -------- | ---- | -------- | ------------------------------------------------------------- | | `NAME` | str | ✓ | Base model name, exact match (see `models base-models list`). | **Options** | Option | Type | Required | Description | | ----------- | ---- | -------- | ----------------------------------------------------------------------------------------- | | `--project` | str | | Project to scope the operation to; falls back to OUMI\_PROJECT\_ID or the active profile. | *** ## BASE-MODELS LIST List the base models the platform can fine-tune. ```bash theme={null} oumi-cli models base-models list [OPTIONS] ``` **Options** | Option | Type | Required | Description | | ------------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ | | `--project` | str | | Project to scope the operation to; falls back to OUMI\_PROJECT\_ID or the active profile. | | `--limit` | int 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` | int range | | Hard safety cap on rows fetched, in any mode (default 10000). | *** ## DELETE Delete a model and all of its versions. ```bash theme={null} oumi-cli models delete [OPTIONS] {model_id} ``` **Arguments** | Argument | Type | Required | Description | | ---------- | ---- | -------- | ------------------------------------ | | `MODEL_ID` | int | ✓ | ID of the model (see `models list`). | **Options** | Option | Type | Required | Description | | ----------- | ---- | -------- | ----------------------------------------------------------------------------------------- | | `--project` | str | | Project to scope the operation to; falls back to OUMI\_PROJECT\_ID or the active profile. | | `--force` | flag | | Delete without confirmation prompt. | | `--yes` | flag | | Delete without confirmation prompt (alias for `--force`). | *** ## DOWNLOAD Download a model's weights to local disk. ```bash theme={null} oumi-cli models download [OPTIONS] {model_id} ``` **Arguments** | Argument | Type | Required | Description | | ---------- | ---- | -------- | ------------------------------------------------ | | `MODEL_ID` | int | ✓ | ID of the model to download (see `models list`). | **Options** | Option | Type | Required | Description | | ----------------- | ---- | -------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `--project` | str | | Project that owns the model; falls back to OUMI\_PROJECT\_ID or the active profile. | | `--model-version` | int | | 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-\-\.\ in the current directory. | | `--expiration` | int | | Lifetime of the download's presigned URL, in seconds (default 3600). | *** ## GET Show details of one model by ID. ```bash theme={null} oumi-cli models get [OPTIONS] {model_id} ``` **Arguments** | Argument | Type | Required | Description | | ---------- | ---- | -------- | ------------------------------------ | | `MODEL_ID` | int | ✓ | ID of the model (see `models list`). | **Options** | Option | Type | Required | Description | | ----------- | ---- | -------- | ----------------------------------------------------------------------------------------- | | `--project` | str | | Project to scope the operation to; falls back to OUMI\_PROJECT\_ID or the active profile. | *** ## HOSTED-MODELS LIST List suggested hosted models for judges and dataset synthesis. ```bash theme={null} oumi-cli models hosted-models list [OPTIONS] ``` **Options** | Option | Type | Required | Description | | -------------------------------------------------- | --------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- | | `--project` | str | | Project to scope the operation to; falls back to OUMI\_PROJECT\_ID or the active profile. | | `--limit` | int 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` | int 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. ```bash theme={null} oumi-cli models import [OPTIONS] ``` **Options** | Option | Type | Required | Description | | ---------------------- | ---- | -------- | ----------------------------------------------------------------------------------------------- | | `--name` | str | ✓ | Display name for the imported model. | | `--hf-repo` | str | | HuggingFace repo to copy weights from (e.g. 'org/model'). Mutually exclusive with `--url`. | | `--url` | str | | Presigned URL to copy weights from. Mutually exclusive with `--hf-repo`. | | `--base-model` | str | | Base model the weights derive from (see `models base-models list`). | | `--project` | str | | Project to scope the operation to; 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 models in a project, optionally filtered and sorted. ```bash theme={null} oumi-cli models list [OPTIONS] ``` **Options** | Option | Type | Required | Description | | ------------------ | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------ | | `--project` | str | | Project to scope the operation to; falls back to OUMI\_PROJECT\_ID or the active profile. | | `--limit` | int range | | Return at most N models (default 100). The CLI fetches and loops over pages internally; you never pass a page token. | | `--all` | flag | | Return every model, looping until the cursor is exhausted (bounded by `--max-items`). Mutually exclusive with `--limit`. | | `--max-items` | int range | | Hard safety cap for `--all` (default 10000). | | `--search` | str | | 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. ```bash theme={null} oumi-cli models register [OPTIONS] ``` **Options** | Option | Type | Required | Description | | -------------- | ---- | -------- | ------------------------------------------------------------------------------------------ | | `--name` | str | ✓ | Display name for the registered model. | | `--pretrained` | str | ✓ | Existing HuggingFace baseline to register by name (e.g. 'org/model'), with no weight copy. | | `--project` | str | | Project to scope the operation to; falls back to OUMI\_PROJECT\_ID or the active profile. | *** ## TRAIN Train a model from a recipe and wait for the run to finish. ```bash theme={null} oumi-cli models train [OPTIONS] ``` **Options** | Option | Type | Required | Description | | ---------------------- | ---- | -------- | -------------------------------------------------------------------------------------------------------- | | `--name` | str | ✓ | Display name for the trained model. | | `--recipe`, `-r` | str | | Recipe ID (integer) or path to a JSON recipe file. | | `--project` | str | | Project to scope the operation to; 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. | *** ## UPDATE Update a model's display name. ```bash theme={null} oumi-cli models update [OPTIONS] {model_id} ``` **Arguments** | Argument | Type | Required | Description | | ---------- | ---- | -------- | ------------------------------------ | | `MODEL_ID` | int | ✓ | ID of the model (see `models list`). | **Options** | Option | Type | Required | Description | | ---------------- | ---- | -------- | ----------------------------------------------------------------------------------------- | | `--project` | str | | Project to scope the operation to; falls back to OUMI\_PROJECT\_ID or the active profile. | | `--display-name` | str | | New display name for the model. | ***