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

# wandb sweep

[View source](https://github.com/wandb/wandb/blob/v0.31.0/wandb/cli/cli.py#L709)

## Usage

```bash theme={"system"}
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={"system"}
wandb sweep sweep_config.yaml
```

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

```bash theme={"system"}
wandb sweep -p foobar -e team-awesome sweep_config.yaml
```

To update sweep abcd1234 with a new configuration from sweep\_config.yaml:

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

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

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

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

```bash theme={"system"}
wandb sweep --cancel abcd1234
```

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

```bash theme={"system"}
wandb sweep --pause abcd1234
```

```bash theme={"system"}
wandb sweep --resume abcd1234
```

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

```bash theme={"system"}
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={"system"}
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 the configuration of a sweep while it is still pending, before any run has started. 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 |
