Skip to main content
Initialize a hyperparameter sweep. Search for hyperparameters that optimizes a cost function of a machine learning model by testing various combinations.

Usage

wandb sweep CONFIG_YAML_OR_SWEEP_ID [OPTIONS]

Arguments

ArgumentDescriptionRequired
CONFIG_YAML_OR_SWEEP_IDNo description availableYes

Options

OptionDescription
--project, -pThe name of the project where W&B runs created from the sweep are sent to. If the project is not specified, the run is sent to a project labeled Uncategorized.
--entity, -eThe username or team name where you want to send W&B runs created by the sweep to. Ensure that the entity you specify already exists. If you donโ€™t specify an entity, the run will be sent to your default entity, which is usually your username.
--controllerRun local controller (default: False)
--verboseDisplay verbose output (default: False)
--nameThe name of the sweep. The sweep ID is used if no name is specified.
--programSet sweep program
--settingsSet sweep settings
--updateUpdate pending sweep
--stopFinish a sweep to stop running new runs and let currently running runs finish. (default: False)
--cancelCancel a sweep to kill all running runs and stop running new runs. (default: False)
--pausePause a sweep to temporarily stop running new runs. (default: False)
--resumeResume a sweep to continue running new runs. (default: False)
--prior_run, -RID of an existing run to add to this sweep