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

​
class Sweep

Sweep に関連付けられた Runs のセットです。 Attributes:
  • runs (Runs): Runs のリスト
  • id (str): Sweep ID
  • project (str): Sweep が属する Project の名前
  • config (dict): sweep configuration を含む辞書
  • state (str): Sweep の状態。“Finished”、“Failed”、“Crashed”、または “Running” のいずれかです。
  • expected_run_count (int): Sweep で期待される想定 Run 数

​
method Sweep.__init__

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

​
property Sweep.config

Sweep に使用される sweep configuration です。

​
property Sweep.entity

Sweep に関連付けられた Entity です。 Returns:
  • str: entity プロパティの値。

​
property Sweep.expected_run_count

Sweep で期待される Run 数を返します。無限の場合は None を返します。 Returns:
  • int | None: expected_run_count プロパティの値。

​
property Sweep.name

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

​
property Sweep.order

Sweep の順序（order）キーを返します。

​
property Sweep.path

Project のパスを返します。 パスは、Entity、Project 名、および Sweep ID を含むリストです。

​
property Sweep.url

Sweep の URL です。 Sweep の URL は、Entity、Project、“sweeps” という用語、および Sweep ID から生成されます。 SaaS Users の場合、https://wandb.ai/entity/project/sweeps/sweeps_ID という形式になります。

​
property Sweep.username

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

​
method Sweep.best_run

best_run(order=None)
config で定義されたメトリクス、または渡された order に基づいてソートされた最高の 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
)
クラウドのバックエンドに対してクエリを実行します。 Args:
  • client: クエリの実行に使用するクライアント。
  • entity: Project を所有する Entity (Users 名または Teams)。
  • project: Sweep を取得する Project の名前。
  • sid: クエリ対象の Sweep ID。
  • order: Sweep の Runs が返される順序。
  • query: 実行に使用するクエリ。
  • **kwargs: クエリに渡す追加のキーワード引数。

​
method Sweep.to_html

to_html(height: 'int' = 420, hidden: 'bool' = False) → str
この Sweep を表示する iframe を含む HTML を生成します。