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.
• service_api:

Properties

property entity

The entity associated with the sweep.

property username

Deprecated. Use Sweep.entity instead.

property config

The sweep configuration used for the sweep.

property order

Return the order key for the sweep.

property expected_run_count

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

property path

Returns the path of the project.

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

property 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.

property 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

method agent

self,
agent_id: 'str'

Query an agent by ID for this sweep.

Arguments

• agent_id: The ID of the agent to look up.

method agents

self

Query the list of all agents for this sweep.

method best_run

(self, order=None)

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

Arguments

• order:

method display

self, height=420, hidden=False

Display this object in jupyter.

Arguments

• height:
• hidden:

method get

Execute a query against the cloud backend.

Arguments

• client: Legacy GraphQL client retained for API compatibility.
• entity: The entity (username or team) that owns the project.
• project: The name of the project to fetch sweep from.
• sid: The sweep ID to query.
• order: The order in which the sweep’s runs are returned.
• query: The query to use to execute the query.
• service_api: Interface to the wandb-core service that performs W&B API calls for the returned sweep.
• kwargs: