Usage
Description
Create, update, or manage a hyperparameter sweep.
Provide a YAML config file to create a sweep. Define the search
strategy, parameters, and metric to optimize in the config.
Register the sweep with the W&B server and print the sweep ID
and a command to start an agent.
Provide a sweep ID (or full path entity/project/sweep_id) with a
state flag (--stop, --cancel, --pause, or --resume) to manage
an existing sweep.
The sweep ID is a unique identifier for the sweep, generated by
W&B when the sweep is created. You can find the sweep ID in the W&B App
or in the output of the wandb sweep command when you create a new sweep.
For example, to create a sweep using the configuration defined in
sweep_config.yaml. Use the current user’s default entity and project:
To create a sweep and store the results under the “team-awesome” entity
and “foobar” project:
To update sweep abcd1234 with a new configuration from sweep_config.yaml:
To stop sweep abcd1234 under the “team-awesome” entity
and “foobar” project:
To cancel sweep abcd1234 in the current user’s default entity and project:
To pause sweep abcd1234 in the current user’s default entity and
project. Later, resume the sweep:
To create a sweep with a local controller that uses the configuration
in sweep_config.yaml:
To create a new sweep and include two previously completed runs
(run ID abcd1234 and run ID efgh5678) so their results are incorporated
into the sweep’s hyperparameter search:
Arguments
Options
Last modified on September 30, 2026
