Skip to main content

​
Class wandb.apis.public.Runs

A lazy iterator of Run objects associated with a project and optional filter. Runs are retrieved in pages from the W&B server as needed. This is generally used indirectly using the Api.runs namespace.

​
Args

​
ServiceApi
The service API to use for requests.
​
str
The entity (username or team) that owns the project.
​
str
The name of the project to fetch runs from.
​
dict[str, Any] | None
Filters to apply to the runs query.
​
str
Order can be created_at, heartbeat_at, config.*.value, or summary_metrics.*. If you prepend order with a + order is ascending (default). If you prepend order with a - order is descending. The default order is run.created_at from oldest to newest.
​
int
The number of runs to fetch per request (default is 50).
​
bool
Whether to include sweep information in the runs. Defaults to True.
​
bool
Whether to defer loading heavy fields (config, summaryMetrics, systemMetrics) until they are accessed. Defaults to True.
​
str | None
No description provided.

​
Methods

​
method Runs.histories()

Return sampled history metrics for all runs that fit the filters conditions.
Arguments
​
int
The number of samples to return per run
​
list[str] | None
Only return metrics for specific keys
​
str
Use this metric as the xAxis defaults to _step
​
Literal['default', 'pandas', 'polars']
Format to return data in, options are “default”, “pandas”, “polars”
​
Literal['default', 'system']
“default” for metrics, “system” for machine metrics

​
method Paginator.next()

Return the next item from the iterator. When exhausted, raise StopIteration

​
method Paginator.update_variables()

Update the query variables for the next page fetch.

​
method Runs.upgrade_to_full()

Upgrade this Runs collection from lazy to full mode. This switches to fetching full run data and upgrades any already-loaded Run objects to have full data. Uses parallel loading for better performance when upgrading multiple runs.