TrainingRun

"# TrainingRun\n\n```python\nfrom modal_training_gym.common.run import TrainingRun\n```\n\nA launched training run that can be inspected, awaited, or loaded by ID.\n\n**Attributes**\n\n<div class=\"tg-param\">\n<p><strong>training_run_id</strong> <code>str</code></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>modal_app_id</strong> <code>str</code></p>\n<p><span class=\"tg-param-default\">Default: \"\"</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>modal_app_url</strong> <code>str</code></p>\n<p><span class=\"tg-param-default\">Default: \"\"</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>framework</strong> <code>Framework</code></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>config</strong> <code>Any</code></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>dataset_id</strong> <code>str</code></p>\n<p><span class=\"tg-param-default\">Default: \"\"</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>deployment_id</strong> <code>str</code></p>\n<p><span class=\"tg-param-default\">Default: \"\"</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>status</strong> <code>TrainingRunStatus</code></p>\n<p><span class=\"tg-param-default\">Default: running</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>framework_status</strong> <code>SlimeStatus | MilesStatus | None</code></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>created_at</strong> <code>int</code></p>\n<p><span class=\"tg-param-default\">Default: 0</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>started_at</strong> <code>int</code></p>\n<p><span class=\"tg-param-default\">Default: 0</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>ended_at</strong> <code>int | None</code></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>completed_at</strong> <code>int | None</code></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>updated_at</strong> <code>int</code></p>\n<p><span class=\"tg-param-default\">Default: 0</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>duration_seconds</strong> <code>int | None</code></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>step_times</strong> <code>dict[str, dict[str, int | None]] | None</code></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>substep_times</strong> <code>dict[str, dict[str, dict[str, float | int | bool | None]]] | None</code></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>error_message</strong> <code>str | None</code></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>metadata</strong> <code>dict[str, Any] | None</code></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>function_call_id</strong> <code>str</code></p>\n<p><span class=\"tg-param-default\">Default: \"\"</span></p>\n</div>\n\n## `apply_framework_status`\n\n```python\napply_framework_status(update: FrameworkStatusUpdate) -> FrameworkStatus | None\n```\n\nApply a framework status update without saving the run.\n\n**Returns**\n\nThe resolved status, or `None` for an invalid phase.\n\n## `from_id`\n\n```python\nfrom_id(run_id: str, *, is_async: bool = False) -> TrainingRun | Awaitable[TrainingRun]\n```\n\n## `from_stored_data`\n\n```python\nfrom_stored_data(data: object) -> TrainingRun\n```\n\nBuild a run from persisted data and snapshot its metadata keys.\n\n## `function_call`\n\n```python\nfunction_call: Any\n```\n\n## `group_id`\n\n```python\ngroup_id: str | None\n```\n\nThe sweep ID stored in `metadata`.\n\n## `record_latest_rollout`\n\n```python\nrecord_latest_rollout(rollout: TrainingRolloutResult) -> None\n```\n\nStore the saved rollout summary in this run's metadata.\n\n## `result`\n\n```python\nresult(*, timeout: float | None = None, stop_app_on_success: bool = True) -> TrainResult\n```\n\nWait for this training run to finish.\n\n**Parameters**\n\n<div class=\"tg-param\">\n<p><strong>timeout</strong> <code>float | None</code></p>\n<p>Maximum number of seconds to wait.</p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>stop_app_on_success</strong> <code>bool</code></p>\n<p>Stop the Modal app after successful training. <span class=\"tg-param-default\">Default: True</span></p>\n</div>\n\n**Returns**\n\nThe completed training result.\n\n## `save`\n\n```python\nsave(*, is_async: bool = False) -> None | Awaitable[None]\n```\n"

from modal_training_gym.common.run import TrainingRun

A launched training run that can be inspected, awaited, or loaded by ID.

Attributes

training_run_id str

modal_app_id str

Default: ""

modal_app_url str

Default: ""

framework Framework

config Any

dataset_id str

Default: ""

deployment_id str

Default: ""

status TrainingRunStatus

Default: running

framework_status SlimeStatus | MilesStatus | None

created_at int

Default: 0

started_at int

Default: 0

ended_at int | None

completed_at int | None

updated_at int

Default: 0

duration_seconds int | None

step_times dict[str, dict[str, int | None]] | None

substep_times dict[str, dict[str, dict[str, float | int | bool | None]]] | None

error_message str | None

metadata dict[str, Any] | None

function_call_id str

Default: ""

`apply_framework_status`

apply_framework_status(update: FrameworkStatusUpdate) -> FrameworkStatus | None

Apply a framework status update without saving the run.

Returns

The resolved status, or None for an invalid phase.

`from_id`

from_id(run_id: str, *, is_async: bool = False) -> TrainingRun | Awaitable[TrainingRun]

`from_stored_data`

from_stored_data(data: object) -> TrainingRun

Build a run from persisted data and snapshot its metadata keys.

`function_call`

function_call: Any

`group_id`

group_id: str | None

The sweep ID stored in metadata.

`record_latest_rollout`

record_latest_rollout(rollout: TrainingRolloutResult) -> None

Store the saved rollout summary in this run’s metadata.

`result`

result(*, timeout: float | None = None, stop_app_on_success: bool = True) -> TrainResult

Wait for this training run to finish.

Parameters

timeout float | None

Maximum number of seconds to wait.

stop_app_on_success bool

Stop the Modal app after successful training. Default: True

Returns

The completed training result.

`save`

save(*, is_async: bool = False) -> None | Awaitable[None]