Documentation
Search…
wandb.agent
Generic agent entrypoint, used for CLI or jupyter.
1
agent(
2
sweep_id, function=None, entity=None, project=None, count=None
3
)
Copied!
Will run a function or program with configuration parameters specified by server.
Arguments
Text
sweep_id(dict) Sweep ID generated by CLI or sweep API
function(func, optional) A function to call instead of the "program" specifed in the config.
entity(str, optional) W&B Entity
project(str, optional) W&B Project
count(int, optional) the number of trials to run.
Examples:
Run a sample sweep over a function:
1
import wandb
2
sweep_configuration = {
3
"name": "my-awesome-sweep",
4
"metric": {"name": "accuracy", "goal": "maximize"},
5
"method": "grid",
6
"parameters": {
7
"a": {
8
"values": [1, 2, 3, 4]
9
}
10
}
11
}
12
13
def my_train_func():
14
# read the current value of parameter "a" from wandb.config
15
wandb.init()
16
a = wandb.config.a
17
18
wandb.log({"a": a, "accuracy": a + 1})
19
20
sweep_id = wandb.sweep(sweep_configuration)
21
22
# run the sweep
23
wandb.agent(sweep_id, function=my_train_func)
Copied!
Last modified 1mo ago
Copy link
Contents