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

# wandb sweep

export const GitHubLink = ({url, compact = false}) => <a href={url} target="_blank" rel="noopener noreferrer" className={compact ? "source-link" : "github-source-link"}>
    {compact ? "View source" : <>
    <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 source
      </>}
  </a>;

<GitHubLink compact url="https://github.com/wandb/wandb/blob/v0.30.0/wandb/cli/cli.py#L718" />

<h2 id="usage">
  使用方法
</h2>

```bash theme={"system"}
sweep [OPTIONS] CONFIG_YAML_OR_SWEEP_ID
```

<h2 id="description">
  説明
</h2>

ハイパーパラメーターの sweep を作成、更新、管理します。

sweep を作成するには、YAML 設定ファイルを指定します。設定内で検索
戦略、パラメーター、最適化するメトリクスを定義します。
sweep を W\&B サーバーに登録し、sweep ID
とエージェントを起動するコマンドを出力します。

既存の sweep を管理するには、sweep ID (または完全なパス entity/project/sweep\_id) と
状態フラグ (`--stop`、`--cancel`、`--pause`、`--resume`) を
指定します。

sweep ID は sweep の一意の ID で、
sweep の作成時に W\&B が生成します。sweep ID は W\&B App 内で検索できます。
また、新しい sweep を作成する際の `wandb sweep` コマンドの出力でも確認できます。

たとえば、sweep\_config.yaml で定義された設定を使用して
sweep を作成します。現在のユーザーのデフォルトの entity と project を使用します。

```bash theme={"system"}
wandb sweep sweep_config.yaml
```

sweep を作成し、結果を "team-awesome" entity
と "foobar" project に保存するには:

```bash theme={"system"}
wandb sweep -p foobar -e team-awesome sweep_config.yaml
```

sweep\_config.yaml の新しい設定で sweep abcd1234 を更新するには:

```bash theme={"system"}
wandb sweep --update abcd1234 sweep_config.yaml
```

"team-awesome" entity と
"foobar" project の sweep abcd1234 を停止するには:

```bash theme={"system"}
wandb sweep --stop team-awesome/foobar/abcd1234
```

現在のユーザーのデフォルトの entity と project で sweep abcd1234 をキャンセルするには:

```bash theme={"system"}
wandb sweep --cancel abcd1234
```

現在のユーザーのデフォルトの entity と
project で sweep abcd1234 を一時停止します。後で sweep を再開します：

```bash theme={"system"}
wandb sweep --pause abcd1234
```

```bash theme={"system"}
wandb sweep --resume abcd1234
```

sweep\_config.yaml の設定を使用するローカルコントローラーで
sweep を作成するには、次のようにします。

```bash theme={"system"}
wandb sweep --controller sweep_config.yaml
```

新しい sweep を作成し、以前に完了した 2 つの run
(run ID abcd1234 と run ID efgh5678) を含めて、その結果を
sweep のハイパーパラメーター探索に組み込むには、次のようにします。

```bash theme={"system"}
wandb sweep -R abcd1234 -R efgh5678 sweep_config.yaml
```

<h2 id="arguments">
  引数
</h2>

| 名 | デフォルト | タイプ |
| - | - | - |
| `config_yaml_or_sweep_id` | STR | True |

<h2 id="options">
  オプション
</h2>

| Flag | タイプ | 説明 |
| - | - | - |
| `--project, -p` | STR | sweep の run に使用する project を設定します。設定されていない場合は「Uncategorized」を使用します。**デフォルト**: None |
| `--entity, -e` | STR | sweep の entity を設定します。設定されていない場合は現在のユーザーのデフォルトの entity を使用します。**デフォルト**: None |
| `--controller` | BOOL Flag | sweep 作成後にローカルの sweep コントローラーを起動します。**デフォルト**: False |
| `--verbose` | BOOL Flag | 詳細な出力を表示します。**デフォルト**: False |
| `--name` | STR | sweep の表示名を設定します。指定されていない場合は sweep ID を使用します。**デフォルト**: None |
| `--program` | STR | sweep 設定で指定されたトレーニング program を上書きします。**デフォルト**: None |
| `--update` | STR | まだ保留中で run が開始されていない sweep の設定を更新します。sweep ID を渡します。**デフォルト**: None |
| `--stop` | BOOL Flag | sweep を停止します。実行中の run は完了させますが、新しい run は開始しません。**デフォルト**: False |
| `--cancel` | BOOL Flag | sweep をキャンセルします。実行中の run を強制終了し、新しい run の開始を停止します。**デフォルト**: False |
| `--pause` | BOOL Flag | sweep を一時停止します。新しい run の開始を一時的に停止します。**デフォルト**: False |
| `--resume` | BOOL Flag | 一時停止中の sweep を再開します。**デフォルト**: False |
| `--prior_run, -R` | STR | 既存の run を ID でこの sweep にアタッチします。複数の run をアタッチする場合は複数回指定します。**デフォルト**: None |
