クイックスタート
W&Bをインストールして、数分で機械学習実験をトラッキングしましょう。
1. アカウントを作成してW&Bをインストールする
始める前に、アカウントを作成してW&Bをインストールしてください:
- サインアップして、https://wandb.ai/site で無料アカウントを作成し、wandbアカウントにログインしてください。
- Python 3環境で
pip
を使ってwandbライブラリをマシンにインストールします。
以下のコードスニペットは、W&B CLIおよびPythonライブラリを使ってW&Bにインストールしてログインする方法を示しています。
- Notebook
- Command Line
Weights & Biases APIと対話するためにCLIとPythonライブラリをインストールします。
pip install wandb
Weights & Biases APIと対話するためにCLIとPythonライブラリをインストールします。
!pip install wandb
2. W&Bにログインする
- Notebook
- Command Line
次に、W&Bにログインします。
wandb login
または、W&B Server(Dedicated Cloud または Self-managed を含む)を使用している場合:
wandb login --relogin --host=http://your-shared-local-host.com
必要に応じて、デプロイメント管理者にホスト名を問い合わせてください。
あなたのAPIキー を求められたら入力してください。
3. Runを開始してハイパーパラメータをトラックする
Pythonスクリプトまたはノートブックでwandb.init()
を使ってW&B Runオブジェクトを初期化し、ハイパーパラメータ名と値のペアを持つ辞書をconfig
パラメータに渡します:
run = wandb.init(
# このrunがログされるプロジェクトを設定
project="my-awesome-project",
# ハイパーパラメータとrunメタデータをトラック
config={
"learning_rate": 0.01,
"epochs": 10,
},
)
run はW&Bの基本的な構成要素です。メトリクスをトラックしたり、ログを作成したり、ジョブを作成したりする際に頻繁に使用します。
すべてをまとめる
すべてをまとめると、トレーニングスクリプトは以下のコード例のようになります。強調したコードはW&B特有のコードです。機械学習のトレーニングを模擬するコードを追加しています。
# train.py
import wandb
import random # デモスクリプト用
# 次の行を強調
wandb.login()
epochs = 10
lr = 0.01
# ここから強調
run = wandb.init(
# このrunがログされるプロジェクトを設定
project="my-awesome-project",
# ハイパーパラメータとrunメタデータをトラック
config={
"learning_rate": lr,
"epochs": epochs,
},
)
# ここまで強調
offset = random.random() / 5
print(f"lr: {lr}")
# トレーニングrunをシミュレーション
for epoch in range(2, epochs):
acc = 1 - 2**-epoch - random.random() / epoch - offset
loss = 2**-epoch + random.random() / epoch + offset
print(f"epoch={epoch}, accuracy={acc}, loss={loss}")
# 次の行を強調
wandb.log({"accuracy": acc, "loss": loss})
# run.log_code()
以上です!W&Bアプリのhttps://wandb.ai/homeに移動して、W&Bでログしたメトリクス(精度と損失)が各トレーニングステップでどのように改善されたかを確認してください。
上の画像(クリックで拡大)は、上記のスクリプトを実行した際にトラッキングされた損失と精度を示しています。作成された各runオブジェクトはRuns列内に表示されます。各run名はランダムに生成されます。
次に何をする?
W&Bのエコシステムを探索しましょう。
- W&B Integrationsをチェックして、PyTorchのようなMLフレームワーク、Hugging FaceのようなMLライブラリ、SageMakerのようなMLサービスとW&Bを統合する方法を学びましょう。
- runを整理し、可視化を埋め込み、自動化し、学びを記述し、コラボレーターとアップデートを共有しましょう。W&B Reportsを使ってください。
- W&B Artifactsを作成して、データセット、モデル、依存関係、結果を機械学習パイプラインの各ステップでトラッキングしましょう。
- W&B Sweepsを使ってハイパーパラメータ検索を自動化し、可能なモデルの空間を探索しましょう。
- データセットを理解し、モデルの予測を可視化し、インサイトを中央ダッシュボードで共有しましょう。
よくある質問
APIキーはどこで見つけられますか? www.wandb.ai にサインインすると、AuthorizeページにAPIキーがあります。
自動化環境でW&Bを使用するにはどうすればよいですか? GoogleのCloudMLのように、シェルコマンドを実行するのが不便な自動化環境でモデルをトレーニングする場合、環境変数を使った設定ガイドをご覧ください。
ローカルのオンプレミスインストールは提供していますか? はい、W&Bをローカルホストしたり、プライベートクラウドでプライベートにホストすることができます。この簡単なチュートリアルノートブックをご覧ください。
一時的にwandb loggingをオフにするにはどうすればよいですか?
コードをテストしていて一時的にwandbの同期を無効にしたい場合、環境変数WANDB_MODE=offline
を設定します。