> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wandb.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> Python SDK または CLI を使用して sweep を初期化し、sweep 設定を使ったハイパーパラメーター探索を開始します。

# sweep を初期化する

sweep 設定を定義したら、エージェントを起動する前に sweep を初期化して、その設定を W\&B に登録し、sweep ID を取得します。エージェントは sweep ID を使用して run の実行指示を取得します。sweep を初期化すると、1 台以上のマシンにまたがるハイパーパラメーター探索を調整できるようになります。

W\&B は sweep コントローラーを使用して、1 台以上のマシンにまたがる sweeps を管理します。run が完了すると、コントローラーは次に実行する run を示す新しい一連の指示を発行し、エージェントはその指示を取得して実行します。デフォルトでは、W\&B がコントローラーをホストし、エージェントはユーザーのマシン上で実行されます。

sweep を初期化する前に、YAML file またはスクリプト内のネストされた Python の辞書 object のいずれかで sweep 設定を定義しておく必要があります。詳細は, [sweep 設定を定義する](/ja/models/sweeps/define-sweep-configuration)を参照してください。

以下の code snippets は、CLI および Jupyter ノートブックまたは Python スクリプト内で sweeps を初期化する方法を示しています。workflow に合った method を選択してください。

<Warning>
  sweep と run は同じ project 内になければなりません。W\&B を初期化するときに指定するプロジェクト名 ([`wandb.init()`](/ja/models/ref/python/functions/init)) は、sweep を初期化するときに指定するプロジェクト名 ([`wandb.sweep()`](/ja/models/ref/python/functions/sweep)) と一致している必要があります。
</Warning>

<Tabs>
  <Tab title="Python スクリプトまたはノートブック">
    W\&B SDK を使用して sweep を初期化します。sweep 設定の dictionary を `sweep` パラメーターに渡します。必要に応じて `project` パラメーターを設定し、W\&B が run の output を保存するプロジェクト名を指定します。project を指定しない場合、W\&B は run を "Uncategorized" project に配置します。

    ```python theme={null}
    import wandb

    # sweep 設定の例
    sweep_configuration = {
        "method": "random",
        "name": "sweep",
        "metric": {"goal": "maximize", "name": "val_acc"},
        "parameters": {
            "batch_size": {"values": [16, 32, 64]},
            "epochs": {"values": [5, 10, 15]},
            "lr": {"max": 0.1, "min": 0.0001},
        },
    }

    sweep_id = wandb.sweep(sweep=sweep_configuration, project="project-name")
    ```

    [`wandb.sweep()`](/ja/models/ref/python/functions/sweep) function は sweep ID を返します。sweep ID には entity 名とプロジェクト名が含まれます。エージェントの起動時に必要になるため、この sweep ID を控えておいてください。sweep ID があれば、1 つ以上のエージェントを起動して Runs を実行する準備は完了です。
  </Tab>

  <Tab title="CLI">
    W\&B CLI を使用して sweep を初期化します。設定 file の名前を指定します。必要に応じて `--project` フラグにプロジェクト名を設定します。project を指定しない場合、W\&B は run を "Uncategorized" project に配置します。

    [`wandb sweep`](/ja/models/ref/cli/wandb-sweep) コマンドを使用して sweep を初期化します。次の code example では、`sweeps_demo` project の sweep を初期化し、設定には `config.yaml` file を使用します。

    ```bash theme={null}
    wandb sweep --project sweeps_demo config.yaml
    ```

    この command は sweep ID を出力します。sweep ID には entity 名とプロジェクト名が含まれます。エージェントの起動時に必要になるため、この sweep ID を控えておいてください。sweep ID があれば、1 つ以上のエージェントを起動して Runs を実行する準備は完了です。
  </Tab>
</Tabs>
