メインコンテンツへスキップ
GitHub source

​
class Runs

プロジェクトに関連付けられ、オプションでフィルタリングされた Run オブジェクトのレイジーイテレータです。 Runs は、必要に応じて W&B サーバーからページ単位で取得されます。 通常、これは Api.runs ネームスペースを介して間接的に使用されます。

​
method Runs.__init__

__init__(
    client: 'RetryingClient',
    entity: 'str',
    project: 'str',
    filters: 'dict[str, Any] | None' = None,
    order: 'str' = '+created_at',
    per_page: 'int' = 50,
    include_sweeps: 'bool' = True,
    lazy: 'bool' = True,
    api: 'public.Api | None' = None
)
Args:
  • client: (wandb.apis.public.RetryingClient) リクエストに使用する API クライアント。
  • entity: (str) プロジェクトを所有する Entities（ユーザー名またはチーム）。
  • project: (str) Runs を取得する Projects の名前。
  • filters: (Optional[Dict[str, Any]]) Runs クエリに適用するフィルタの辞書。
  • order: (str) ソート順。created_at、heartbeat_at、config.*.value、または summary_metrics.* が指定可能です。先頭に + を付けると昇順（デフォルト）、- を付けると降順になります。デフォルトの順序は run.created_at で、古いものから新しい順です。
  • per_page: (int) 1回のリクエストで取得する Runs の数（デフォルトは 50）。
  • include_sweeps: (bool) Runs に Sweeps の情報を含めるかどうか。デフォルトは True です。

​
property Runs.length

​
method Runs.histories

histories(
    samples: 'int' = 500,
    keys: 'list[str] | None' = None,
    x_axis: 'str' = '_step',
    format: "Literal['default', 'pandas', 'polars']" = 'default',
    stream: "Literal['default', 'system']" = 'default'
) → list[dict[str, Any]] | pd.DataFrame | pl.DataFrame
フィルタ条件に一致するすべての Runs について、サンプリングされた履歴メトリクスを返します。 Args:
  • samples: 各 Run ごとに返されるサンプル数。
  • keys: 特定のキーのメトリクスのみを返します。
  • x_axis: X軸として使用するメトリクス。デフォルトは _step です。
  • format: データを返す形式。オプションは “default”、“pandas”、“polars” です。
  • stream: メトリクスの場合は “default”、マシンメトリクスの場合は “system” を指定します。
Returns:
  • pandas.DataFrame: format="pandas" の場合、履歴メトリクスの pandas.DataFrame を返します。
  • polars.DataFrame: format="polars" の場合、履歴メトリクスの polars.DataFrame を返します。
  • list of dicts: format="default" の場合、run_id キーを含む履歴メトリクスの辞書のリストを返します。

​
method Runs.upgrade_to_full

upgrade_to_full() → None
この Runs コレクションを lazy モードから full モードにアップグレードします。 これにより、完全な Run データの取得に切り替わり、すでにロードされている Run オブジェクトも完全なデータを持つようにアップグレードされます。複数の Runs をアップグレードする際のパフォーマンスを向上させるために、並列ロードを使用します。