> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-dependabot-github-actions-actions-cache-6.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Sweep
export const GitHubLink = ({url}) =>
GitHub のソース
;
## class `Sweep`
sweep に関連付けられた run のセット。
**属性:**
* `runs` (Runs): run のリスト
* `id` (str): Sweep ID
* `project` (str): この sweep が属するプロジェクトの名
* `config` (dict): sweep の設定を含む辞書
* `state` (str): sweep の状態。"Finished"、"Failed"、"Crashed"、または "Running" のいずれかになります。
* `expected_run_count` (int): この sweep で想定される run 数
### method `Sweep.__init__`
```python theme={null}
__init__(
service_api: 'ServiceApi',
entity: 'str',
project: 'str',
sweep_id: 'str',
attrs: 'Mapping[str, Any] | None' = None
)
```
***
### プロパティ Sweep.config
この sweep で使用される設定。
***
### プロパティ Sweep.entity
sweep に関連付けられた entity。
**戻り値:**
* `str`: entity プロパティの値。
***
### プロパティ Sweep.expected\_run\_count
このsweepで想定されるrun数を返します。run数が無限の場合は None を返します。
**戻り値:**
* `int | None`: expected\_run\_count プロパティの値。
***
### プロパティ Sweep.name
sweep の名前。
以下の優先順位で、存在する最初の名前を返します。
1. ユーザーが編集した表示名 2. 作成時に設定された名前 3. Sweep ID
***
### プロパティ Sweep.order
sweep の並び順のキーを返します。
***
### プロパティ Sweep.path
プロジェクトのパスを返します。
このパスは、entity、プロジェクト名、sweep ID からなるリストです。
***
### プロパティ Sweep.url
sweep の URL。
sweep の URL は、entity、プロジェクト、文字列 `"sweeps"`、および sweep ID.run\_id から生成されます。SaaS ユーザーの場合、形式は `https://wandb.ai/entity/project/sweeps/sweeps_ID` です。
***
### プロパティ Sweep.username
非推奨です。代わりに `Sweep.entity` を使用してください。
**戻り値:**
* `str`: username プロパティの値。
***
### method `Sweep.agent`
```python theme={null}
agent(agent_id: 'str') → Agent
```
ID を指定して、この sweep のエージェントをクエリします。
**引数:**
* `agent_id`: 検索するエージェントの ID。
***
### method `Sweep.agents`
```python theme={null}
agents() → list[Agent]
```
この sweep に含まれるすべてのエージェントの一覧をクエリします。
***
### method `Sweep.best_run`
```python theme={null}
best_run(order=None)
```
設定で定義されたメトリクス、または指定された順序でソートされた最良の run を返します。
***
### クラスメソッド `Sweep.get`
```python theme={null}
get(
api: 'Api',
entity: 'str | None' = None,
project: 'str | None' = None,
sid: 'str | None' = None,
order: 'str | None' = None,
query: 'str | None' = None,
**kwargs
)
```
クラウドバックエンドに対してクエリを実行します。
**引数:**
* `api`: W\&B API インスタンス。
* `entity`: プロジェクトを所有する entity (ユーザー名またはチーム) 。
* `project`: sweep を取得する元のプロジェクト名。
* `sid`: クエリ対象の sweep ID。
* `order`: sweep の run が返される順序。
* `query`: クエリの実行に使用するクエリ。
* `**kwargs`: クエリに渡す追加のキーワード引数。
***
### method `Sweep.to_html`
```python theme={null}
to_html(height: 'int' = 420, hidden: 'bool' = False) → str
```
この sweep を表示する iframe を含む HTML を生成します。