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

# Hugging Face

> W&B で Hugging Face モデルのパフォーマンスを可視化・追跡し、Hyperparameters、指標、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>
    Try in Colab
  </a>;

<ColabLink url="https://colab.research.google.com/github/wandb/examples/blob/master/colabs/huggingface/Huggingface_wandb.ipynb" />

このチュートリアルでは、W\&B と [Hugging Face Transformers](https://github.com/huggingface/transformers) のインテグレーションを使用して、モデルのファインチューニング中に学習および評価の指標、Hyperparameters、システム統計情報を自動的に記録する方法を紹介します。このチュートリアルを通じて、[W\&B](https://wandb.ai/site) ダッシュボードでモデルのパフォーマンスを可視化し、実験を比較しながら自信を持ってモデルを改善していく方法を習得できます。

Hyperparameters、出力指標、GPU 使用率などのシステム統計情報を、モデル間で比較できます。

<h2 id="why-use-wb">
  W\&B を使用する理由
</h2>

<Frame>
  <img src="https://mintcdn.com/coreweave-dbfa0e8d/3Dv_sw2eg8feUJlx/products/wandb/_media/huggingface-why.png?fit=max&auto=format&n=3Dv_sw2eg8feUJlx&q=85&s=7bc6de71cf51f9fd1c36822fb2d250c2" alt="W&B を使用するメリット" width="4672" height="816" data-path="products/wandb/_media/huggingface-why.png" />
</Frame>

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

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

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

Hugging Face Transformers リポジトリでは、W\&B によって Trainer がインストルメントされており、ログするステップごとにトレーニングメトリクスと評価メトリクスが W\&B に自動的にログされます。

インテグレーションの仕組みの詳細については、[Hugging Face + W\&B Report](https://forge.coreweave.com/wandb/jxmorris12/huggingface-demo/reports/Train-a-model-with-Hugging-Face-and-Weights-%26-Biases--VmlldzoxMDE2MTU) を参照してください。

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

このセクションでは、チュートリアルの実行に必要な環境をセットアップします。Hugging Face と W\&B のライブラリをインストールし、このチュートリアルで使用する GLUE データセットとトレーニングスクリプトをダウンロードします。

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

```notebook theme={"system"}
!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={"system"}
# run_glue.py スクリプトの実行には transformers の開発版が必要です
!pip install -q git+https://github.com/huggingface/transformers
```

続行する前に、[無料アカウントにサインアップ](https://id.coreweave.com/signup)してください。run のデータを W\&B のダッシュボードに送信するには、アカウントが必要です。

<h2 id="add-your-api-key">
  APIキーを追加する
</h2>

APIキーで認証すると、このノートブックが W\&B アカウントにリンクされ、run が project にログされます。登録後、次のセルを実行し、リンクをクリックして APIキーを取得し、このノートブックを認証してください。

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

必要に応じて、環境変数を設定して、トレーニング中に W\&B がログする内容をカスタマイズできます。たとえば、`WANDB_WATCH=all` を設定すると、勾配とパラメーターの両方をログできます。オプションの全一覧については、[Hugging Face インテグレーションガイド](/ja/products/wandb/integrations/huggingface)を参照してください。

```python theme={"system"}
# 任意: 勾配とパラメーターの両方をログします
%env WANDB_WATCH=all
```

<h2 id="train-the-model">
  モデルのトレーニング
</h2>

環境の設定と認証が完了したら、トレーニング run を開始できます。ダウンロードしたトレーニングスクリプト [`run_glue.py`](https://huggingface.co/transformers/examples.html#glue) を実行して、トレーニングが自動的に W\&B ダッシュボードで追跡されることを確認してください。このスクリプトは、Microsoft Research Paraphrase Corpus (意味的に等価かどうかを示す人によるアノテーションが付いた文のペア) を使って BERT をファインチューンします。

```python theme={"system"}
%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
```

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

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

<h3 id="visualize-model-performance">
  モデル性能を可視化する
</h3>

実験全体を確認し、検出結果をズームインして、高次元データを可視化します。

<Frame>
  <img src="https://mintcdn.com/coreweave-dbfa0e8d/3Dv_sw2eg8feUJlx/products/wandb/_media/huggingface-visualize.gif?s=ae9650edbb25cb78139b0d97ec1cd51c" alt="モデルメトリクスダッシュボード" width="1986" height="1420" data-path="products/wandb/_media/huggingface-visualize.gif" />
</Frame>

<h3 id="compare-architectures">
  アーキテクチャの比較
</h3>

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

<Frame>
  <img src="https://mintcdn.com/coreweave-dbfa0e8d/3Dv_sw2eg8feUJlx/products/wandb/_media/huggingface-comparearchitectures.gif?s=ab50cf164f6be8a735a5b2fb106d8058" alt="BERT と DistilBERT の比較" width="1638" height="878" data-path="products/wandb/_media/huggingface-comparearchitectures.gif" />
</Frame>

<h2 id="track-key-information-by-default">
  主要な情報をデフォルトで記録する
</h2>

このセクションでは、W\&B が自動的に取得する内容を説明します。これにより、追加の設定を行わなくてもダッシュボードでどのデータを利用できるかを把握できます。W\&B は実験ごとに新しい run を保存します。デフォルトで保存される情報は次のとおりです。

* **Hyperparameters**: モデルの設定を Config に保存します。
* **モデルのメトリクス**: ストリーミングされるメトリクスの時系列データを Log に保存します。
* **ターミナルログ**: コマンドラインの出力を保存し、タブで参照できるようにします。
* **システムメトリクス**: GPU と CPU の使用率、メモリ、温度。

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

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


## Related topics

- [Introduction to third-party frameworks](/products/cks/clusters/frameworks/introduction.md)
