> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-sdk-testing-latest.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# sweep()

export const GitHubLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="github-source-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub のソース
  </a>;

<GitHubLink url="https://github.com/wandb/wandb/blob/main/wandb/sdk/wandb_sweep.py" />

### <kbd>関数</kbd> `sweep`

```python theme={null}
sweep(
    sweep: 'dict | Callable',
    entity: 'str | None' = None,
    project: 'str | None' = None,
    prior_runs: 'list[str] | None' = None
) → str
```

ハイパーパラメーター探索の sweep を初期化します。

さまざまな組み合わせを試して、機械学習モデルのコスト関数を最適化するハイパーパラメーターを探索します。

返される一意の ID `sweep_id` を控えておいてください。後の step で `sweep_id` を sweep agent に指定します。

sweep の定義方法については、[Sweep 設定の構造](https://docs.wandb.ai/models/sweeps/define-sweep-configuration)を参照してください。

**引数:**

* `sweep`:  ハイパーパラメーター探索の設定です (または設定ジェネレーター) 。callable を指定する場合は、その callable が引数を取らず、W\&B sweep config spec に準拠した辞書を返すことを確認してください。
* `entity`:  sweep によって作成された W\&B run の送信先となるユーザー名またはチーム名です。指定する entity がすでに存在していることを確認してください。entity を指定しない場合、run はデフォルトの entity (通常はユーザー名) に送信されます。
* `project`:  sweep から作成された W\&B run の送信先となるプロジェクトの名です。project を指定しない場合、run は 'Uncategorized' というラベルの付いたプロジェクトに送信されます。
* `prior_runs`:  この sweep に追加する既存の run ID です。

**戻り値:**

* `str`:  sweep の一意の ID です。
