Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions training/api-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,29 @@ https://api.training.wandb.ai/v1

### models

- **[POST /v1/preview/models](https://docs.wandb.ai/training/api-reference/models/create-model-v1-preview-models)** - Create Model
- **[DELETE /v1/preview/models/{model_id}](https://docs.wandb.ai/training/api-reference/models/delete-model-v1-preview-models--model-id-)** - Delete Model
- **[DELETE /v1/preview/models/{model_id}/checkpoints](https://docs.wandb.ai/training/api-reference/models/delete-model-checkpoints-v1-preview-models--model-id--checkpoints)** - Delete Model Checkpoints
- **[GET /v1/preview/models/{model_id}/checkpoints](https://docs.wandb.ai/training/api-reference/models/list-model-checkpoints-v1-preview-models--model-id--checkpoints)** - List Model Checkpoints
- **[POST /v1/preview/models/{model_id}/log](https://docs.wandb.ai/training/api-reference/models/log-v1-preview-models--model-id--log)** - Log

### training-jobs

- **[POST /v1/preview/training-jobs](https://docs.wandb.ai/training/api-reference/training-jobs/create-training-job-v1-preview-training-jobs)** - Create Training Job
- **[GET /v1/preview/training-jobs/{training_job_id}](https://docs.wandb.ai/training/api-reference/training-jobs/get-training-job-v1-preview-training-jobs--training-job-id-)** - Get Training Job
- **[GET /v1/preview/training-jobs/{training_job_id}/events](https://docs.wandb.ai/training/api-reference/training-jobs/get-training-job-events-v1-preview-training-jobs--training-job-id--events)** - Get Training Job Events

### Uncategorized

- **[GET /v1/health](https://docs.wandb.ai/training/api-reference/uncategorized/health-check-v1-health)** - Health Check
- **[GET /v1/system-check](https://docs.wandb.ai/training/api-reference/uncategorized/system-check-v1-system-check)** - System Check
### chat-completions

- **[POST /v1/chat/completions](https://docs.wandb.ai/training/api-reference/chat-completions/create-chat-completion-v1-chat-completions)** - Create Chat Completion
- **[POST /v1/chat/completions/](https://docs.wandb.ai/training/api-reference/chat-completions/create-chat-completion-v1-chat-completions-)** - Create Chat Completion

### models

- **[POST /v1/preview/models](https://docs.wandb.ai/training/api-reference/models/create-model-v1-preview-models)** - Create Model
- **[DELETE /v1/preview/models/{model_id}/checkpoints](https://docs.wandb.ai/training/api-reference/models/delete-model-checkpoints-v1-preview-models--model-id--checkpoints)** - Delete Model Checkpoints
- **[GET /v1/preview/models/{model_id}/checkpoints](https://docs.wandb.ai/training/api-reference/models/list-model-checkpoints-v1-preview-models--model-id--checkpoints)** - List Model Checkpoints
Expand Down
73 changes: 73 additions & 0 deletions training/api-reference/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,54 @@
}
}
},
"/v1/preview/models/{model_id}": {
"delete": {
"tags": [
"models"
],
"summary": "Delete Model",
"description": "Delete a model, all its checkpoints, artifacts, and the associated W&B run.",
"operationId": "delete_model_v1_preview_models__model_id__delete",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Model Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteModelResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/preview/models/{model_id}/log": {
"post": {
"tags": [
Expand Down Expand Up @@ -2676,6 +2724,31 @@
"title": "DeleteCheckpointsResponse",
"description": "Schema for delete checkpoints response."
},
"DeleteModelResponse": {
"properties": {
"model_id": {
"type": "string",
"format": "uuid",
"title": "Model Id"
},
"deleted_checkpoints": {
"type": "integer",
"title": "Deleted Checkpoints"
},
"deleted_run": {
"type": "boolean",
"title": "Deleted Run"
}
},
"type": "object",
"required": [
"model_id",
"deleted_checkpoints",
"deleted_run"
],
"title": "DeleteModelResponse",
"description": "Schema for delete model response."
},
"ExperimentalTrainingConfig": {
"properties": {
"learning_rate": {
Expand Down