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

# モデルをログする

> モデル アーティファクトを W&B run にログし、後で log_model と use_model SDK メソッドを使用して取得します。

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/ken-add-new-model-reg-api/colabs/wandb-model-registry/New_Model_Logging_in_W&B.ipynb" />

<h1 id="log-models">
  モデルをログする
</h1>

以下のガイドでは、W\&B run にモデルをログする方法と、それらを操作する方法について説明します。

<Note>
  以下の API は、実験管理ワークフローの一部としてモデルを追跡するのに役立ちます。このページに記載されている API を使用して、run にモデルをログし、メトリクス、表、メディア、その他のオブジェクトにアクセスします。

  W\&B では、以下のような場合に [W\&B Artifacts](/ja/products/wandb/artifacts) の使用をおすすめします:

  * データセットやプロンプトなど、モデル以外のシリアライズされたデータのさまざまなバージョンを作成および追跡する場合。
  * W\&B で追跡されたモデルまたはその他のオブジェクトの [リネージ グラフ](/ja/products/wandb/artifacts/explore-and-traverse-an-artifact-graph) を探索する場合。
  * これらのメソッドが作成したモデル アーティファクトを操作する場合、たとえば [プロパティの更新](/ja/products/wandb/artifacts/update-an-artifact) (メタデータ、エイリアス、説明) など。

  W\&B Artifacts と高度なバージョン管理のユースケースの詳細については、[Artifacts](/ja/products/wandb/artifacts) のドキュメントを参照してください。
</Note>

<h2 id="log-a-model-to-a-run">
  モデルを run にログする
</h2>

[`log_model`](/ja/products/wandb/ref/python/experiments/run#log_model) を使用して、指定したディレクトリ内のコンテンツを含むモデル アーティファクトをログします。[`log_model`](/ja/products/wandb/ref/python/experiments/run#log_model) メソッドは、作成されたモデル アーティファクトを W\&B run の出力としてもマークします。

モデルを W\&B run の入力または出力としてマークすると、モデルの依存関係や関連付けをトラッキングできます。W\&B のアプリ UI でモデルのリネージを確認できます。詳細については、[Artifacts](/ja/products/wandb/artifacts) の章にある[アーティファクト グラフの探索と走査](/ja/products/wandb/artifacts/explore-and-traverse-an-artifact-graph)ページを参照してください。

モデルファイルの保存先のパスを `path` パラメーターに指定します。パスには、ローカルファイル、ディレクトリ、または `s3://bucket/path` のような外部バケットへの[参照 URI](/ja/products/wandb/artifacts/track-external-files#amazon-s3--gcs--azure-blob-storage-references) を指定できます。

`<>` で囲まれた値は、必ずご自身の値に置き換えてください。

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

必要に応じて、`name` パラメーターにモデル アーティファクトの名を指定します。`name` を指定しない場合、W\&B は入力パスの basename の先頭に run ID を付けたものを名として使用します。

<Note>
  自分または W\&B がモデルに割り当てた `name` を控えておいてください。[`wandb.Run.use_model()`](/ja/products/wandb/ref/python/experiments/run#use_model) メソッドでモデルのパスを取得する際に、モデル名が必要になります。
</Note>

パラメーターについては、API リファレンスの [`log_model`](/ja/products/wandb/ref/python/experiments/run#log_model) を参照してください。

<details>
  <summary>例: モデルを run にログする</summary>

  ```python theme={"system"}
  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` という名のモデル アーティファクトが作成され、ファイル `model.h5` がそのモデル アーティファクトに追加されます。ターミナルまたはノートブックには、モデルのログ先の run に関する情報を確認できる場所が表示されます。

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

<h2 id="download-and-use-a-logged-model">
  ログされたモデルのダウンロードと使用
</h2>

[`use_model`](/ja/products/wandb/ref/python/experiments/run#use_model) 関数を使用して、以前に W\&B run にログされたモデルファイルにアクセスしてダウンロードします。

取得したいモデルファイルが保存されているモデル アーティファクトの名を指定します。指定する名は、既存のログされたモデル アーティファクトの名と一致する必要があります。

`log_model` でファイルを元にログする際に `name` を定義しなかった場合、割り当てられるデフォルトの名は、入力パスの basename に run ID を前置したものです。

`<>` で囲まれた値を自分の値に置き換えてください：

```python theme={"system"}
import wandb

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

    # モデルにアクセスしてダウンロードします。ダウンロードしたアーティファクトへのパスを返します
    downloaded_model_path = run.use_model(name="<your-model-name>")
```

[use\_model](/ja/products/wandb/ref/python/experiments/run#use_model) 関数は、ダウンロードしたモデルファイルのパスを返します。このモデルを後でリンクしたい場合は、このパスを記録しておいてください。前のスニペットでは、返されたパスが `downloaded_model_path` という変数に格納されています。

<details>
  <summary>例: ログされたモデルのダウンロードと使用</summary>

  次のスニペットでは、ユーザーが `use_model` API を呼び出しました。取得したいモデル アーティファクトの名を指定し、バージョン/エイリアスも指定しています。その後、API から返されたパスを `downloaded_model_path` 変数に格納しています。

  ```python theme={"system"}
  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:
      # モデルにアクセスしてダウンロードします。ダウンロードしたアーティファクトへのパスを返します
      downloaded_model_path = run.use_model(name = f"{model_artifact_name}:{alias}") 
  ```
</details>

パラメーターと戻り値のタイプについては、API リファレンスの [`use_model`](/ja/products/wandb/ref/python/experiments/run#use_model) を参照してください。
