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

# TensorFlow

> W&B を TensorFlow と統合して、カスタムメトリクスのログ、estimator フックの使用、TensorBoard ログの同期を行います。

export const ColabLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="colab-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M14.25.18l.9.2.73.26.59.3.45.32.34.34.25.34.16.33.1.3.04.26.02.2-.01.13V8.5l-.05.63-.13.55-.21.46-.26.38-.3.31-.33.25-.35.19-.35.14-.33.1-.3.07-.26.04-.21.02H8.77l-.69.05-.59.14-.5.22-.41.27-.33.32-.27.35-.2.36-.15.37-.1.35-.07.32-.04.27-.02.21v3.06H3.17l-.21-.03-.28-.07-.32-.12-.35-.18-.36-.26-.36-.36-.35-.46-.32-.59-.28-.73-.21-.88-.14-1.05-.05-1.23.06-1.22.16-1.04.24-.87.32-.71.36-.57.4-.44.42-.33.42-.24.4-.16.36-.1.32-.05.24-.01h.16l.06.01h8.16v-.83H6.18l-.01-2.75-.02-.37.05-.34.11-.31.17-.28.25-.26.31-.23.38-.2.44-.18.51-.15.58-.12.64-.1.71-.06.77-.04.84-.02 1.27.05zm-6.3 1.98l-.23.33-.08.41.08.41.23.34.33.22.41.09.41-.09.33-.22.23-.34.08-.41-.08-.41-.23-.33-.33-.22-.41-.09-.41.09zm13.09 3.95l.28.06.32.12.35.18.36.27.36.35.35.47.32.59.28.73.21.88.14 1.04.05 1.23-.06 1.23-.16 1.04-.24.86-.32.71-.36.57-.4.45-.42.33-.42.24-.4.16-.36.09-.32.05-.24.02-.16-.01h-8.22v.82h5.84l.01 2.76.02.36-.05.34-.11.31-.17.29-.25.25-.31.24-.38.2-.44.17-.51.15-.58.13-.64.09-.71.07-.77.04-.84.01-1.27-.04-1.07-.14-.9-.2-.73-.25-.59-.3-.45-.33-.34-.34-.25-.34-.16-.33-.1-.3-.04-.25-.02-.2.01-.13v-5.34l.05-.64.13-.54.21-.46.26-.38.3-.32.33-.24.35-.2.35-.14.33-.1.3-.06.26-.04.21-.02.13-.01h5.84l.69-.05.59-.14.5-.21.41-.28.33-.32.27-.35.2-.36.15-.36.1-.35.07-.32.04-.28.02-.21V6.07h2.09l.14.01.21.03zm-6.47 14.25l-.23.33-.08.41.08.41.23.33.33.23.41.08.41-.08.33-.23.23-.33.08-.41-.08-.41-.23-.33-.33-.23-.41-.08-.41.08z" />
    </svg>
    Try in Colab
  </a>;

<ColabLink url="https://colab.research.google.com/drive/1JCpAbjkCFhYMT7LCQ399y35TS3jlMpvM" />

このページでは、W\&B を TensorFlow と統合して、実験をトラッキングし、メトリクスをログし、TensorBoard のログを同期する方法を説明します。これらのパターンに従って、TensorFlow モデルからトレーニングデータを取得し、フックや手動でのログを通じてログする内容をカスタマイズし、既存の TensorBoard ワークフローを W\&B の一元化されたダッシュボードで再利用できます。TensorBoard 単体よりも充実した実験管理が必要な場合は、このインテグレーションを使用してください。

<h2 id="get-started">
  はじめに
</h2>

すでに TensorBoard を使用している場合は、W\&B と統合できます。両方のライブラリをインポートして、スクリプト内で W\&B と TensorFlow の API を使用できるようにします。

```python theme={"system"}
import tensorflow as tf
import wandb
```

<h2 id="log-custom-metrics">
  カスタムメトリクスをログする
</h2>

このセクションでは、TensorBoard が取得しないメトリクスをログする方法を説明します。これにより、標準の TensorBoard サマリーとともに追加の値をトラッキングできます。

TensorBoard がログしないカスタムメトリクスを追加でログする必要がある場合は、コード内で `run.log()` を呼び出せます。たとえば、`run.log({"custom": 0.8})` のようにします。

W\&B は TensorBoard との同期時に `run.log()` の step 引数を無効にします。異なる step 数を設定するには、次のように step メトリクスとともにメトリクスをログします。

```python theme={"system"}
with wandb.init(config=tf.flags.FLAGS, sync_tensorboard=True) as run:
    run.log({"custom": 0.8, "global_step":global_step}, step=global_step)
```

<h2 id="tensorflow-estimators-hook">
  TensorFlow Estimator のフック
</h2>

このセクションでは、TensorFlow Estimator 用の W\&B フックについて説明します。このフックを使用すると、Estimator のトレーニング中に W\&B が取得する内容を細かく制御できます。

ログする内容をより細かく制御したい場合のために、W\&B は TensorFlow Estimator 用のフックも提供しています。このフックは、グラフ内のすべての `tf.summary` 値をログします。

```python theme={"system"}
import tensorflow as tf
import wandb

run = wandb.init(config=tf.FLAGS)

estimator.train(hooks=[wandb.tensorflow.WandbHook(steps_per_log=1000)])
run.finish()
```

<h2 id="log-manually">
  手動でログする
</h2>

estimator を使用していない場合や、特定のサマリーを明示的にログしたい場合、このセクションでは `tf.summary` の値を W\&B に直接送信する方法を説明します。

TensorFlow でメトリクスをログする方法の 1 つは、TensorFlow ロガーで `tf.summary` をログすることです。

```python theme={"system"}
import wandb
run = wandb.init(config=tf.flags.FLAGS, sync_tensorboard=True)
with tf.Session() as sess:
    # ...
    wandb.tensorflow.log(tf.summary.merge_all())
```

TensorFlow 2 でカスタムループを使用してモデルをトレーニングする場合は、`tf.GradientTape` の使用を推奨します。詳細は、[TensorFlow のカスタムトレーニングのウォークスルー](https://www.tensorflow.org/tutorials/customization/custom_training_walkthrough)を参照してください。カスタム TensorFlow トレーニングループに W\&B を組み込んでメトリクスをログするには、次のスニペットに従ってください。

```python theme={"system"}
    with tf.GradientTape() as tape:
        # 確率を取得します
        predictions = model(features)
        # 損失を計算します
        loss = loss_func(labels, predictions)

    # メトリクスをログします
    run.log({"loss": loss.numpy()})
    # 勾配を取得します
    gradients = tape.gradient(loss, model.trainable_variables)
    # 重みを更新します
    optimizer.apply_gradients(zip(gradients, model.trainable_variables))
```

[TensorFlow 2 でトレーニングループをカスタマイズする完全な例](https://www.wandb.com/articles/wandb-customizing-training-loops-in-tensorflow-2)をご覧いただけます。

<h2 id="differences-between-wb-and-tensorboard">
  W\&B と TensorBoard の違い
</h2>

TensorBoard と併用するか、TensorBoard の代わりに W\&B を採用するかを検討している場合、このセクションでは主な違いを説明します。

W\&B は、TensorBoard ユーザーが直面する一般的な制約に対処するために開発されました。W\&B には次のような違いがあります。

* **モデルの再現**: W\&B は、実験、探索、後からのモデルの再現をサポートします。W\&B はメトリクス、ハイパーパラメーター、コードのバージョンを取得し、バージョン管理のステータスやモデル チェックポイントを保存できるため、project の再現性を確保できます。
* **自動整理**: 共同作業者から project を引き継ぐ場合、しばらく離れていた作業に戻る場合、過去の project を再び扱う場合に、W\&B では試したモデルを確認できるため、不必要に実験をやり直す必要がありません。
* **柔軟なインテグレーション**: オープンソースの Python パッケージをインストールし、コードに数行追加することで、project に W\&B を追加できます。各 run でメトリクスがログされ、記録が作成されます。
* **永続的で一元化されたダッシュボード**: ローカルマシン、研究室の共有クラスター、クラウドのスポットインスタンスのいずれでモデルをトレーニングしても、W\&B は結果を同じ一元化されたダッシュボードに送信します。異なるマシンから TensorBoard ファイルをコピーして整理する必要はありません。
* **Tables**: 異なるモデルの結果を検索、フィルター、並べ替え、グループ化できます。モデルのバージョンを確認し、タスクごとに最も性能の高いモデルを検索できます。
* **共同作業のためのツール**: W\&B を使用して機械学習の project を整理します。W\&B へのリンクを共有するか、プライベートチームを使用して共有 project に結果を送信します。Reports は、対話型の可視化と Markdown の説明を通じて共同作業をサポートします。これらを使用して、作業ログを残したり、上司と知見を共有したり、研究室やチームに知見を発表したりできます。

W\&B を試すには、[無料アカウントを作成してください](https://id.coreweave.com/signup)。

<h2 id="examples">
  サンプル
</h2>

これらのインテグレーションのパターンを完全な project に適用した例については、以下のサンプルをご覧ください。

* [TensorFlow Estimators を使用した MNIST のサンプル](https://github.com/wandb/examples/blob/master/examples/tensorflow/tf-estimator-mnist/mnist.py)。
* [TensorFlow を直接使用した Fashion MNIST のサンプル](https://github.com/wandb/examples/blob/master/examples/tensorflow/tf-cnn-fashion/train.py)。
* [MNIST サンプルの W\&B ダッシュボード](https://forge.coreweave.com/wandb/l2k2/examples-tf-estimator-mnist/runs/p0ifowcb)。
* TensorFlow 2 でのトレーニングループのカスタマイズ: [記事](https://www.wandb.com/articles/wandb-customizing-training-loops-in-tensorflow-2)と[ダッシュボード](https://app.wandb.ai/sayakpaul/custom_training_loops_tf)。
