wandb sweep

CLI reference for the wandb sweep command, which creates, updates, or manages a hyperparameter sweep.

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:

$ wandb sweep sweep_config.yaml

To create a sweep and store the results under the “team-awesome” entity and “foobar” project:

$ wandb sweep -p foobar -e team-awesome sweep_config.yaml

To update sweep abcd1234 with a new configuration from sweep_config.yaml. This is useful for changing the parameters or search strategy of an active sweep:

$ wandb sweep --update abcd1234 sweep_config.yaml

To stop sweep abcd1234 under the “team-awesome” entity and “foobar” project:

$ wandb sweep --stop team-awesome/foobar/abcd1234

To cancel sweep abcd1234 in the current user’s default entity and project:

$ wandb sweep --cancel abcd1234

To pause sweep abcd1234 in the current user’s default entity and project. Later, resume the sweep:

$ wandb sweep --pause abcd1234

$ wandb sweep --resume abcd1234

To create a sweep with a local controller that uses the configuration in sweep_config.yaml:

$ wandb sweep --controller 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:

$ wandb sweep -R abcd1234 -R efgh5678 sweep_config.yaml

Usage

wandb sweep CONFIG_YAML_OR_SWEEP_ID [OPTIONS]

Arguments

Argument	Description	Required
CONFIG_YAML_OR_SWEEP_ID	No description available	Yes

Options

Option	Description
--project, -p	Set the project for sweep runs. Use ‘Uncategorized’ if not set.
--entity, -e	Set the entity for sweep. Use the current user’s default entity if not set.
--controller	Start a local sweep controller after creating the sweep. (default: False)
--verbose	Display verbose output. (default: False)
--name	Set a display name for the sweep. Use the sweep ID if not specified.
--program	Override the training program specified in the sweep config.
--update	Update an existing sweep configuration. Pass the sweep ID.
--stop	Stop a sweep. Let active runs finish but do not start new runs. (default: False)
--cancel	Cancel a sweep. Kill active runs and stop starting new ones. (default: False)
--pause	Pause a sweep. Temporarily stop starting new runs. (default: False)
--resume	Resume a paused sweep. (default: False)
--prior_run, -R	Attach an existing run to this sweep by ID. Specify multiple times to attach multiple runs.