> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wandb.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# wandb sweep

export const GitHubLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="github-source-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub source
  </a>;

<GitHubLink url="https://github.com/wandb/wandb/blob/v0.26.1/wandb/cli/cli.py#L912" />

## Usage

```bash theme={null}
sweep [OPTIONS] CONFIG_YAML_OR_SWEEP_ID
```

## 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:

```bash theme={null}
wandb sweep sweep_config.yaml
```

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

```bash theme={null}
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:

```bash theme={null}
wandb sweep --update abcd1234 sweep_config.yaml
```

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

```bash theme={null}
wandb sweep --stop team-awesome/foobar/abcd1234
```

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

```bash theme={null}
wandb sweep --cancel abcd1234
```

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

```bash theme={null}
wandb sweep --pause abcd1234
```

```bash theme={null}
wandb sweep --resume abcd1234
```

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

```bash theme={null}
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:

```bash theme={null}
wandb sweep -R abcd1234 -R efgh5678 sweep_config.yaml
```

## Arguments

| Name                      | Default | Type |
| ------------------------- | ------- | ---- |
| `config_yaml_or_sweep_id` | STR     | True |

## Options

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