client.model_repos attribute or convenience methods.
list_model_repos
Lists model repositories with optional filtering. Run with SIMPLISMART_PG_TOKEN set as an environment variable (e.g. in .env).
ModelRepoListParams
| Parameter | Type | Description | Options |
|---|---|---|---|
offset | int | Pagination offset (default: 0) | ≥ 0 |
count | int | Page size (default: 5, max: 20) | 0-20 |
model_id | str | None | Filter by specific model repo UUID | - |
name | str | None | Filter by name (contains match) | - |
status | str | None | Filter by status | SUCCESS, FAILED, DELETED, PROGRESSING |
model_type | str | None | Filter by model type | - |
created_by | str | None | Filter by creator email | - |
get_model_repo
Gets a specific model repository by ID. Set MODEL_REPO_ID in env, or use a UUID from list_model_repos.
create_model_repo
Bring your own container-based models from Docker Hub, Depot or NVIDIA NGC registry. Use enviroment vars for credentials (e.g. SOURCE_SECRET_ID); do not hardcode secrets.
ModelRepoCreate
| Parameter | Type | Description | Required |
|---|---|---|---|
name | str | Model repo name (1-255 chars) | Yes |
source_type | str | Registry source type. Options: docker_hub, depot, nvidiadockersecret | Yes |
runtime_gpus | int | Number of GPUs (≥ 0; typically 0 or 1 for BYOM) | Yes |
source_secret | str | None | Secret UUID for registry authentication | Conditional* |
registry_path | str | None | Registry path/repo name (max 255) | Conditional* |
docker_tag | str | None | Image tag (max 255) | Conditional* |
env | dict | None | Environment variables | No |
healthcheck | dict | None | Health check configuration | No |
ports | dict | None | Port mappings | No |
metrics_path | list | None | List of metrics paths | No |
deployment_custom_configuration | dict | list | None | Custom deployment configuration | No |
source_type is docker_hub, depot, or nvidiadockersecret.
Source Type Options
| Value | Description |
|---|---|
docker_hub | Docker Hub registry |
depot | Depot registry |
nvidiadockersecret | NVIDIA NGC registry |
create_model_repo_private_compile
Creates a private compile model repository: the platform compiles the model from a source (e.g. Hugging Face) using your model config, optimisation config, and pipeline config.
ModelRepoCompileCreate
| Parameter | Type | Description | Required |
|---|---|---|---|
name | str | Model repo name | Yes |
source_type | str | Source type, e.g. huggingface | Yes |
source_url | str | Source path/URL (e.g. HF repo id) | Yes |
mode | str | Compilation mode (default: public_hf). e.g. public_hf, private_hf, aws, gcp, public_url, simplismart | Yes |
model_class | str | Model class (e.g. LlamaForCausalLM) | Yes |
accelerator_type | str | Accelerator type (e.g. nvidia-h100) | Yes |
org_id | str | None | Organization UUID (alias: org); optional if inferred from token | No |
accelerator_count | int | None | Accelerator count (default: 0) | No |
cloud_account | str | None | Cloud account UUID | No |
source_secret | str | None | Secret UUID for source access | No |
lora_secret | str | None | LoRA secret UUID | No |
model_config_data | dict | None | Model config JSON (alias: model_config); see below | No |
optimisation_config | dict | None | Optimisation config JSON (see below) | No |
pipeline_config | dict | None | Pipeline config JSON (see below) | No |
env | dict | None | Environment variables | No |
output_metadata | dict | None | Output metadata | No |
additional_details | dict | None | Additional details | No |
tags | dict | None | Tags object | No |
tasks | list | None | List of tasks | No |
model_family | str | None | Model family | No |
description | str | None | Description | No |
short_description | str | None | Short description | No |
dropdown_description | str | None | Dropdown description | No |
processing_mode | str | None | One of: SYNC, ASYNC, REALTIME_ASYNC | No |
machine_type | str | None | Machine type | No |
region | str | None | Region | No |
resource_group | str | None | Resource group | No |
use_simplismart_infrastructure | bool | None | Use Simplismart infrastructure | No |
Config files (private compile)
Example configs are in the SDK repo underexamples/private-compile-sample/:
model_config.json— Model architecture and tokenizer options (e.g.architectures,hidden_size,max_position_embeddings,torch_dtype). Must match the model you are compiling.
optimisation_config.json— Backend, warmups, and optimisations (e.g.quantization,tensor_parallel_size,optimisations.dit_optimisation,backend). Example
pipeline_config.json— Pipeline type and options (e.g.type,loras,quantized_model_path,enable_model_caching,mode).
For a datailed example, checkout this code snippet in Python: Full example: simplismart-python/examples/private-compile-sample/.