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

​
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,
    service_api: 'ServiceApi | None' = None
)
引数:
  • client: (wandb.apis.public.RetryingClient) リクエストに使用する API クライアント。
  • entity: (str) プロジェクトを所有する entity (ユーザー名またはチーム) 。
  • project: (str) run を取得するプロジェクトの名。
  • filters: (Optional[Dict[str, Any]]) run のクエリに適用するフィルターの辞書。
  • order: (str) created_at、heartbeat_at、config.*.value、または summary_metrics.* を指定できます。先頭に + を付けると昇順 (デフォルト) 、- を付けると降順になります。デフォルトの並び順は run.created_at で、古いものから新しいものへ並びます。
  • per_page: (int) リクエストごとに取得する run の数 (デフォルトは 50) 。
  • include_sweeps: (bool) run に sweep 情報を含めるかどうか。デフォルトは True です。

​
プロパティ 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
フィルター条件に一致するすべての run について、サンプリングされた履歴メトリクスを返します。 引数:
  • samples: 各 run について返すサンプル数
  • keys: 指定したキーのメトリクスのみを返します
  • x_axis: このメトリクスを xAxis として使用します。デフォルトは _step です
  • format: 返すデータの形式です。指定できる値は “default”、“pandas”、“polars” です
  • stream: メトリクスには “default”、マシンメトリクスには “system” を指定します
戻り値:
  • pandas.DataFrame: format="pandas" の場合、履歴メトリクスを含む pandas.DataFrame を返します。
  • polars.DataFrame: format="polars" の場合、履歴メトリクスを含む polars.DataFrame を返します。
  • list of dicts: format="default" の場合、run_id キーを含む履歴メトリクスを格納した dict のリスト を返します。

​
method Runs.upgrade_to_full

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