> ## 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 agent

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#L1816" />

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

```bash theme={"system"}
agent [OPTIONS] SWEEP_ID
```

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

sweep エージェントを起動します。

W\&B サーバーをポーリングして sweep のハイパーパラメーター設定を取得し、
設定ごとに run を開始します。

エージェントは、sweep が完了した場合、sweep が停止またはキャンセルされた場合、
あるいは `--count` の上限に達した場合に終了します。

sweep ID は、W\&B App の Sweeps タブ、または新しい sweep を作成した際の
`wandb sweep` コマンドの出力で確認できます。

sweep ID には、エンティティとプロジェクトのパスを含む形式
(entity/project/sweep\_id)、または 8 文字の sweep ID を指定できます。

たとえば、sweep ID が wbyz9876 の sweep に対してエージェントを起動するには、次のようにします。

```bash theme={"system"}
wandb agent wbyz9876
```

sweep の実行回数の上限を 10 回に設定してエージェントを起動するには、次のようにします。

```bash theme={"system"}
wandb agent --count 10 wbyz9876
```

sweep のエージェントを起動し、"team-awesome" エンティティに属する
"sweeps-project" という名前のプロジェクトに保存する場合:

```bash theme={"system"}
wandb agent -p sweeps-project -e team-awesome wbyz9876
```

子の run にシグナルを転送して正常にシャットダウンするには、次のようにします。

```bash theme={"system"}
wandb agent --forward-signals wbyz9876
```

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

| 名前 | デフォルト | 型 |
| - | - | - |
| `sweep_id` | STR | True |

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

| フラグ | 型 | 説明 |
| - | - | - |
| `--project, -p` | STR | run のアップロード先となるプロジェクトを設定します。**デフォルト**: None |
| `--entity, -e` | STR | プロジェクトのスコープとなるエンティティを設定します。**デフォルト**: None |
| `--count` | INT | このエージェントが実行する run の最大数です。設定しない場合は、sweep が完了するまで実行を継続します。**デフォルト**: None |
| `--forward-signals, -f` | BOOL フラグ | シグナル (SIGINT/SIGTERM など) を子 run に転送し、正常にシャットダウンできるようにします。**デフォルト**: False |
| `--term-timeout, -t` | INT | シャットダウンシグナル (SIGINT/SIGTERM など) を受信してから、転送されたシグナルを受信しても終了しない子 run を強制終了するまでの時間 (秒) です。--forward-signals が設定されていない場合は何も行いません。**デフォルト**: None |


## Related topics

- [agent()](/ja/products/wandb/ref/python/functions/agent.md)