Sweep

less than a minute

A set of runs associated with a sweep.

Sweep(
    client, entity, project, sweep_id, attrs=None
)

Instantiate with:

api = wandb.Api()
sweep = api.sweep(path / to / sweep)

Attributes
`runs`	(`Runs`) list of runs
`id`	(str) sweep id
`project`	(str) name of project
`config`	(str) dictionary of sweep configuration
`state`	(str) the state of the sweep
`expected_run_count`	(int) number of expected runs for the sweep

Methods

best_run(
    order=None
)

Return the best run sorted by the metric defined in config or the order passed in.

display(
    height=420, hidden=(False)
) -> bool

Display this object in jupyter.

@classmethod
get(
    client, entity=None, project=None, sid=None, order=None, query=None, **kwargs
)

Execute a query against the cloud backend.

load(
    force: bool = (False)
)

snake_to_camel(
    string
)

to_html(
    height=420, hidden=(False)
)

Generate HTML containing an iframe displaying this sweep.

Class Variables
`LEGACY_QUERY`
`QUERY`

Was this page helpful?

Glad to hear it! If you have further feedback, please let us know.

Sorry to hear that. Please tell us how we can improve.

Last modified March 5, 2025