> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-update-reference-docs-60.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Sweep
export const GitHubLink = ({url, compact = false}) =>
{compact ? "ソースを表示" : <>
GitHub のソース
}
;
## クラス wandb.apis.public.Sweep
sweep に関連付けられた Runs の一覧。
```python theme={null}
(service_api: 'ServiceApi',
entity: 'str',
project: 'str',
sweep_id: 'str',
attrs: 'Mapping[str, Any] | None' = None)
```
## 引数
説明はありません。
説明はありません。
説明はありません。
説明はありません。
説明はありません。
## 属性
* `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 数
## プロパティ
sweep で使用する sweep 設定。
sweep に関連付けられた entity。
sweep 内の想定される Runs 数を返します。無限に Runs する場合は 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` です。
非推奨です。代わりに `Sweep.entity` を使用してください。
## メソッド
### メソッド Sweep.agent()
```python theme={null}
self,
agent_id: 'str'
```
ID を指定して、この sweep のエージェントをクエリします。
##### 引数
検索するエージェントの ID。
### メソッド Sweep.agents()
```python theme={null}
self
```
この sweep に含まれるすべてのエージェントの一覧をクエリします。
### メソッド Sweep.best\_run()
```python theme={null}
(self, order=None)
```
設定で定義されたメトリクス、または指定された順序でソートされた最良の run を返します。
##### 引数
説明は提供されていません。
### メソッド Sweep.enqueue\_run()
```python theme={null}
self,
config: 'dict',
display_name: 'str | None' = None
```
sweep の run をキューに登録します。
##### 引数
run の設定。
run の表示名 (省略可) 。
##### 例外
* `UnsupportedError`: サーバーが sweep run のキューへの追加をサポートしていない場合。
### メソッド Sweep.get()
```python theme={null}
(api: 'Api',
entity: 'str | None' = None,
project: 'str | None' = None,
sid: 'str | None' = None,
order: 'str | None' = None,
query: 'str | None' = None, **kwargs)
```
クラウドバックエンドに対してクエリを実行します。
##### 引数
W\&B API のインスタンス。
project を所有する entity (ユーザー名またはチーム) 。
sweep を取得する project の名。
クエリする sweep ID。
sweep の Runs を返す順序。
クエリの実行に使用するクエリ。
説明はありません。
### メソッド Sweep.to\_html()
```python theme={null}
self,
height: 'int' = 420,
hidden: 'bool' = False
```
この sweep を表示する iframe を含む HTML を生成します。
##### 引数
説明はありません。
説明はありません。