start_sweep
Creates a sweep (HPO study or grid search) that groups trial runs under one sweep_id, so you can log each trial and view the sweep as a collapsible fan with its best trial highlighted.
Instructions
Create a sweep (an HPO study / grid search) that groups trial runs. Pass its sweep_id to log_run for each trial; the map shows the sweep as one collapsible fan with the best trial highlighted. Use run_sweep instead to have mltree launch a grid itself.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Whether lower or higher metric is better | max |
| name | No | Short label, e.g. 'alpha x layers grid' | |
| step | Yes | Step the trials run, e.g. 'train' | |
| metric | No | Metric that ranks the trials, e.g. 'val_rmse' | |
| search_space | No | Optional search space, e.g. {'alpha': [0.1, 1, 10]} | |
| parent_run_id | No | Run the sweep branches from (e.g. the baseline) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||