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

> W&B を使って OpenAI モデルをファインチューニングし、トレーニングメトリクスをログして、ジョブを監視し、経時的なモデル性能を比較します。

# OpenAI ファインチューニング

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://wandb.me/openai-colab" />

OpenAI GPT-3.5 または GPT-4 モデルのファインチューニングに関するメトリクスと設定を W\&B にログします。W\&B エコシステムを活用して、ファインチューニングの実験、モデル、データセットをトラッキングし、結果を同僚と共有できます。

<Note>
  ファインチューニング可能なモデルの一覧については、[OpenAI ドキュメント](https://platform.openai.com/docs/guides/fine-tuning/which-models-can-be-fine-tuned)を参照してください。
</Note>

OpenAI でのファインチューニングに W\&B を統合する方法についての補足情報は、OpenAI ドキュメントの [W\&B Integration](https://developers.openai.com/cookbook/examples/third_party/gpt_finetuning_with_wandb) セクションを参照してください。

<div id="install-or-update-openai-python-api">
  ## OpenAI Python API をインストールまたは更新する
</div>

W\&B の OpenAI ファインチューニング インテグレーションは、OpenAI バージョン 1.0 以降に対応しています。最新バージョンについては、[OpenAI Python API](https://pypi.org/project/openai/) ライブラリの PyPI ドキュメントを参照してください。

OpenAI Python API をインストールするには、次を実行します。

```python theme={null}
pip install openai
```

OpenAI Python API がすでにインストールされている場合は、以下のコマンドで更新できます。

```python theme={null}
pip install -U openai
```

<div id="sync-your-openai-fine-tuning-results">
  ## OpenAI のファインチューニング結果を Sync する
</div>

OpenAI のファインチューニング API と W\&B を統合し、ファインチューニングのメトリクスと設定を W\&B にログします。これを行うには、`wandb.integration.openai.fine_tuning` モジュールの `WandbLogger` クラスを使用します。

```python theme={null}
from wandb.integration.openai.fine_tuning import WandbLogger

# ファインチューニングのロジック

WandbLogger.sync(fine_tune_job_id=FINETUNE_JOB_ID)
```

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-dbrian-docs-serverless-training-quickstart/t_irD8W7hYE5fbdi/images/integrations/open_ai_auto_scan.png?fit=max&auto=format&n=t_irD8W7hYE5fbdi&q=85&s=d13a9a8f725e27e93fa6fb126bc291f6" alt="OpenAI の自動スキャン機能" width="1600" height="779" data-path="images/integrations/open_ai_auto_scan.png" />
</Frame>

<div id="sync-your-fine-tunes">
  ### ファインチューニングをSyncする
</div>

スクリプトから結果をSyncする

```python theme={null}
from wandb.integration.openai.fine_tuning import WandbLogger

# 1行のコマンド
WandbLogger.sync()

# オプションのパラメーターを渡す
WandbLogger.sync(
    fine_tune_job_id=None,
    num_fine_tunes=None,
    project="OpenAI-Fine-Tune",
    entity=None,
    overwrite=False,
    model_artifact_name="model-metadata",
    model_artifact_type="model",
    **kwargs_wandb_init
)
```

<div id="reference">
  ### リファレンス
</div>

| Argument                | Description                                                                                                                                                                                                                       |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| fine\_tune\_job\_id     | `client.fine_tuning.jobs.create` を使用してファインチューニング ジョブを作成したときに取得する OpenAI Fine-Tune ID です。この引数が None (デフォルト) の場合、まだ Sync されていないすべての OpenAI ファインチューニング ジョブが W\&B に Sync されます。                                                        |
| openai\_client          | 初期化済みの OpenAI クライアントを `sync` に渡します。クライアントが指定されていない場合は、ロガー自身がクライアントを初期化します。デフォルトでは None です。                                                                                                                                        |
| num\_fine\_tunes        | ID が指定されていない場合、まだ Sync されていないすべてのファインチューニングが W\&B にログされます。この引数を使用すると、Sync する直近のファインチューニング数を選択できます。num\_fine\_tunes が 5 の場合、直近 5 件のファインチューニングが選択されます。                                                                              |
| project                 | ファインチューニングのメトリクス、モデル、データなどがログされる W\&B プロジェクト名です。デフォルトのプロジェクト名は "OpenAI-Fine-Tune" です。                                                                                                                                             |
| entity                  | run の送信先となる W\&B ユーザー名またはチーム名です。デフォルトでは、通常はユーザー名であるデフォルトの entity が使用されます。                                                                                                                                                         |
| overwrite               | 強制的にログを行い、同じファインチューニング ジョブに対応する既存の wandb run を上書きします。デフォルトでは False です。                                                                                                                                                            |
| wait\_for\_job\_success | OpenAI のファインチューニング ジョブは、開始後に完了まで少し時間がかかるのが一般的です。ファインチューニング ジョブの完了後できるだけ早くメトリクスを W\&B にログするため、この設定では 60 秒ごとにファインチューニング ジョブのステータスが `succeeded` に変わったかどうかを確認します。ファインチューニング ジョブの成功が検出されると、メトリクスは自動的に W\&B に Sync されます。デフォルトは True です。 |
| model\_artifact\_name   | ログされるモデル artifact の名前です。デフォルトは `"model-metadata"` です。                                                                                                                                                                             |
| model\_artifact\_type   | ログされるモデル artifact のタイプです。デフォルトは `"model"` です。                                                                                                                                                                                     |
| \*\*kwargs\_wandb\_init | [`wandb.init()`](/ja/models/ref/python/functions/init) に直接渡される追加の引数                                                                                                                                                               |

<div id="dataset-versioning-and-visualization">
  ## データセットのバージョン管理と可視化
</div>

<div id="versioning">
  ### バージョン管理
</div>

ファインチューニングのためにOpenAIへアップロードするトレーニングデータと検証データは、バージョン管理をしやすくするために、自動的にW\&B Artifactsにログされます。以下は、Artifacts内のトレーニングファイルの表示例です。ここでは、このファイルをログしたW\&B run、ログされた日時、このデータセットのバージョン、メタデータ、そしてトレーニングデータからトレーニング済みモデルまでのDAGリネージを確認できます。

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-dbrian-docs-serverless-training-quickstart/t_irD8W7hYE5fbdi/images/integrations/openai_data_artifacts.png?fit=max&auto=format&n=t_irD8W7hYE5fbdi&q=85&s=fcd18af8d97e34f7423c84ab894b4467" alt="トレーニングデータセットを含むW&B Artifacts" width="3450" height="1166" data-path="images/integrations/openai_data_artifacts.png" />
</Frame>

<div id="visualization">
  ### 可視化
</div>

データセットは W\&B Tables で可視化され、データセットの探索、検索、操作を行えます。以下では、W\&B Tables を使って可視化したトレーニングサンプルを確認できます。

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-dbrian-docs-serverless-training-quickstart/t_irD8W7hYE5fbdi/images/integrations/openai_data_visualization.png?fit=max&auto=format&n=t_irD8W7hYE5fbdi&q=85&s=c169b44dd5bf40beceffd6bbfffd30c2" alt="OpenAI データ" width="2758" height="1294" data-path="images/integrations/openai_data_visualization.png" />
</Frame>

<div id="the-fine-tuned-model-and-model-versioning">
  ## ファインチューニングしたモデルとモデルのバージョン管理
</div>

OpenAI は、ファインチューニングしたモデルの ID を返します。モデルの重みにはアクセスできないため、`WandbLogger` は `fine_tuned_model`` ID` と、モデルのすべての詳細 (ハイパーパラメーター、データファイル ID など) を含む `model_metadata.json` ファイルを作成し、これを W\&B Artifact としてログします。

このモデル (メタデータ) の Artifact は、さらに [W\&B Registry](/ja/models/registry/) 内のモデルにリンクできます。

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-dbrian-docs-serverless-training-quickstart/t_irD8W7hYE5fbdi/images/integrations/openai_model_metadata.png?fit=max&auto=format&n=t_irD8W7hYE5fbdi&q=85&s=bce18fe1b20b6d87ad888d00ea1d99b0" alt="OpenAI モデルのメタデータ" width="3450" height="1512" data-path="images/integrations/openai_model_metadata.png" />
</Frame>

<div id="frequently-asked-questions">
  ## よくある質問
</div>

<div id="how-do-i-share-my-fine-tune-results-with-my-team-in-wb">
  ### W\&Bのチームでファインチューニング結果を共有するにはどうすればよいですか
</div>

次を使用して、ファインチューニング ジョブをチームアカウントにログしてください。

```python theme={null}
WandbLogger.sync(entity="YOUR_TEAM_NAME")
```

<div id="how-can-i-organize-my-runs">
  ### run を整理するにはどうすればよいですか？
</div>

W\&B の run は自動的に整理され、ジョブタイプ、base model、学習率、トレーニングファイル名、その他のハイパーパラメーターなど、任意の設定パラメーターに基づいてフィルターや並べ替えを行えます。

さらに、run の名前を変更したり、メモを追加したり、タグを作成してグループ化したりできます。

整理できたら、Workspace を保存し、それを使用して Reports を作成できます。run や保存済みの Artifacts (トレーニング/検証ファイル) からデータを取り込めます。

<div id="how-can-i-access-my-fine-tuned-model">
  ### ファインチューニングしたモデルにアクセスするにはどうすればよいですか？
</div>

ファインチューニングしたモデルのIDは、Artifacts (`model_metadata.json`) と設定の両方として W\&B にログされます。

```python theme={null}
import wandb
    
with wandb.init(project="OpenAI-Fine-Tune", entity="YOUR_TEAM_NAME") as run:
    ft_artifact = run.use_artifact("ENTITY/PROJECT/model_metadata:VERSION")
    artifact_dir = ft_artifact.download()
```

ここで `VERSION` には、次のいずれかを指定します:

* `v2` のようなバージョン番号
* `ft-xxxxxxxxx` のようなファインチューニング ID
* `latest` のように自動で追加されたエイリアス、または手動で追加したエイリアス

その後、ダウンロードした `model_metadata.json` ファイルを読み取ることで、`fine_tuned_model` ID を取得できます。

<div id="what-if-a-fine-tune-was-not-synced-successfully">
  ### ファインチューニング の Sync に失敗した場合はどうなりますか？
</div>

ファインチューニング の情報が W\&B に正常にログされなかった場合は、`overwrite=True` を使用し、ファインチューニング のジョブ ID を渡すことができます。

```python theme={null}
WandbLogger.sync(
    fine_tune_job_id="FINE_TUNE_JOB_ID",
    overwrite=True,
)
```

<div id="can-i-track-my-datasets-and-models-with-wb">
  ### W\&B でデータセットとモデルをトラッキングできますか？
</div>

トレーニングデータと検証データは、自動的に Artifacts として W\&B にログされます。ファインチューニングしたモデルの ID を含むメタデータも、Artifacts としてログされます。

`wandb.Artifact` や `wandb.Run.log` などの低レベルの wandb API を使えば、いつでもパイプラインを制御できます。これにより、データとモデルを完全に追跡可能にできます。

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-dbrian-docs-serverless-training-quickstart/t_irD8W7hYE5fbdi/images/integrations/open_ai_faq_can_track.png?fit=max&auto=format&n=t_irD8W7hYE5fbdi&q=85&s=5600b0a79ac163f36edadfa0d919b2eb" alt="OpenAI のトラッキングに関する FAQ" width="1088" height="260" data-path="images/integrations/open_ai_faq_can_track.png" />
</Frame>

<div id="resources">
  ## リソース
</div>

* [OpenAIのファインチューニング ドキュメント](https://platform.openai.com/docs/guides/fine-tuning/) は非常に詳しく、役立つヒントが数多く載っています
* [デモ用Colab](https://wandb.me/openai-colab)
* [W\&B を使った OpenAI GPT-3.5 と GPT-4 モデルのファインチューニング方法](https://wandb.me/openai-report) レポート
