Skip to main content

クラス wandb.apis.public.Runs

project と省略可能なフィルターに関連付けられた Run オブジェクトの遅延イテレーターです。 必要に応じて、Runs は W&B サーバーからページ単位で取得されます。 これは通常、Api.runs 名前空間を通じて間接的に使用されます。

引数

  • service_api: リクエストに使用するサービス API。
  • entity: project を所有する entity (ユーザー名またはチーム) 。
  • project: run を取得する project の名。
  • filters: run のクエリに適用するフィルター。
  • order: created_atheartbeat_atconfig.*.value、または summary_metrics.* を指定できます。先頭に + を付けると昇順 (デフォルト) 、- を付けると降順になります。デフォルトの並び順は run.created_at で、古いものから新しいものへ並びます。
  • per_page: リクエストごとに取得する run の数 (デフォルトは 50) 。
  • include_sweeps: run に sweep 情報を含めるかどうか。デフォルトは True です。
  • lazy: アクセスされるまで重いフィールド (configsummaryMetricssystemMetrics) の読み込みを遅延させるかどうか。デフォルトは True です。
  • api_key:

メソッド

メソッド Runs.histories()

フィルター条件に一致するすべての run について、サンプリングされた履歴メトリクスを返します。
引数
  • samples: 各 run について返すサンプル数
  • keys: 指定したキーのメトリクスのみを返します
  • x_axis: このメトリクスを xAxis として使用します。デフォルトは _step です
  • format: 返すデータの形式です。指定できる値は “default”、“pandas”、“polars” です
  • stream: メトリクスには “default”、マシンメトリクスには “system” を指定します

メソッド ページネーター.next()

イテレーターから次の項目を返します。すべての項目を返し終えている場合は、StopIteration を送出します

メソッド ページネーター.update_variables()

次のページのフェッチに使用するクエリ変数を更新します。

メソッド Runs.upgrade_to_full()

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