> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-update-reference-docs-40.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# モデルをログする
> モデル artifact を W&B の run にログし、後で SDK の `log_model` method と `use_model` method を使用して取得します。
export const ColabLink = ({url}) =>
Colabで試す
;
# モデルをログする
このガイドでは、モデルを W\&B の run にログし、それらを操作する方法について説明します。
以下の API は、実験管理ワークフローの一環としてモデルをトラッキングする際に役立ちます。このページに記載されている API を使用して、モデルを run にログし、メトリクス、表、メディア、その他のオブジェクトにアクセスできます。
次のことを行いたい場合は、[W\&B Artifacts](/ja/models/artifacts/) の使用をおすすめします。
* データセットやプロンプトなど、モデル以外のシリアライズされたデータの異なるバージョンを作成して追跡する。
* モデルや、W\&B でトラッキングされているその他のオブジェクトの [リネージグラフ](/ja/models/artifacts/explore-and-traverse-an-artifact-graph/) を探索する。
* これらの method で作成されたモデル artifact を操作する。たとえば、[プロパティの更新](/ja/models/artifacts/update-an-artifact/) (メタデータ、alias、説明) など。
W\&B Artifacts と高度なバージョン管理のユースケースについて詳しくは、[Artifacts](/ja/models/artifacts/) のドキュメントを参照してください。
## モデルをrunにログする
指定したディレクトリー内の内容を含むモデルartifactをログするには、[`log_model`](/ja/models/ref/python/experiments/run#log_model) を使用します。[`log_model`](/ja/models/ref/python/experiments/run#log_model) methodは、生成されたモデルartifactを W\&B run の出力としてもマークします。
モデルを W\&B run の入力または出力としてマークすると、そのモデルの dependencies や関連付けをトラッキングできます。モデルのリネージは W\&B App UI で確認できます。詳細は、[Artifacts](/ja/models/artifacts/) 章の [Explore and traverse artifact graphs](/ja/models/artifacts/explore-and-traverse-an-artifact-graph/) ページを参照してください。
モデルファイルが保存されているパスを `path` パラメーターに指定します。パスには、ローカルファイル、ディレクトリー、または `s3://bucket/path` のような external cloud storage bucket への [reference URI](/ja/models/artifacts/track-external-files/#amazon-s3--gcs--azure-blob-storage-references) を指定できます。
`<>` で囲まれた値は、ご自身の値に置き換えてください。
```python theme={null}
import wandb
# W&B run を初期化する
with wandb.init(project="", entity="") as run:
# モデルをログする
run.log_model(path="", name="")
```
必要に応じて、モデルartifactの名前を `name` パラメーターに指定できます。`name` を指定しない場合、W\&B は入力パスの basename の先頭に run ID を付加したものを名前として使用します。
あなたまたは W\&B がモデルに割り当てた `name` を控えておいてください。[`wandb.Run.use_model()`](/ja/models/ref/python/experiments/run#use_model) method を使用してモデルパスを取得するには、モデルの名前が必要です。
パラメーターについては、APIリファレンス の [`log_model`](/ja/models/ref/python/experiments/run#log_model) を参照してください。
例: モデルを run にログする
```python theme={null}
import os
import wandb
from tensorflow import keras
from tensorflow.keras import layers
config = {"optimizer": "adam", "loss": "categorical_crossentropy"}
# W&B run を初期化する
with wandb.init(entity="charlie", project="mnist-experiments", config=config) as run:
# ハイパーパラメーター
loss = run.config["loss"]
optimizer = run.config["optimizer"]
metrics = ["accuracy"]
num_classes = 10
input_shape = (28, 28, 1)
# トレーニングアルゴリズム
model = keras.Sequential(
[
layers.Input(shape=input_shape),
layers.Conv2D(32, kernel_size=(3, 3), activation="relu"),
layers.MaxPooling2D(pool_size=(2, 2)),
layers.Conv2D(64, kernel_size=(3, 3), activation="relu"),
layers.MaxPooling2D(pool_size=(2, 2)),
layers.Flatten(),
layers.Dropout(0.5),
layers.Dense(num_classes, activation="softmax"),
]
)
# モデルをトレーニング用に設定する
model.compile(loss=loss, optimizer=optimizer, metrics=metrics)
# モデルを保存する
model_filename = "model.h5"
local_filepath = "./"
full_path = os.path.join(local_filepath, model_filename)
model.save(filepath=full_path)
# モデルを W&B run にログする
run.log_model(path=full_path, name="MNIST")
```
`wandb.Run.log_model()` を呼び出すと、`MNIST` という名前のモデルartifactが作成され、ファイル `model.h5` がそのモデルartifactに追加されます。ターミナルまたはノートブックには、モデルがログされた run の情報をどこで確認できるかが出力されます。
```python theme={null}
View run different-surf-5 at: https://wandb.ai/charlie/mnist-experiments/runs/wlby6fuw
Synced 5 W&B file(s), 0 media file(s), 1 artifact file(s) and 0 other file(s)
Find logs at: ./wandb/run-20231206_103511-wlby6fuw/logs
```
## ログ済みのモデルをダウンロードして使用する
以前に W\&B run にログしたモデルファイルにアクセスしてダウンロードするには、[`use_model`](/ja/models/ref/python/experiments/run#use_model) 関数を使用します。
取得したいモデルファイルが保存されているモデル artifact の名前を指定します。指定する名前は、既存のログ済みモデル artifact の名前と一致している必要があります。
`log_model` でファイルを最初にログしたときに `name` を定義していない場合、デフォルトで割り当てられる名前は、入力パスの basename の先頭に run ID を付けたものになります。
`<>` で囲まれた値は、ご自身の値に置き換えてください。
```python theme={null}
import wandb
# runを初期化する
with wandb.init(project="", entity="") as run:
# モデルにアクセスしてダウンロードする。ダウンロードしたartifactのパスを返す
downloaded_model_path = run.use_model(name="")
```
[use\_model](/ja/models/ref/python/experiments/run#use_model) 関数は、ダウンロードしたモデルファイルのパスを返します。後でこのモデルを関連付けたい場合は、このパスを控えておいてください。前のコードスニペットでは、返されたパスは `downloaded_model_path` という変数に保存されています。
例: ログ済みモデルをダウンロードして使用する
たとえば、次のコードスニペットでは、あるユーザーが `use_model` API を呼び出しています。取得したいモデル artifact の名前を指定し、バージョン / alias も指定しています。その後、API から返されたパスを `downloaded_model_path` 変数に保存しています。
```python theme={null}
import wandb
entity = "luka"
project = "NLP_Experiments"
alias = "latest" # モデルバージョンの意味的なニックネームまたは識別子
model_artifact_name = "fine-tuned-model"
# run を初期化します
with wandb.init(project=project, entity=entity) as run:
# モデルにアクセスしてダウンロードします。ダウンロードした artifact へのパスを返します
downloaded_model_path = run.use_model(name = f"{model_artifact_name}:{alias}")
```
パラメーターと戻り値のタイプについては、APIリファレンス の [`use_model`](/ja/models/ref/python/experiments/run#use_model) を参照してください。