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

# Hugging Face

> W&B を使って Hugging Face のモデル性能を可視化・トラッキングし、ハイパーパラメーター、メトリクス、GPU 使用率をログします。

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/github/wandb/examples/blob/master/colabs/huggingface/Huggingface_wandb.ipynb" />

[W\&B](https://wandb.ai/site) とのシームレスなインテグレーションにより、[Hugging Face](https://github.com/huggingface/transformers) モデルのパフォーマンスをすばやく可視化できます。

ハイパーパラメーター、出力メトリクス、GPU 使用率などのシステム統計を、モデル間で比較できます。

<div id="why-should-i-use-wb">
  ## なぜ W\&B を使うべきですか？
</div>

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-docs-sandboxes-integrations-placement/SNVYl3A1VGlNmCKT/images/tutorials/huggingface-why.png?fit=max&auto=format&n=SNVYl3A1VGlNmCKT&q=85&s=ad1240c71ea00f78cdfbf00262ef932e" alt="W&B を使用する利点" width="4672" height="816" data-path="images/tutorials/huggingface-why.png" />
</Frame>

* **統合ダッシュボード**: すべてのモデルのメトリクスと予測を一元的に管理
* **軽量**: Hugging Face と統合するためにコードを変更する必要はありません
* **利用しやすい**: 個人および学術 Teams は無料で利用できます
* **安全**: すべてのプロジェクトはデフォルトで非公開です
* **信頼性**: OpenAI、Toyota、Lyft などの機械学習チームで利用されています

W\&B は、機械学習モデル向けの GitHub のようなものです。機械学習の実験を非公開のホスト型ダッシュボードに保存できます。スクリプトをどこで実行していても、モデルのすべてのバージョンが保存されるため、安心してすばやく実験を進められます。

W\&B の軽量なインテグレーションはあらゆる Python スクリプトで動作し、モデルのトラッキングと可視化を始めるには、無料の W\&B アカウントにサインアップするだけです。

Hugging Face Transformers のリポジトリでは、各 logging step でトレーニングおよび評価メトリクスを自動的に W\&B にログするよう、Trainer が組み込まれています。

このインテグレーションの仕組みについては、次の詳しい解説をご覧ください: [Hugging Face + W\&B Report](https://app.wandb.ai/jxmorris12/huggingface-demo/reports/Train-a-model-with-Hugging-Face-and-Weights-%26-Biases--VmlldzoxMDE2MTU).

<div id="install-import-and-log-in">
  ## インストール、インポート、ログイン
</div>

このチュートリアルで使用する Hugging Face と W\&B のライブラリ、GLUE データセット、トレーニング スクリプトをインストールします。

* [Hugging Face Transformers](https://github.com/huggingface/transformers): 自然言語モデルとデータセット
* [W\&B](/ja/): 実験管理と可視化
* [GLUE dataset](https://gluebenchmark.com/): 言語理解ベンチマーク用データセット
* [GLUE script](https://raw.githubusercontent.com/huggingface/transformers/refs/heads/main/examples/pytorch/text-classification/run_glue.py): シーケンス分類のモデル トレーニング スクリプト

```notebook theme={null}
!pip install datasets wandb evaluate accelerate -qU
!wget https://raw.githubusercontent.com/huggingface/transformers/refs/heads/main/examples/pytorch/text-classification/run_glue.py
```

```notebook theme={null}
# run_glue.py スクリプトには transformers の開発版が必要です
!pip install -q git+https://github.com/huggingface/transformers
```

続行する前に、[無料アカウントにサインアップしてください](https://app.wandb.ai/login?signup=true)。

<div id="put-in-your-api-key">
  ## APIキーを入力
</div>

登録後、次のセルを実行し、リンクをクリックしてAPIキーを取得し、このノートブックを認証してください。

```python theme={null}
import wandb
wandb.login()
```

必要に応じて、環境変数を設定して W\&B のログ記録をカスタマイズできます。詳しくは、[Hugging Face インテグレーションガイド](/ja/models/integrations/huggingface/)を参照してください。

```python theme={null}
# オプション: gradientとパラメーターの両方をログする
%env WANDB_WATCH=all
```

<div id="train-the-model">
  ## モデルをトレーニングする
</div>

次に、ダウンロードしたトレーニングスクリプト [run\_glue.py](https://huggingface.co/transformers/examples.html#glue) を実行し、トレーニングの内容が自動的に W\&B ダッシュボードにトラッキングされることを確認します。このスクリプトは、意味的に同等かどうかを示す人によるアノテーションが付いた文のペアで構成される Microsoft Research Paraphrase Corpus で、BERT をファインチューニングします。

```python theme={null}
%env WANDB_PROJECT=huggingface-demo
%env TASK_NAME=MRPC

!python run_glue.py \
  --model_name_or_path bert-base-uncased \
  --task_name $TASK_NAME \
  --do_train \
  --do_eval \
  --max_seq_length 256 \
  --per_device_train_batch_size 32 \
  --learning_rate 2e-4 \
  --num_train_epochs 3 \
  --output_dir /tmp/$TASK_NAME/ \
  --overwrite_output_dir \
  --logging_steps 50
```

<div id="visualize-results-in-dashboard">
  ## ダッシュボードで結果を可視化する
</div>

上に表示されたリンクをクリックするか、[wandb.ai](https://app.wandb.ai)にアクセスすると、結果がリアルタイムで反映される様子を確認できます。ブラウザでrunを表示するためのリンクは、すべての依存関係が読み込まれたあとに表示されます。次の出力を探してください: "**wandb**: View run at \[固有のrunへのURL]"

**モデル性能を可視化する**
多数のExperimentsを横断して確認し、興味深い発見にズームインし、高次元データを可視化できます。

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-docs-sandboxes-integrations-placement/SNVYl3A1VGlNmCKT/images/tutorials/huggingface-visualize.gif?s=ded44b086cff90bfd97249e18903f7f3" alt="モデルのメトリクス ダッシュボード" width="1986" height="1420" data-path="images/tutorials/huggingface-visualize.gif" />
</Frame>

**アーキテクチャを比較する**
これは、[BERT と DistilBERT の比較](https://app.wandb.ai/jack-morris/david-vs-goliath/reports/Does-model-size-matter%3F-Comparing-BERT-and-DistilBERT-using-Sweeps--VmlldzoxMDUxNzU)の例です。自動生成される折れ線グラフにより、トレーニング全体を通して異なるアーキテクチャが評価精度にどのような影響を与えるかを簡単に確認できます。

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-docs-sandboxes-integrations-placement/SNVYl3A1VGlNmCKT/images/tutorials/huggingface-comparearchitectures.gif?s=f89f8382c44bdcc64c29987d0adf2f1a" alt="BERT と DistilBERT の比較" width="1638" height="878" data-path="images/tutorials/huggingface-comparearchitectures.gif" />
</Frame>

<div id="track-key-information-effortlessly-by-default">
  ## デフォルトで重要な情報を簡単にトラッキング
</div>

W\&B では、実験ごとに新しい run が保存されます。デフォルトで保存される情報は次のとおりです。

* **ハイパーパラメーター**: モデルの設定は Config に保存されます
* **モデルのメトリクス**: ストリーミングされるメトリクスの時系列データは Log に保存されます
* **ターミナルログ**: コマンドラインの出力は保存され、タブで確認できます
* **システムメトリクス**: GPU と CPU の使用率、メモリ、温度など

<div id="learn-more">
  ## 詳細はこちら
</div>

* [YouTubeの解説動画](http://wandb.me/youtube)
