Skip to main content
Version: v1.4.1

Runs

Track training runs and experiments.

All methods are accessed via client.runs.

create_run()

POST/v1/runs

Create a new training run.

Parameters

team_idstrRequired
Team ID for the run
user_idstrRequired
User ID who owns the run
run_idstrdefault: None
Optional run ID (will be generated if not provided)
model_idstrdefault: None
Optional associated model ID
namestrdefault: None
Optional run name
metadataDictdefault: None
Optional metadata dictionary

Returns

str — The run ID (either provided or newly generated)

Example

1result = client.runs.create_run(
2 team_id="team_abc123",
3 user_id="user_abc123",
4 run_id="run_abc123",
5 model_id="model_abc123",
6 name="My Resource",
7 metadata="..."
8)

get_run()

GET/v1/runs/{run_id}

Get run details by ID.

Parameters

run_idstrRequired
The run ID

Returns

Dict — Run details dictionary

Example

1result = client.runs.get_run(
2 run_id="run_abc123"
3)