Skip to main content

​
Class wandb.apis.public.Sweep

The set of runs associated with the sweep.

​
Args

​
ServiceApi
No description provided.
​
str
No description provided.
​
str
No description provided.
​
str
No description provided.
​
Mapping[str, Any] | None
No description provided.

​
Attributes

  • runs (Runs): List of runs
  • id (str): Sweep ID
  • project (str): The name of the project the sweep belongs to
  • config (dict): Dictionary containing the sweep configuration
  • state (str): The state of the sweep. Can be “Finished”, “Failed”, “Crashed”, or “Running”.
  • expected_run_count (int): The number of expected runs for the sweep

​
Properties

​
The sweep configuration used for the sweep.
​
str
The entity associated with the sweep.
​
int | None
Return the number of expected runs in the sweep or None for infinite runs.
​
The name of the sweep.Returns the first name that exists in the following priority order:
  1. User-edited display name
  2. Name configured at creation time
  3. Sweep ID
​
Return the order key for the sweep.
​
Returns the path of the project.The path is a list containing the entity, project name, and sweep ID.
​
The URL of the sweep.The sweep URL is generated from the entity, project, the term “sweeps”, and the sweep ID.run_id. For SaaS users, it takes the form of https://wandb.ai/entity/project/sweeps/sweeps_ID.
​
str
Deprecated. Use Sweep.entity instead.

​
Methods

​
method Sweep.agent()

Query an agent by ID for this sweep.
Arguments
​
str
The ID of the agent to look up.

​
method Sweep.agents()

Query the list of all agents for this sweep.

​
method Sweep.best_run()

Return the best run sorted by the metric defined in config or the order passed in.
Arguments
​
_empty
No description provided.

​
method Sweep.enqueue_run()

Enqueue a run for the sweep.
Arguments
​
dict
The config for the run.
​
str | None
The optional display name for the run.
Raises
  • UnsupportedError: If the server doesn’t support enqueuing sweep runs.

​
method Sweep.get()

Execute a query against the cloud backend.
Arguments
​
Api
The W&B API instance.
​
str | None
The entity (username or team) that owns the project.
​
str | None
The name of the project to fetch sweep from.
​
str | None
The sweep ID to query.
​
str | None
The order in which the sweep’s runs are returned.
​
str | None
The query to use to execute the query.
​
_empty
No description provided.

​
method Sweep.to_html()

Generate HTML containing an iframe displaying this sweep.
Arguments
​
int
No description provided.
​
bool
No description provided.