Sweep

Description

The set of runs associated with the sweep.

Args:

• client: The API client used to query W&B.
• entity: The entity which owns the sweep.
• project: The project which contains the sweep.
• sweep_id: The unique identifier for the sweep.
• attrs: The attributes of the sweep, typically obtained from a GraphQL response.

Properties:

entity

The entity associated with the sweep.

username

Deprecated. Use Sweep.entity instead.

config

The sweep configuration used for the sweep.

order

Return the order key for the sweep.

expected_run_count

Return the number of expected runs in the sweep or None for infinite runs.

path

Returns the path of the project.

The path is a list containing the entity, project name, and sweep ID.

url

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.

name

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

Methods:

agent

Query an agent by ID for this sweep.

agents

Query the list of all agents for this sweep.

best_run

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

display

Display this object in jupyter.

get

Execute a query against the cloud backend.