> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-docs-2516.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Sweep
export const GitHubLink = ({url, compact = false}) =>
{compact ? "View source" : <>
GitHub source
}
;
## Class wandb.apis.public.Sweep
The set of runs associated with the sweep.
```python theme={null}
(service_api: 'ServiceApi',
entity: 'str',
project: 'str',
sweep_id: 'str',
attrs: 'Mapping[str, Any] | None' = None)
```
## Args
No description provided.
No description provided.
No description provided.
No description provided.
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.
The entity associated with the sweep.
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`.
Deprecated. Use `Sweep.entity` instead.
## Methods
### method Sweep.agent()
```python theme={null}
self,
agent_id: 'str'
```
Query an agent by ID for this sweep.
##### Arguments
The ID of the agent to look up.
### method Sweep.agents()
```python theme={null}
self
```
Query the list of all agents for this sweep.
### method Sweep.best\_run()
```python theme={null}
(self, order=None)
```
Return the best run sorted by the metric defined in config or the order passed in.
##### Arguments
No description provided.
### method Sweep.enqueue\_run()
```python theme={null}
self,
config: 'dict',
display_name: 'str | None' = None
```
Enqueue a run for the sweep.
##### Arguments
The config for the run.
The optional display name for the run.
##### Raises
* `UnsupportedError`: If the server doesn't support enqueuing sweep runs.
### method Sweep.get()
```python theme={null}
(api: 'Api',
entity: 'str | None' = None,
project: 'str | None' = None,
sid: 'str | None' = None,
order: 'str | None' = None,
query: 'str | None' = None, **kwargs)
```
Execute a query against the cloud backend.
##### Arguments
The W\&B API instance.
The entity (username or team) that owns the project.
The name of the project to fetch sweep from.
The sweep ID to query.
The order in which the sweep's runs are returned.
The query to use to execute the query.
No description provided.
### method Sweep.to\_html()
```python theme={null}
self,
height: 'int' = 420,
hidden: 'bool' = False
```
Generate HTML containing an iframe displaying this sweep.
##### Arguments
No description provided.
No description provided.