Skip to content

Update Training API documentation #2175

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 #2175

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: 2 additions & 2 deletions training/api-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ https://api.training.wandb.ai/v1

### training-jobs

- **[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
- **[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
11 changes: 6 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 RL 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 @@ -445,9 +446,9 @@
"tags": [
"training-jobs"
],
"summary": "Create SFT Training Job",
"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",
"operationId": "Create_SFT_Training_Job_v1_preview_sft_training_jobs_post",
"requestBody": {
"content": {
"application/json": {
Expand Down Expand Up @@ -4610,4 +4611,4 @@
}
}
}
}
}