wandb agent

CLI reference for the wandb agent command, which starts a sweep agent to poll for and run hyperparameter configurations.

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:

$ wandb agent wbyz9876

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

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

$ wandb agent -p sweeps-project -e team-awesome wbyz9876

To forward signals to child runs for clean shutdown:

$ wandb agent --forward-signals wbyz9876

Usage

wandb agent SWEEP_ID [OPTIONS]

Arguments

Argument	Description	Required
SWEEP_ID	No description available	Yes

Options

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