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

​
class Sweep

スイープに関連付けられた run の集合。 属性:
  • runs (Runs): run のリスト
  • id (str): Sweep ID
  • project (str): スイープが属するプロジェクト名
  • config (dict): スイープの設定を含む辞書
  • state (str): スイープの状態。“Finished”、“Failed”、“Crashed”、“Running” のいずれか
  • expected_run_count (int): スイープに対して想定される run の数

​
メソッド Sweep.__init__

__init__(
    client: 'RetryingClient',
    entity: 'str',
    project: 'str',
    sweep_id: 'str',
    attrs: 'Mapping[str, Any] | None' = None
)

​
property Sweep.config

このスイープで使用される設定。

​
property Sweep.entity

スイープに関連付けられているエンティティ。 戻り値:
  • str: エンティティ プロパティの値。

​
property Sweep.expected_run_count

スイープで予定されている run の数を返します。run 回数が無制限の場合は None を返します。 戻り値:
  • int | None: expected_run_count プロパティの値。

​
property Sweep.name

スイープの名前。 以下の優先順位で、存在する最初の名前を返します:
  1. ユーザーが編集した表示名 2. 作成時に設定された名前 3. スイープ ID

​
property Sweep.order

このスイープの順序キーを返します。

​
property Sweep.path

プロジェクトのパスを返します。 パスは、エンティティ、プロジェクト名、スイープ ID からなるリストです。

​
property Sweep.url

スイープの URL。 スイープの URL は、エンティティ、プロジェクト、文字列 “sweeps”、および sweep ID.run_id を組み合わせて生成されます。SaaS のユーザーの場合、https://wandb.ai/entity/project/sweeps/sweeps_ID の形式になります。

​
property Sweep.username

非推奨です。代わりに Sweep.entity を使用してください。 戻り値:
  • str: username プロパティの値。

​
method Sweep.best_run

best_run(order=None)
config で定義された metric、または引数で指定された順序でソートされた run の中から、最も良い run を返します。

​
classmethod Sweep.get

get(
    client: 'RetryingClient',
    entity: 'str | None' = None,
    project: 'str | None' = None,
    sid: 'str | None' = None,
    order: 'str | None' = None,
    query: 'Document | None' = None,
    **kwargs
)
クラウドバックエンドに対してクエリを実行します。 引数:
  • client: クエリの実行に使用するクライアント。
  • entity: プロジェクトを所有するエンティティ（ユーザー名またはチーム）。
  • project: スイープを取得するプロジェクト名。
  • sid: 照会するスイープ ID。
  • order: スイープに含まれる run が返される順序。
  • query: クエリの実行に使用するクエリ。
  • **kwargs: クエリに渡す追加のキーワード引数。

​
method Sweep.to_html

to_html(height: 'int' = 420, hidden: 'bool' = False) → str
iframe でこのスイープを表示する HTML を生成します。