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

Launch とは

Colab で試す

このチュートリアルは、ML 実務者とプラットフォームチームに向けて W&B Launch を紹介するものです。Launch job の作成、キューの設定、エージェントの接続、ジョブの送信と実行までの手順を順に説明します。チュートリアルを終えると、W&B Launch を使ってコンテナー化された ML ワークロードを実行した状態になり、チームで再利用できるキューとエージェントも利用可能になります。 W&B Launch を使用すると、トレーニングの run をデスクトップから Amazon SageMaker や Kubernetes などのコンピュートリソースへスケールできます。Launch を設定すれば、数回のクリックとコマンドだけで、トレーニングスクリプトやモデル評価スイートの実行、本番推論に向けたモデルの準備などを行えます。

仕組み

Launch は、Launch job、キュー、エージェント という 3 つの基本コンポーネントで構成されています。 Launch job は、ML ワークフロー内のタスクを設定して実行するための設計図です。作成した Launch job は launch キュー に追加できます。launch キューは先入れ先出し (FIFO) のキューです。このキューを使用して、Amazon SageMaker や Kubernetes クラスターなどの特定のコンピュートターゲットリソースに向けてジョブを設定し、送信できます。ジョブがキューに追加されると、Launch エージェント がそのキューをポーリングし、キューのターゲットとなっているシステム上でジョブを実行します。

ユースケースに応じて、ユーザー自身 (またはチームのメンバー) が、選択したコンピュートリソースターゲット (Amazon SageMaker など) に合わせて launch キューを設定し、自社のインフラストラクチャー上に Launch エージェントをデプロイします。 Launch の詳細については、用語と概念のページを参照してください。

はじめに

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

W&B Launch を初めて使用する場合は、まず Launch ウォークスルーガイドをご覧ください。
W&B Launch の設定方法を確認します。
Launch job を作成します。
W&B Launch の公開ジョブ GitHub リポジトリでは、Triton へのデプロイや LLM の評価など、一般的なタスクのテンプレートを確認できます。
- このリポジトリから作成された Launch job は、公開されている W&B プロジェクト wandb/jobs project で確認できます。

ウォークスルー

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

W&B Launch は、機械学習ワークロードをコンテナー内で実行します。このウォークスルーを進めるうえでコンテナーの知識は必須ではありませんが、あると理解しやすくなります。コンテナーの概要については、Docker のドキュメントを参照してください。

前提条件

始める前に、以下の前提条件を満たしていることを確認してください。これらは、このウォークスルーで後ほどコマンドを実行するために必要なアカウント、ツール、認証に関する条件です。

https://wandb.ai/site でアカウントを作成し、W&B アカウントにログインします。
このウォークスルーでは、Docker CLI と Docker エンジンが正常に動作するマシンにターミナルからアクセスできる必要があります。詳しくは Docker インストールガイドを参照してください。
W&B Python SDK バージョン 0.17.1 以降をインストールします。
pip install wandb>=0.17.1
ターミナルで wandb login を実行するか、WANDB_API_KEY 環境変数を設定して、W&B で認証します。

W&B にログイン
環境変数

ターミナルで次のコマンドを実行します。

wandb login

    WANDB_API_KEY=[API-KEY]

[API-KEY] をご自身の W&B APIキーに置き換えてください。

Launch job を作成する

Launch job は Launch に実行させるワークロードの設計図です。キューに作業を送信するには、事前に Launch job を作成しておく必要があります。Launch job は、Docker イメージを使用する方法、Git リポジトリから作成する方法、ローカルのソースコードから作成する方法の 3 通りで作成できます。

Docker イメージを使用する
Git リポジトリから作成する
ローカルのソースコードから作成する

W&B にメッセージをログする既製のコンテナーを実行するには、ターミナルを開いて次のコマンドを実行します。

wandb launch --docker-image wandb/job_hello_world:main --project launch-quickstart

このコマンドは、コンテナーイメージ wandb/job_hello_world:main をダウンロードして実行します。Launch は、wandb でログされたすべての内容が launch-quickstart project に送られるようにコンテナーを設定します。コンテナーは W&B にメッセージをログし、W&B 上の run へのリンクを表示します。リンクをクリックすると、W&B UI で run を確認できます。

同じ hello-world ジョブを W&B Launch jobs リポジトリにあるソースコードから起動するには、次のコマンドを実行します。

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"

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

W&B Launch jobs リポジトリを一時ディレクトリにクローンします。
hello project に hello-world-git という名前のジョブを作成します。このジョブは、コードの実行に使用したソースコードと設定をそのままトラッキングします。
jobs/hello_world ディレクトリと Dockerfile.wandb からコンテナーイメージをビルドします。
コンテナーを起動し、job.py Python スクリプトを実行します。

コンソール出力には、イメージのビルドと実行の様子が表示されます。コンテナーの出力は、前の例とほぼ同じになります。

Git リポジトリでバージョン管理されていないコードも、--uri 引数にローカルディレクトリのパスを指定すれば起動できます。空のディレクトリを作成し、次の内容で train.py という名前の Python スクリプトを追加します。

import wandb

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

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

wandb>=0.17.1

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

wandb launch --uri . --job-name hello-world-code --project launch-quickstart --entry-point "python train.py"

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

カレントディレクトリの内容をコードアーティファクトとして W&B にログします。
launch-quickstart project に hello-world-code という名前のジョブを作成します。
train.py と requirements.txt をベースイメージにコピーし、依存関係を pip install してコンテナーイメージをビルドします。
コンテナーを起動し、python train.py を実行します。

キューを作成する

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

https://forge.coreweave.com/wandb/launch にアクセスし、Create a queue ボタンをクリックします。
キューを関連付ける Entity を選択します。
Queue name を入力します。
Resource として Docker を選択します。
Configuration は空欄のままにします。
Create queue をクリックします。

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

キュー設定の高度なオプションについては、キューの高度なセットアップページを参照してください。

エージェントをキューに接続する

キューは、エージェントがポーリングするまでアイドル状態のままです。そのため、ジョブを実行するには、先にエージェントを接続する必要があります。キューをポーリングしているエージェントがない場合、キュービューの画面上部に赤いバナーが表示され、そこに Add an agent ボタンが表示されます。このボタンをクリックすると、エージェントを実行するためのコマンドを確認してコピーできます。コマンドは次のようになります。

wandb launch-agent --queue [QUEUE-NAME] --entity [ENTITY-NAME]

[QUEUE-NAME] をキュー名に、[ENTITY-NAME] を W&B の entity に置き換えてください。ターミナルでこのコマンドを実行して、エージェントを起動します。エージェントは指定されたキューをポーリングし、実行するジョブを取得します。ジョブを受け取ると、エージェントはそのジョブのコンテナーイメージをダウンロードまたはビルドしてから実行します。これは、wandb launch コマンドをローカルで実行した場合と同じ動作です。 Launch ページに戻り、キューが Active と表示されていることを確認してください。

キューにジョブを送信する

キューとポーリングを行うエージェントの準備ができたので、先ほど作成した Launch job のいずれかを送信し、共有コンピュート上で実行される様子を確認しましょう。W&B アカウントの launch-quickstart project にアクセスし、画面左側のナビゲーションからジョブタブを開きます。 Jobs ページには、過去の run から作成されたジョブの一覧が表示されます。Launch job をクリックすると、ソースコード、依存関係、およびそのジョブから作成された run を確認できます。このウォークスルーを完了すると、一覧には 3 つのジョブが表示されます。いずれかのジョブを選び、次の手順に従ってキューに送信します。

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

これで、ジョブがキューに送信されます。このキューをポーリングしているエージェントがジョブを取得して実行します。ジョブの進行状況は、W&B UI またはターミナルに表示されるエージェントの出力で監視できます。 wandb launch コマンドで --queue 引数を指定すると、ジョブをキューに直接プッシュできます。たとえば、hello-world コンテナージョブをキューに送信するには、次のコマンドを実行します。

   wandb launch --docker-image wandb/job_hello_world:main --project launch-quickstart --queue [QUEUE-NAME]

[QUEUE-NAME] を実際のキュー名に置き換えてください。これで、W&B Launch のワークフロー一式が完成しました。Launch job、キュー、キューをポーリングするエージェント、そして共有コンピュート上で非同期に実行されるジョブで構成されています。このパターンは、独自のトレーニング、評価、推論のワークロードにも再利用できます。

​Launch とは

Colab で試す

​仕組み

​はじめに

​ウォークスルー

​前提条件

​Launch job を作成する

​キューを作成する

​エージェントをキューに接続する

​キューにジョブを送信する

Launch とは

仕組み

はじめに

ウォークスルー

前提条件

Launch job を作成する

キューを作成する

エージェントをキューに接続する

キューにジョブを送信する