メインコンテンツへスキップ

​
モデルをログする

このガイドでは、モデルを W&B の run にログし、それらを操作する方法について説明します。
以下の API は、実験管理ワークフローの一環としてモデルをトラッキングする際に役立ちます。このページに記載されている API を使用して、モデルを run にログし、メトリクス、表、メディア、その他のオブジェクトにアクセスできます。次のことを行いたい場合は、W&B Artifacts の使用をおすすめします。
  • データセットやプロンプトなど、モデル以外のシリアライズされたデータの異なるバージョンを作成して追跡する。
  • モデルや、W&B でトラッキングされているその他のオブジェクトの リネージグラフ を探索する。
  • これらの method で作成されたモデル artifact を操作する。たとえば、プロパティの更新 (メタデータ、alias、説明) など。
W&B Artifacts と高度なバージョン管理のユースケースについて詳しくは、Artifacts のドキュメントを参照してください。

​
モデルをrunにログする

指定したディレクトリー内の内容を含むモデルartifactをログするには、log_model を使用します。log_model methodは、生成されたモデルartifactを W&B run の出力としてもマークします。 モデルを W&B run の入力または出力としてマークすると、そのモデルの dependencies や関連付けをトラッキングできます。モデルのリネージは W&B App UI で確認できます。詳細は、Artifacts 章の Explore and traverse artifact graphs ページを参照してください。 モデルファイルが保存されているパスを path パラメーターに指定します。パスには、ローカルファイル、ディレクトリー、または s3://bucket/path のような external cloud storage bucket への reference URI を指定できます。 <> で囲まれた値は、ご自身の値に置き換えてください。 
import wandb

# W&B run を初期化する
with wandb.init(project="<your-project>", entity="<your-entity>") as run:

    # モデルをログする
    run.log_model(path="<path-to-model>", name="<name>")
必要に応じて、モデルartifactの名前を name パラメーターに指定できます。name を指定しない場合、W&B は入力パスの basename の先頭に run ID を付加したものを名前として使用します。
あなたまたは W&B がモデルに割り当てた name を控えておいてください。wandb.Run.use_model() method を使用してモデルパスを取得するには、モデルの名前が必要です。
パラメーターについては、APIリファレンス の log_model を参照してください。

​
ログ済みのモデルをダウンロードして使用する

以前に W&B run にログしたモデルファイルにアクセスしてダウンロードするには、use_model 関数を使用します。 取得したいモデルファイルが保存されているモデル artifact の名前を指定します。指定する名前は、既存のログ済みモデル artifact の名前と一致している必要があります。 log_model でファイルを最初にログしたときに name を定義していない場合、デフォルトで割り当てられる名前は、入力パスの basename の先頭に run ID を付けたものになります。 <> で囲まれた値は、ご自身の値に置き換えてください。 
import wandb

# runを初期化する
with wandb.init(project="<your-project>", entity="<your-entity>") as run:

    # モデルにアクセスしてダウンロードする。ダウンロードしたartifactのパスを返す
    downloaded_model_path = run.use_model(name="<your-model-name>")
use_model 関数は、ダウンロードしたモデルファイルのパスを返します。後でこのモデルを関連付けたい場合は、このパスを控えておいてください。前のコードスニペットでは、返されたパスは downloaded_model_path という変数に保存されています。 パラメーターと戻り値のタイプについては、APIリファレンス の use_model を参照してください。