Documentation
Search…
English
Weights & Biases
Quickstart
Examples
Guides
Reference
Command Line Interface
Python Library
Data Types
Integrations
Import & Export API
wandb.apis.public.Api
wandb.apis.public.Artifact
wandb.apis.public.File
wandb.apis.public.Files
wandb.apis.public.Project
wandb.apis.public.Projects
wandb.apis.public.Run
wandb.apis.public.Runs
wandb.apis.public.Sweep
wandb.Artifact
wandb.Run
wandb.agent
wandb.config
wandb.controller
wandb.finish
wandb.init
wandb.log
wandb.save
wandb.summary
wandb.sweep
wandb.watch
Weave
App UI
Java Library
About Us
Homepage
Powered By
GitBook
wandb.apis.public.Sweep
​
​
View source on GitHub
​
A set of runs associated with a sweep.
1
Sweep
(
2
client
,
entity
,
project
,
sweep_id
,
attrs
=
{}
3
)
Copied!
Examples:
Instantiate with:
1
api = wandb.Api()
2
sweep = api.sweep(path/to/sweep)
Copied!
Attributes
Text
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
Methods
best_run
​
View source
​
1
best_run
(
2
order
=
None
3
)
Copied!
Returns the best run sorted by the metric defined in config or the order passed in
display
​
View source
​
1
display
(
2
height
=
420
,
hidden
=
(
False
)
3
)
->
bool
Copied!
Display this object in jupyter
get
​
View source
​
1
@classmethod
2
get
(
3
client
,
entity
=
None
,
project
=
None
,
sid
=
None
,
order
=
None
,
query
=
None
,
**
kwargs
4
)
Copied!
Execute a query against the cloud backend
load
​
View source
​
1
load
(
2
force
=
(
False
)
3
)
Copied!
snake_to_camel
​
View source
​
1
snake_to_camel
(
2
string
3
)
Copied!
to_html
​
View source
​
1
to_html
(
2
height
=
420
,
hidden
=
(
False
)
3
)
Copied!
Generate HTML containing an iframe displaying this sweep
Class Variables
Text
QUERY
​
Previous
wandb.apis.public.Runs
Next
wandb.Artifact
Last modified
3mo ago
Copy link
Contents
Methods
best_run
display
get
load
snake_to_camel
to_html