sweeps

module wandb.apis.public

W&B Public API for Sweeps.

This module provides classes for interacting with W&B hyperparameter optimization sweeps.

Example:

from wandb.apis.public import Api

# Initialize API
api = Api()

# Get a specific sweep
sweep = api.sweep("entity/project/sweep_id")

# Access sweep properties
print(f"Sweep: {sweep.name}")
print(f"State: {sweep.state}")
print(f"Best Loss: {sweep.best_loss}")

# Get best performing run
best_run = sweep.best_run()
print(f"Best Run: {best_run.name}")
print(f"Metrics: {best_run.summary}")

Note:

This module is part of the W&B Public API and provides read-only access to sweep data. For creating and controlling sweeps, use the wandb.sweep() and wandb.agent() functions from the main wandb package.

class Sweep

The set of runs associated with the sweep.

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

method Sweep.__init__

__init__(client, entity, project, sweep_id, attrs=None)

property Sweep.config

The sweep configuration used for the sweep.

property Sweep.entity

The entity associated with the sweep.

property Sweep.expected_run_count

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

property Sweep.name

The name of the sweep.

If the sweep has a name, it will be returned. Otherwise, the sweep ID will be returned.

property Sweep.order

Return the order key for the sweep.

property Sweep.path

Returns the path of the project.

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

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

Deprecated. Use Sweep.entity instead.

method Sweep.best_run

best_run(order=None)

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

classmethod Sweep.get

get(
    client,
    entity=None,
    project=None,
    sid=None,
    order=None,
    query=None,
    **kwargs
)

Execute a query against the cloud backend.

method Sweep.load

load(force: bool = False)

Fetch and update sweep data logged to the run from GraphQL database.

method Sweep.to_html

to_html(height=420, hidden=False)

Generate HTML containing an iframe displaying this sweep.