Skip to content

Update Training API documentation #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update Training API documentation #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion training/api-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ https://api.training.wandb.ai/v1
### chat-completions

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

### models

Expand All @@ -40,7 +41,8 @@ https://api.training.wandb.ai/v1

### training-jobs

- **[POST /v1/preview/training-jobs](https://docs.wandb.ai/training/api-reference/training-jobs/create-training-job)** - Create Training Job
- **[POST /v1/preview/sft-training-jobs](https://docs.wandb.ai/training/api-reference/training-jobs/create-sft-training-job)** - Create Sft Training Job
- **[POST /v1/preview/training-jobs](https://docs.wandb.ai/training/api-reference/training-jobs/create-rl-training-job)** - Create Rl Training Job
- **[GET /v1/preview/training-jobs/{training_job_id}](https://docs.wandb.ai/training/api-reference/training-jobs/get-training-job)** - 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)** - Get Training Job Events

Expand Down
180 changes: 175 additions & 5 deletions training/api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,8 +399,9 @@
"tags": [
"training-jobs"
],
"summary": "Create Training Job",
"operationId": "create_training_job_v1_preview_training_jobs_post",
"summary": "Create Rl Training Job",
"description": "Create a new RL (Reinforcement Learning) training job.",
"operationId": "Create_RL_Training_Job_v1_preview_training_jobs_post",
"requestBody": {
"content": {
"application/json": {
Expand Down Expand Up @@ -440,6 +441,53 @@
]
}
},
"/v1/preview/sft-training-jobs": {
"post": {
"tags": [
"training-jobs"
],
"summary": "Create Sft Training Job",
"description": "Create a new SFT (Supervised Fine-Tuning) training job.",
"operationId": "Create_SFT_Training_Job_v1_preview_sft_training_jobs_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSFTTrainingJob"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrainingJobResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/v1/preview/training-jobs/{training_job_id}": {
"get": {
"tags": [
Expand Down Expand Up @@ -563,6 +611,9 @@
},
"/v1/health": {
"get": {
"tags": [
"health"
],
"summary": "Health Check",
"operationId": "health_check_v1_health_get",
"responses": {
Expand All @@ -579,6 +630,9 @@
},
"/v1/system-check": {
"get": {
"tags": [
"health"
],
"summary": "System Check",
"description": "Check health of all system components.\n\nReturns:\n JSON with status of:\n - api: Always true (if endpoint is reachable)\n - database: Whether DB connection works\n - cpu_queue: Success, duration, and any errors\n - gpu_queue: Success, duration, and any errors\n\nReturns HTTP 503 if any checks fail.",
"operationId": "system_check_v1_system_check_get",
Expand Down Expand Up @@ -1833,6 +1887,7 @@
"anyOf": [
{
"type": "integer",
"maximum": 9.223372036854776e+18,
"minimum": -1.0
},
{
Expand Down Expand Up @@ -2665,6 +2720,49 @@
"type": "object",
"title": "Content"
},
"CreateSFTTrainingJob": {
"properties": {
"model_id": {
"type": "string",
"format": "uuid",
"title": "Model Id"
},
"training_data_url": {
"type": "string",
"title": "Training Data Url",
"description": "W&B artifact path for training data (e.g., 'wandb-artifact:///entity/project/artifact-name:version')"
},
"config": {
"anyOf": [
{
"$ref": "#/components/schemas/SFTTrainingConfig"
},
{
"type": "null"
}
]
},
"experimental_config": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Experimental Config"
}
},
"type": "object",
"required": [
"model_id",
"training_data_url"
],
"title": "CreateSFTTrainingJob",
"description": "Schema for creating a new SFT (Supervised Fine-Tuning) TrainingJob.\n\nThe client should upload the training data (trajectories.jsonl and metadata.json)\nto W&B Artifacts and provide the artifact URL."
},
"CreateTrainingJob": {
"properties": {
"model_id": {
Expand Down Expand Up @@ -3728,6 +3826,17 @@
"base_model": {
"type": "string",
"title": "Base Model"
},
"run_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Run Id"
}
},
"type": "object",
Expand Down Expand Up @@ -3882,6 +3991,45 @@
"title": "Role",
"description": "The role of a message author (mirrors ``chat::Role``)."
},
"SFTTrainingConfig": {
"properties": {
"batch_size": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string",
"const": "auto"
},
{
"type": "null"
}
],
"title": "Batch Size"
},
"learning_rate": {
"anyOf": [
{
"type": "number"
},
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Learning Rate"
}
},
"type": "object",
"title": "SFTTrainingConfig",
"description": "Schema for SFT training config."
},
"StreamOptions": {
"properties": {
"include_usage": {
Expand Down Expand Up @@ -4215,7 +4363,30 @@
},
"reward": {
"type": "number",
"title": "Reward"
"title": "Reward",
"default": 0.0
},
"initial_policy_version": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Initial Policy Version"
},
"final_policy_version": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Final Policy Version"
},
"metrics": {
"additionalProperties": {
Expand Down Expand Up @@ -4293,8 +4464,7 @@
},
"type": "object",
"required": [
"messages_and_choices",
"reward"
"messages_and_choices"
],
"title": "Trajectory"
},
Expand Down