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

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#L1992" />

## Usage

```bash theme={null}
agent [OPTIONS] SWEEP_ID
```

## Description

Start a sweep agent.

Poll the W\&B server for hyperparameter configurations from
the sweep and start a run for each configuration.

The agent exits when the sweep completes, the sweep
is stopped, cancelled, or the `--count` limit is reached.

Find the sweep ID within the Sweeps tab in the W\&B App
or in the output of the `wandb sweep` command when you create a new sweep.

The sweep ID can include the entity and project path
(entity/project/sweep\_id) or the eight character sweep ID.

For example, to start an agent for a sweep with a sweep ID of wbyz9876:

```bash theme={null}
wandb agent wbyz9876
```

To start an agent with a run limit of 10 runs for the sweep:

```bash theme={null}
wandb agent --count 10 wbyz9876
```

To start an agent for a sweep and save it to a project
called "sweeps-project" that belongs to the "team-awesome" entity:

```bash theme={null}
wandb agent -p sweeps-project -e team-awesome wbyz9876
```

To forward signals to child runs for clean shutdown:

```bash theme={null}
wandb agent --forward-signals wbyz9876
```

## Arguments

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

## Options

| Flag                    | Type      | Description                                                                                                       |
| ----------------------- | --------- | ----------------------------------------------------------------------------------------------------------------- |
| `--project, -p`         | STR       | Set the project to upload runs to. **Default**: None                                                              |
| `--entity, -e`          | STR       | Set the entity to scope the project to. **Default**: None                                                         |
| `--count`               | INT       | Maximum number of runs this agent will execute. Continues until the sweep completes if not set. **Default**: None |
| `--forward-signals, -f` | BOOL Flag | Forward signals (e.g. SIGINT/SIGTERM) to child runs so they can shut down cleanly. **Default**: False             |