Skip to main content

title: sweep kind: クラス namespace: wandb.apis.public.sweeps

クラス wandb.apis.public.Sweep

sweep に関連付けられた run のセット。

引数

ServiceApi
説明は提供されていません。
str
説明は提供されていません。
str
説明は提供されていません。
str
説明は提供されていません。
Mapping[str, Any] | None
説明は提供されていません。

属性

  • runs (Runs): run のリスト
  • id (str): sweep ID
  • project (str): sweep が属する project の名
  • config (dict): sweep 設定を含む辞書
  • state (str): sweep の状態。“Finished”、“Failed”、“Crashed”、“Running” のいずれか。
  • expected_run_count (int): sweep の期待される run の数値

プロパティ

sweep で使用される sweep 設定。
str
sweep に関連付けられた entity。
int | None
sweep で予定されている run の数を返します。run の数が無制限の場合は None を返します。
sweep の名。以下の優先順位で、最初に見つかった名を返します。
  1. ユーザーが編集した表示名
  2. 作成時に設定された名
  3. sweep ID
sweep の順序キーを返します。
project のパスを返します。パスは entity、プロジェクト名、および sweep ID を含むリストです。
sweep の URL。sweep の URL は entity、project、文字列「sweeps」、および sweep ID.run_id から生成されます。SaaS ユーザーの場合、形式は https://wandb.ai/entity/project/sweeps/sweeps_ID となります。
str
非推奨。代わりに Sweep.entity を使用してください。

メソッド

メソッド Sweep.agent()

この sweep の ID でエージェントをクエリします。
引数
str
検索対象のエージェントのIDです。

メソッド Sweep.agents()

この sweep のすべてのエージェントのリストをクエリする。

メソッド Sweep.best_run()

設定で定義されたメトリクスまたは渡された順序で並べ替えた、最良の run を返します。
引数
_empty
説明はありません。

メソッド Sweep.enqueue_run()

sweep の run をキューに追加します。
dict
run の設定。
str | None
run の表示名 (任意) 。
送出される例外
  • UnsupportedError: サーバーが sweep run のエンキューをサポートしていない場合。

メソッド Sweep.get()

クラウドのバックエンドに対してクエリします。
引数
Api
W&B API のインスタンス。
str | None
project を所有する entity (ユーザー名またはチーム) 。
str | None
sweep を取得する project の名。
str | None
クエリする sweep ID。
str | None
sweep の run が返される順序。
str | None
クエリを実行するために使用するクエリ。
_empty
説明は提供されていません。

メソッド Sweep.to_html()

この sweep を表示する iframe を含む HTML を生成します。
引数
int
説明はありません。
bool
説明はありません。
最終更新日 2026年9月30日