Skip to main content

Class wandb.apis.public.Run

A single run associated with an entity and project.

Args

ServiceApi
Interface to the wandb-core service that performs W&B API calls for this run.
str
The entity associated with the run.
str
The project associated with the run.
str
The unique identifier for the run.
Mapping | None
The attributes of the run.
bool
Whether to include sweeps in the run.
bool
str | None

Attributes

  • tags ([str]): a list of tags associated with the run
  • url (str): the url of this run
  • id (str): unique identifier for the run (defaults to eight characters)
  • name (str): the name of the run
  • state (str): one of: running, finished, crashed, killed, preempting, preempted
  • config (dict): a dict of hyperparameters associated with the run
  • created_at (str): ISO timestamp when the run was started
  • system_metrics (dict): the latest system metrics recorded for the run
  • summary (dict): A mutable dict-like property that holds the current summary. Calling update will persist any changes.
  • project (str): the project associated with the run
  • entity (str): the name of the entity associated with the run
  • project_internal_id (int): the internal id of the project
  • user (str): the name of the user who created the run
  • path (str): Unique identifier [entity]/[project]/[run_id]
  • notes (str): Notes about the run
  • read_only (boolean): Whether the run is editable
  • history_keys (str): History metric keys logged with wandb.Run.log({"key": "value"})
  • metadata (str): Metadata about the run from wandb-metadata.json