Sign in
RL

Update a training session

Updates the display name or metadata associated with a training session. Omitted fields remain unchanged, and empty strings clear existing values.

patch/rl/training-sessions/{session_id}

Path parameters

session_idstring required

ID of the training session

Request body

display_namestring

Display name to update. An empty string clears the existing display name.

Example request

{
  "metadata": {
    "wandb": {
      "entity": "example-org",
      "project": "grpo-gsm8k",
      "group": "gsm8k-35b-sweep",
      "run_name": "exp2-thinking-4k-ctx",
      "run_id": "abc123",
      "url": "https://wandb.ai/example-org/example-project/runs/run-id"
    }
  }
}

Response

Updated training session details

idstring required

ID of the training session

display_namestring

Display name used to identify the training session

status'TRAINING_SESSION_STATUS_UNSPECIFIED' | 'TRAINING_SESSION_STATUS_CREATING' | 'TRAINING_SESSION_STATUS_RUNNING' | 'TRAINING_SESSION_STATUS_STOPPED' | 'TRAINING_SESSION_STATUS_STOPPING' | 'TRAINING_SESSION_STATUS_ERROR' | 'TRAINING_SESSION_STATUS_EXPIRED' required

Status of the training session

resume_from_checkpoint_idstring

Checkpoint ID this session was resumed from

created_atstring date-time required

Timestamp when the training session was created

updated_atstring date-time required

Timestamp when the training session was last updated

model_resources_idstring required

Model resource this session is attached to. The session runs on that resource's GPU pods.

base_modelstring required

Base model the session trains, taken from the model resource it is attached to

created_bystring required

ID of the user who created the training session

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "display_name": "gsm8k-experiment-2",
  "metadata": {
    "wandb": {
      "entity": "example-org",
      "project": "grpo-gsm8k",
      "group": "gsm8k-35b-sweep",
      "run_name": "exp2-thinking-4k-ctx",
      "run_id": "abc123",
      "url": "https://wandb.ai/example-org/example-project/runs/run-id"
    }
  },
  "error": {
    "message": "The session could not start because the selected resource has no available capacity.",
    "occurred_at": "2026-01-02T00:00:05Z"
  },
  "inference_checkpoints": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2026-01-02T00:00:00Z",
      "registration": {
        "model_name": "username/Meta-Llama-3-8B-rl-step-42-20260216",
        "registered_at": "2026-01-02T00:00:00Z"
      }
    }
  ],
  "training_checkpoints": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2026-01-02T00:00:00Z"
    }
  ],
  "resume_from_checkpoint_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-01-02T00:00:00Z",
  "updated_at": "2026-01-02T00:00:05Z",
  "lora_config": {
    "rank": 32,
    "alpha": 64,
    "train_unembed": true
  },
  "model_resources_id": "123e4567-e89b-12d3-a456-426614174000",
  "base_model": "Qwen/Qwen3-0.6B",
  "created_by": "user_123"
}

Changes

Changed in 4 of the 14 revisions of this API.9

  • 1fab430e87d65See the full diff
    • ○

      added the optional property inference_checkpoints/items/registration/adapter_object_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property inference_checkpoints/items/registration/adapter_object_revision_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property inference_checkpoints/items/registration/model_object_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property inference_checkpoints/items/registration/model_object_revision_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property training_checkpoints/items/registration to the response with the 200 status

      response-optional-property-added

  • 468edbdc879c1See the full diff
    • ○

      added the optional property lora_config/train_unembed to the response with the 200 status

      response-optional-property-added

  • f26a23fab8e02See the full diff
    • ○

      added the optional property lora_config/seed to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property base_model to the response with the 200 status

      response-required-property-added

  • ebd4756a41e41See the full diff
    • ○

      endpoint added

      endpoint-added