View on GitHub
"```python\nfrom modal_training_gym.common.training_group import TrainingGroup\n```\n\nA base `TrainConfig` plus a grid of field overrides to expand.\n\n## Constructor\n\n```python\nTrainingGroup(base, grid=None, name=None, merge_model_recipe=None)\n```\n\n| Parameter | Type | Default | Description |\n|-----------|------|---------|-------------|\n| `base` | `TrainConfig` | *required* | |\n| `grid` | `dict[str, list[Any]] \\| None` | `None` | |\n| `name` | `str \\| None` | `None` | |\n| `merge_model_recipe` | `bool \\| None` | `None` | |\n\n## Methods\n\n### `get_train_configs(self) -> 'list[TrainConfig]'`\n\nExpand the grid into validated, ready-to-run `TrainConfig`s.\n\n### `iter_variants(self) -> 'list[tuple[dict[str, Any], TrainConfig]]'`\n\nReturn `(overrides, config)` for each point in the grid.\n\n### `launch(self, *, continue_on_error: 'bool' = True, prepare_inputs: 'bool' = False) -> 'list[TrainingRun]'`\n\nStart every variant as a detached Modal call and return immediately.\n\n### `train(self, *, max_parallel: 'int' = 1, continue_on_error: 'bool' = True) -> 'list[TrainResult]'`\n\nRun every variant and return the successful `TrainResult`s.\n\n## Related Tutorials\n\n- [Sweep hyperparameters across runs with TrainingGroup](/tutorials/rl/007_param_sweep/)\n\n**Source:** [`modal_training_gym/common/training_group.py`](https://github.com/modal-projects/training-gym/blob/main/modal_training_gym/common/training_group.py)\n"
TrainingGroup
A base TrainConfig plus a grid of field overrides to expand.
from modal_training_gym.common.training_group import TrainingGroupA base TrainConfig plus a grid of field overrides to expand.
Constructor
Section titled “Constructor”TrainingGroup(base, grid=None, name=None, merge_model_recipe=None)| Parameter | Type | Default | Description |
|---|---|---|---|
base | TrainConfig | required | |
grid | dict[str, list[Any]] | None | None | |
name | str | None | None | |
merge_model_recipe | bool | None | None |
Methods
Section titled “Methods”get_train_configs(self) -> 'list[TrainConfig]'
Section titled “get_train_configs(self) -> 'list[TrainConfig]'”Expand the grid into validated, ready-to-run TrainConfigs.
iter_variants(self) -> 'list[tuple[dict[str, Any], TrainConfig]]'
Section titled “iter_variants(self) -> 'list[tuple[dict[str, Any], TrainConfig]]'”Return (overrides, config) for each point in the grid.
launch(self, *, continue_on_error: 'bool' = True, prepare_inputs: 'bool' = False) -> 'list[TrainingRun]'
Section titled “launch(self, *, continue_on_error: 'bool' = True, prepare_inputs: 'bool' = False) -> 'list[TrainingRun]'”Start every variant as a detached Modal call and return immediately.
train(self, *, max_parallel: 'int' = 1, continue_on_error: 'bool' = True) -> 'list[TrainResult]'
Section titled “train(self, *, max_parallel: 'int' = 1, continue_on_error: 'bool' = True) -> 'list[TrainResult]'”Run every variant and return the successful TrainResults.