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

# Hugging Face

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

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

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

## なぜ W\&B を使うべきなのか？

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-serverless-sft-revamp/k60V_Bn1-o89Fhr9/images/tutorials/huggingface-why.png?fit=max&auto=format&n=k60V_Bn1-o89Fhr9&q=85&s=5ece2d47d1dad38766e378726c303f51" alt="Benefits of using W&B" width="4672" height="816" data-path="images/tutorials/huggingface-why.png" />
</Frame>

* **統合されたダッシュボード**: すべてのモデルメトリクスと予測を保存する中央リポジトリ
* **軽量**: Hugging Face と統合するためにコードを変更する必要はありません
* **アクセシビリティ**: 個人やアカデミックチームは無料で利用可能
* **セキュア**: すべてのプロジェクトはデフォルトでプライベート設定
* **信頼性**: OpenAI、Toyota、Lyft などの機械学習チームによって使用されています

W\&B は機械学習モデルのための GitHub のようなものだと考えてください。機械学習の実験を、ホストされたプライベートなダッシュボードに保存できます。スクリプトを実行する場所を問わず、すべてのバージョンのモデルが保存されているという安心感を持って、迅速に実験を行うことができます。

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

Hugging Face Transformers リポジトリでは、各ロギングステップでトレーニングおよび評価メトリクスを自動的に 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)

## インストール、インポート、ログイン

このチュートリアルのために、Hugging Face と W\&B のライブラリ、GLUE データセット、およびトレーニングスクリプトをインストールします。

* [Hugging Face Transformers](https://github.com/huggingface/transformers): 自然言語モデルとデータセット
* [W\&B](/): 実験管理と可視化
* [GLUE データセット](https://gluebenchmark.com/): 言語理解のベンチマークデータセット
* [GLUE スクリプト](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 の dev 版が必要です
!pip install -q git+https://github.com/huggingface/transformers
```

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

## APIキーの設定

登録が完了したら、次のセルを実行し、リンクをクリックして API キーを取得し、このノートブックを認証します。

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

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

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

## モデルのトレーニング

次に、ダウンロードしたトレーニングスクリプト [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
```

## ダッシュボードで結果を可視化

上に表示されたリンクをクリックするか、 [wandb.ai](https://app.wandb.ai) にアクセスして、結果がライブでストリーミングされるのを確認してください。ブラウザで run を表示するためのリンクは、すべての依存関係がロードされた後に表示されます。次の出力を探してください: "**wandb**: View run at \[URL to your unique run]"

**モデルパフォーマンスの可視化**
数十もの実験を見渡し、興味深い発見をズームアップし、高次元データを可視化することが簡単にできます。

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-serverless-sft-revamp/k60V_Bn1-o89Fhr9/images/tutorials/huggingface-visualize.gif?s=628e3899e39a1b238f13e6893535c574" alt="Model metrics dashboard" width="1986" height="1420" data-path="images/tutorials/huggingface-visualize.gif" />
</Frame>

**アーキテクチャーの比較**
こちらは [BERT vs 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-serverless-sft-revamp/k60V_Bn1-o89Fhr9/images/tutorials/huggingface-comparearchitectures.gif?s=a45a86bbafe4cfaf33d616f02e9d053d" alt="BERT vs DistilBERT comparison" width="1638" height="878" data-path="images/tutorials/huggingface-comparearchitectures.gif" />
</Frame>

## 重要な情報をデフォルトで手間なくトラッキング

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

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

## 詳細を見る

* [Hugging Face インテグレーションガイド](/models/integrations/huggingface)
* [YouTube の動画ガイド](http://wandb.me/youtube)
