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

# TensorFlow

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

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>
    Colabで試す
  </a>;

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

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

すでにTensorBoardを使っている場合は、wandbと簡単に統合できます。

```python theme={null}
import tensorflow as tf
import wandb
```

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

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

TensorBoard を Sync している場合、`run.log()` で `step` 引数を設定する機能は無効になります。別の step 数を設定したい場合は、次のように step メトリクスを指定してメトリクスをログできます。

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

<div id="tensorflow-estimators-hook">
  ## TensorFlow Estimator 用フック
</div>

ログされる内容をより細かく制御したい場合は、wandb が TensorFlow Estimator 向けのフックも提供しています。このフックは、グラフ内のすべての `tf.summary` の値をログします。

```python theme={null}
import tensorflow as tf
import wandb

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

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

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

TensorFlow でメトリクスをログする最も簡単な方法は、TensorFlow のロガーを使って `tf.summary` をログすることです。

```python theme={null}
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 custom training walkthrough](https://www.tensorflow.org/tutorials/customization/custom_training_walkthrough) を参照してください。カスタムの TensorFlow トレーニングループに `wandb` を組み込んでメトリクスをログしたい場合は、次のスニペットを参照してください。

```python theme={null}
    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)を参照できます。

<div id="how-is-wb-different-from-tensorboard">
  ## W\&B は TensorBoard とどう違うのですか？
</div>

W\&B の共同創業者が開発に着手した当初、OpenAI で TensorBoard に不満を感じていたユーザーのためのツールを作ろうという発想がありました。私たちが特に改善してきた点をいくつかご紹介します。

1. **モデルの再現性**: W\&B は、実験、探索、そして後からモデルを再現する用途に適しています。メトリクスだけでなく、ハイパーパラメーターやコードのバージョンも記録し、さらにバージョン管理のステータスやモデル チェックポイントも保存できるため、プロジェクトの再現性を確保できます。
2. **自動整理**: 共同作業者からプロジェクトを引き継ぐときでも、休暇後に作業へ戻るときでも、しばらく触っていなかった古いプロジェクトを見直すときでも、W\&B を使えば、これまで試したすべてのモデルを簡単に把握できます。そのため、実験をやり直すことで時間や GPU リソース、さらには炭素排出を無駄にせずに済みます。
3. **高速で柔軟なインテグレーション**: 5 分で W\&B をプロジェクトに追加できます。無償のオープンソース Python パッケージをインストールし、コードに数行追加するだけで、モデルを実行するたびに、見やすく整理されたメトリクスと記録が自動的にログされます。
4. **永続的で一元化されたダッシュボード**: モデルをどこでトレーニングしていても、ローカルマシンでも、共有ラボのクラスターでも、クラウド上のスポットインスタンスでも、結果は同じ一元化されたダッシュボードに集約されます。異なるマシンから TensorBoard のファイルをコピーして整理するのに時間をかける必要はありません。
5. **強力な Tables**: 異なるモデルの結果を検索、フィルター、並べ替え、グループ化できます。何千ものモデル バージョンを見渡して、さまざまなタスクで最も高性能なモデルを簡単に見つけられます。TensorBoard は大規模なプロジェクトでの利用に十分対応できるようには設計されていません。
6. **コラボレーションのためのツール**: 複雑な機械学習プロジェクトの整理に W\&B を活用できます。W\&B へのリンクは簡単に共有でき、非公開の Teams を使えば、全員が結果を同じ共有プロジェクトに送れます。さらに、Reports を使ったコラボレーションにも対応しています。インタラクティブな可視化を追加し、作業内容を Markdown で記述できます。これは、作業ログを残したり、発見したことを指導教員や上司と共有したり、研究室やチームに成果を報告したりするのに最適な方法です。

[無料アカウント](https://wandb.ai)で始める

<div id="examples">
  ## 例
</div>

インテグレーションがどのように動作するかを確認できるよう、いくつかの例を用意しました。

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