Try in Colab
WandbLogger を介して PyTorch Lightning ライブラリに直接組み込まれています。
Lightning との統合
- PyTorch Logger
- Fabric Logger
wandb.log() を使用する際の注意点:
WandbLogger は Trainer の global_step を使用して W&B にログを記録します。コード内で直接 wandb.log を追加で呼び出す場合、wandb.log() の step 引数を使用しないでください。代わりに、Trainer の global_step を他のメトリクスと同様に記録してください:
サインアップして APIキーを作成する
APIキー は、あなたのマシンを W&B に認証するためのものです。あなたのユーザープロフィールから APIキー を生成できます。よりスムーズなアプローチとして、https://wandb.ai/authorize に直接アクセスして APIキー を生成することができます。表示された APIキー を安全な場所(パスワードマネージャーなど)に保存してください。
- 右上のユーザープロフィールアイコンをクリックします。
- User Settings を選択し、API Keys セクションまでスクロールします。
- Reveal をクリックします。表示された APIキー をコピーします。APIキー を非表示にするには、ページをリロードします。
wandb ライブラリをインストールしてログインする
ローカルに wandb ライブラリをインストールしてログインする方法:
- コマンドライン
- Python
- Python notebook
-
あなたの APIキー に
WANDB_API_KEY環境変数 を設定します。 -
wandbライブラリをインストールしてログインします。
PyTorch Lightning の WandbLogger を使用する
PyTorch Lightning には、メトリクスやモデルの重み、メディアなどを記録するための複数の WandbLogger クラスがあります。
Lightning と統合するには、WandbLogger をインスタンス化し、Lightning の Trainer または Fabric に渡してください。
- PyTorch Logger
- Fabric Logger
よく使用されるロガーの引数
以下に、WandbLogger でよく使用されるパラメータを示します。すべてのロガー引数の詳細については PyTorch Lightning のドキュメントを確認してください。| Parameter | Description |
|---|---|
project | 記録する wandb Project を定義します |
name | あなたの wandb run に名前を付けます |
log_model | log_model="all" の場合はすべてのモデルを記録し、log_model=True の場合はトレーニングの最後に記録します |
save_dir | データが保存されるパス |
ハイパーパラメーターを記録する
- PyTorch Logger
- Fabric Logger
追加の設定パラメータを記録する
勾配、パラメータヒストグラム、モデルトポロジーを記録する
モデルのオブジェクトをwandblogger.watch() に渡すことで、トレーニング中のモデルの勾配とパラメータを監視できます。PyTorch Lightning の WandbLogger ドキュメントを参照してください。
メトリクスを記録する
- PyTorch Logger
- Fabric Logger
WandbLogger を使用しているときは、LightningModule 内で self.log('my_metric_name', metric_value) を呼び出すことで W&B にメトリクスを記録できます。たとえば、training_step や validation_step メソッド内でこれを行います。以下のコードスニペットは、メトリクスとハイパーパラメーターを記録するための LightningModule を定義する方法を示しています。この例では、torchmetrics ライブラリを使用してメトリクスを計算します。メトリクスの最小/最大値を記録する
wandb のdefine_metric 関数を使用して、W&B の要約メトリクスがそのメトリクスの最小、最大、平均、または最良の値を表示するかどうかを定義できます。define_metric が使用されていない場合、最後に記録された値が要約メトリクスに表示されます。詳細な define_metric の ドキュメントはこちら と ガイドはこちら を参照してください。
W&B の要約メトリクスで最大の検証精度を追跡するよう W&B に指示するには、トレーニングの開始時に一度だけ wandb.define_metric を呼び出します:
- PyTorch Logger
- Fabric Logger
モデルチェックポイントを作成する
モデルのチェックポイントを W&B の Artifacts として保存するには、Lightning のModelCheckpoint コールバックを使用し、WandbLogger の log_model 引数を設定します。
- PyTorch Logger
- Fabric Logger
- Via Logger
- Via wandb
- PyTorch Logger
- Fabric Logger
画像やテキストなどを記録する
WandbLogger は、メディアを記録するための log_image、log_text、log_table メソッドを持っています。
他にも、音声、分子、ポイントクラウド、3Dオブジェクトなどのメディアタイプを記録するために、直接的に wandb.log や trainer.logger.experiment.log を呼び出すことができます。
- Log Images
- Log Text
- Log Tables
複数の GPU を使用して Lightning と W&B を使用する
PyTorch Lightning は DDP インターフェースを通じてマルチGPUをサポートしています。ただし、PyTorch Lightning のデザインは GPU をインスタンス化する際に注意が必要です。 Lightning は、トレーニングループ内の各 GPU (またはランク) がまったく同じ方法で、同じ初期条件でインスタンス化されなければならないと仮定しています。ただし、ランク0のプロセスだけがwandb.run オブジェクトに アクセスでき、非ゼロランクのプロセスには wandb.run = None となります。これが原因で、非ゼロプロセスが失敗する可能性があります。このような状況になると、ランク0のプロセスが非ゼロランクのプロセスに参加を待つことになり、既にクラッシュしてしまうため、デッドロックに陥る可能性があります。
このため、トレーニングコードのセットアップに注意する必要があります。推奨される方法は、コードを wandb.run オブジェクトに依存しないようにすることです。
例
Colab のビデオチュートリアルに従うことができます。こちら をクリックしてください。よくある質問 (FAQ)
W&B は Lightning とどのように統合されていますか?
コアなインテグレーションは、Lightningloggers API に基づいており、ログのコードをフレームワークに依存しない方法で多く書かせることができます。Logger は Lightning Trainer に渡され、この API の豊富な フックとコールバックシステム に基づいてトリガーされます。これにより、研究コードがエンジニアリングやログのコードと完全に分離されます。
追加のコードなしでインテグレーションがログする内容は?
モデルのチェックポイントを W&B に保存し、今後のRunsで使用するために閲覧またはダウンロードできるようにします。また、GPU使用量やネットワークI/Oなどのシステムメトリクス、ハードウェア情報やOS情報などの環境情報、gitコミットやdiffパッチ、ノートブックコンテンツやセッション履歴を含むコードの状態、標準出力に印刷されるものをキャプチャします。トレーニングセットアップで wandb.run を使用する必要がある場合はどうすればいいですか?
アクセスが必要な変数のスコープを自分で拡張する必要があります。言い換えれば、初期条件がすべてのプロセスで同じであることを確認してください。
os.environ["WANDB_DIR"] を使用してモデルのチェックポイントディレクトリをセットアップできます。これにより、非ゼロランクプロセスでも wandb.run.dir にアクセスできます。