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

> ジョブ、キュー、エージェント、ML ワークロードの実行について学べる、W&B Launch の入門チュートリアルです。

# チュートリアル: W&B Launch の基本

<div id="what-is-launch">
  ## Launch とは？
</div>

<Card title="Colab で試す" href="https://colab.research.google.com/drive/1wX0OSVxZJDHRsZaOaOEDx-lLUrO1hHgP" icon="python" />

W\&B Launch を使うと、デスクトップで実行しているトレーニング[runs](/ja/models/runs/)を、Amazon SageMaker や Kubernetes などのコンピュートリソースへ簡単にスケールできます。W\&B Launch を設定すると、数回のクリックとコマンドだけで、トレーニングスクリプトの実行、モデル評価スイートの実行、本番推論向けのモデルの準備などをすばやく行えます。

<div id="how-it-works">
  ## 仕組み
</div>

Launch は、**launch ジョブ**、**キュー**、**エージェント**という 3 つの基本コンポーネントで構成されています。

[*launch ジョブ*](./launch-terminology#launch-job) は、ML ワークフロー内のタスクを設定・実行するための設計図です。launch ジョブを作成したら、それを [*launch キュー*](./launch-terminology#launch-queue) に追加できます。launch キューは先入れ先出し (FIFO) 方式のキューで、Amazon SageMaker や Kubernetes クラスターなどの特定のコンピュートターゲットリソース向けに、ジョブを設定して送信できます。

ジョブがキューに追加されると、[*launch エージェント*](./launch-terminology#launch-agent) がそのキューをポーリングし、キューの対象システム上でジョブを実行します。

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-wbdocs-1882/wPEtZnTqyM95ckpT/images/launch/launch_overview.png?fit=max&auto=format&n=wPEtZnTqyM95ckpT&q=85&s=207d919bbfd256f540f8d13cca337e20" alt="W&B Launch の概要図" width="1314" height="642" data-path="images/launch/launch_overview.png" />
</Frame>

ユースケースに応じて、あなた (またはチームの誰か) が、選択した [compute resource target](./launch-terminology#target-resources) (たとえば Amazon SageMaker) に合わせて launch キューを設定し、自身のインフラストラクチャー上に launch エージェントをデプロイします。

Launch の詳細については、[用語と概念](./launch-terminology) ページを参照してください。

<div id="how-to-get-started">
  ## はじめに
</div>

ユースケースに応じて、W\&B Launch を使い始めるには次のリソースを参照してください。

* W\&B Launch を初めて使用する場合は、[Launch walkthrough](#walkthrough) ガイドを一読することをおすすめします。
* [W\&B Launch](/ja/platform/launch/set-up-launch/) の設定方法を確認してください。
* [launch ジョブ](/ja/platform/launch/launch-terminology/#launch-job) を作成します。
* [Triton へのデプロイ](https://github.com/wandb/launch-jobs/tree/main/jobs/deploy_to_nvidia_triton) や [LLM の評価](https://github.com/wandb/launch-jobs/tree/main/jobs/openai_evals) など、一般的なタスクのテンプレートについては、W\&B Launch の [公開 jobs GitHub リポジトリ](https://github.com/wandb/launch-jobs) を参照してください。
  * このリポジトリから作成された launch ジョブ は、公開 W\&B プロジェクト [`wandb/jobs` プロジェクト](https://wandb.ai/wandb/jobs/jobs) で確認できます。

<div id="walkthrough">
  ## ウォークスルー
</div>

このページでは、W\&B Launch ワークフローの基本を順を追って説明します。

<Note>
  W\&B Launch は、コンテナー内で機械学習ワークロードを実行します。コンテナーに慣れている必要はありませんが、このウォークスルーを進めるうえで役立つ場合があります。コンテナーの基礎については、[Docker ドキュメント](https://docs.docker.com/guides/docker-concepts/the-basics/what-is-a-container/)を参照してください。
</Note>

<div id="prerequisites">
  ## 前提条件
</div>

始める前に、以下の前提条件を満たしていることを確認してください。

1. [https://wandb.ai/site](https://wandb.ai/site) でアカウントを作成し、W\&B アカウントにログインします。
2. この手順では、Docker CLI と Docker エンジンが正しく動作するマシンにターミナルからアクセスできる必要があります。詳細は [Docker installation guide](https://docs.docker.com/engine/install/) を参照してください。
3. W\&B Python SDK バージョン `0.17.1` 以降をインストールします。
   ```bash theme={null}
   pip install wandb>=0.17.1
   ```
4. ターミナルで `wandb login` を実行するか、`WANDB_API_KEY` 環境変数を設定して W\&B に認証します。

<Tabs>
  <Tab title="W&B にログイン">
    ターミナルで次を実行します。

    ```bash theme={null}
    wandb login
    ```
  </Tab>

  <Tab title="Environment variable">
    ```bash theme={null}
        WANDB_API_KEY=<your-api-key>
    ```

    `<your-api-key>` を W\&B APIキーに置き換えます。
  </Tab>
</Tabs>

<div id="create-a-launch-job">
  ## Launch ジョブを作成する
</div>

[Launch ジョブ](./launch-terminology#launch-job)は、Docker イメージを使用する方法、git リポジトリから作成する方法、ローカルのソースコードから作成する方法の3通りで作成できます。

<Tabs>
  <Tab title="Docker イメージを使用">
    W\&B にメッセージをログする事前作成済みのコンテナーを実行するには、ターミナルを開いて次のコマンドを実行します。

    ```bash theme={null}
    wandb launch --docker-image wandb/job_hello_world:main --project launch-quickstart
    ```

    前述のコマンドは、コンテナーイメージ `wandb/job_hello_world:main` をダウンロードして実行します。

    Launch は、`wandb` でログされたすべての内容が `launch-quickstart` プロジェクトにレポートされるようにコンテナーを設定します。コンテナーは W\&B にメッセージをログし、新しく作成された run へのリンクを表示します。リンクをクリックすると、W\&B UI で run を表示できます。
  </Tab>

  <Tab title="git リポジトリから">
    同じ hello-world ジョブを [W\&B Launch jobs リポジトリ内のソースコード](https://github.com/wandb/launch-jobs)から Launch するには、次のコマンドを実行します。

    ```bash theme={null}
    wandb launch --uri https://github.com/wandb/launch-jobs.git \\
    --job-name hello-world-git --project launch-quickstart \\ 
    --build-context jobs/hello_world --dockerfile Dockerfile.wandb \\ 
    --entry-point "python job.py"
    ```

    このコマンドは次の処理を行います。

    1. [W\&B Launch jobs リポジトリ](https://github.com/wandb/launch-jobs) を一時ディレクトリーにクローンします。
    2. **hello** プロジェクトに **hello-world-git** という名前のジョブを作成します。このジョブは、コードの実行に使用した正確なソースコードと設定をトラッキングします。
    3. `jobs/hello_world` ディレクトリーと `Dockerfile.wandb` からコンテナーイメージをビルドします。
    4. コンテナーを起動し、`job.py` Python スクリプトを実行します。

    コンソール出力には、イメージのビルドと実行が表示されます。コンテナーの出力は前の例とほぼ同じになるはずです。
  </Tab>

  <Tab title="ローカルのソースコードから">
    git リポジトリでバージョン管理されていないコードは、`--uri` 引数にローカルディレクトリーパスを指定することで Launch できます。

    空のディレクトリーを作成し、次の内容の `train.py` という名前の Python スクリプトを追加します。

    ```python theme={null}
    import wandb

    with wandb.init() as run:
        run.log({"hello": "world"})
    ```

    次の内容の `requirements.txt` ファイルを追加します。

    ```text theme={null}
    wandb>=0.17.1
    ```

    ディレクトリー内で、次のコマンドを実行します。

    ```bash theme={null}
    wandb launch --uri . --job-name hello-world-code --project launch-quickstart --entry-point "python train.py"
    ```

    このコマンドは次の処理を行います。

    1. 現在のディレクトリーの内容を Code Artifact として W\&B にログします。
    2. **launch-quickstart** プロジェクトに **hello-world-code** という名前のジョブを作成します。
    3. `train.py` と `requirements.txt` をベースイメージにコピーし、requirements を `pip install` してコンテナーイメージをビルドします。
    4. コンテナーを起動して `python train.py` を実行します。
  </Tab>
</Tabs>

<div id="create-a-queue">
  ## キューを作成する
</div>

Launch は、チームが共有コンピュートを中心としたワークフローを構築できるように設計されています。これまでの例では、`wandb launch` コマンドはローカルマシン上でコンテナーを同期的に実行していました。Launch のキューとエージェントを使うと、共有リソース上でジョブを非同期に実行できるほか、優先度の設定やハイパーパラメーター最適化などの高度な機能も利用できます。基本的なキューを作成するには、次の手順に従います。

1. [wandb.ai/launch](https://wandb.ai/launch) にアクセスし、**Create a queue** ボタンをクリックします。
2. キューに関連付ける **Entity** を選択します。
3. **Queue name** を入力します。
4. **Resource** として **Docker** を選択します。
5. **Configuration** は、ひとまず空欄のままにします。
6. **Create queue** :rocket: をクリックします。

ボタンをクリックすると、ブラウザーはキュービューの **Agents** タブにリダイレクトされます。エージェントがポーリングを開始するまで、キューは **Not active** 状態のままです。

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-wbdocs-1882/wPEtZnTqyM95ckpT/images/launch/create_docker_queue.gif?s=eca389cc1f2dc7bbba3bc6bacdd4acfc" alt="Docker キューの作成" width="2482" height="1670" data-path="images/launch/create_docker_queue.gif" />
</Frame>

高度なキュー設定オプションについては、[高度なキュー設定ページ](/ja/platform/launch/setup-queue-advanced/)を参照してください。

<div id="connect-an-agent-to-the-queue">
  ## エージェントをキューに接続する
</div>

キューにポーリングするエージェントがない場合は、画面上部の赤いバナーに **Add an agent** ボタンが表示されます。このボタンをクリックすると、エージェントを実行するためのコマンドを表示してコピーできます。コマンドは次のようになります。

```bash theme={null}
wandb launch-agent --queue <queue-name> --entity <entity-name>
```

エージェントを起動するには、ターミナルでコマンドを実行します。エージェントは指定したキューをポーリングして、実行するジョブを取得します。ジョブを受信すると、ローカルで `wandb launch` コマンドを実行した場合と同様に、そのジョブ用のコンテナーイメージをダウンロードまたはビルドして実行します。

[Launch ページ](https://wandb.ai/launch)に戻り、キューが **Active** と表示されていることを確認します。

<div id="submit-a-job-to-the-queue">
  ## キューにジョブを送信する
</div>

W\&B アカウントで新しい **launch-quickstart** プロジェクトにアクセスし、画面左側のナビゲーションから **Jobs** タブを開きます。

**Jobs** ページには、以前に実行した run から作成された W\&B Job の一覧が表示されます。launch ジョブをクリックすると、ソースコード、依存関係、そのジョブから作成された run を確認できます。このウォークスルーを完了すると、一覧には 3 つのジョブが表示されるはずです。

新しいジョブのいずれか 1 つを選択し、次の手順に従ってキューに送信します。

1. **Launch** ボタンをクリックしてジョブをキューに送信します。**Launch** ドロワーが表示されます。
2. 先ほど作成した **Queue** を選択し、**Launch** をクリックします。

これでジョブがキューに送信されます。このキューをポーリングしているエージェントがジョブを取得して実行します。ジョブの進行状況は、W\&B UI で確認するか、ターミナルでエージェントの出力を確認することで監視できます。

`wandb launch` コマンドでは、`--queue` 引数を指定することで、ジョブを直接キューに送信できます。たとえば、hello-world コンテナー ジョブをキューに送信するには、次のコマンドを実行します。

```bash theme={null}
   wandb launch --docker-image wandb/job_hello_world:main --project launch-quickstart --queue <queue-name>
```