Skip to main content

Class wandb.Run

property config

Config object associated with this run.

property config_static

Static config object associated with this run.

property dir

The directory where files associated with the run are saved.

property disabled

True if the run is disabled, False otherwise.

property entity

The name of the W&B entity associated with the run. Entity can be a username or the name of a team or organization.

property group

Returns the name of the group associated with this run. Grouping runs together allows related experiments to be organized and visualized collectively in the W&B UI. This is especially useful for scenarios such as distributed training or cross-validation, where multiple runs should be viewed and managed as a unified experiment. In shared mode, where all processes share the same run object, setting a group is usually unnecessary, since there is only one run and no grouping is required.

property id

Identifier for this run.

property job_type

Name of the job type associated with the run. View a run’s job type in the run’s Overview page in the W&B App. You can use this to categorize runs by their job type, such as “training”, “evaluation”, or “inference”. This is useful for organizing and filtering runs in the W&B UI, especially when you have multiple runs with different job types in the same project. For more information, see Organize runs.

property name

Display name of the run. Display names are not guaranteed to be unique and may be descriptive. By default, they are randomly generated.

property notes

Notes associated with the run, if there are any. Notes can be a multiline string and can also use markdown and latex equations inside $$, like $x + 3$.

property offline

True if the run is offline, False otherwise.

property path

Path to the run. Run paths include entity, project, and run ID, in the format entity/project/run_id.

property project

Name of the W&B project associated with the run.

property project_url

URL of the W&B project associated with the run, if there is one. Offline runs do not have a project URL.

property resumed

True if the run was resumed, False otherwise.

property settings

A frozen copy of run’s Settings object.

property start_time

Unix timestamp (in seconds) of when the run started.

property step

The W&B step of the next log() call. Raises an error in mode=“shared” runs.

property sweep_id

Identifier for the sweep associated with the run, if there is one.

property sweep_url

URL of the sweep associated with the run, if there is one. Offline runs do not have a sweep URL.

property tags

Tags associated with the run, if there are any.

property url

The url for the W&B run, if there is one. Offline runs will not have a url.