コレクションを作成する

A collection とは、レジストリ内でリンクされたアーティファクトバージョンのセットです。それぞれのコレクションは、個別のタスクやユースケースを表します。例えば、コアデータセットレジストリ内に複数のコレクションを持つことができます。それぞれのコレクションには、MNIST、CIFAR-10、ImageNet などの異なるデータセットが含まれます。別の例として、「chatbot」と呼ばれるレジストリがあり、そこにはモデルアーティファクトのコレクション、データセットアーティファクトのコレクション、およびファインチューンされたモデルアーティファクトのコレクションがあります。レジストリとそのコレクションの整理方法は、あなた次第です。

W&B モデルレジストリに精通している場合は、登録されたモデルについても知識があるかもしれません。モデルレジストリ内の登録されたモデルは、今後は W&B レジストリのコレクションと呼ばれます。

コレクションのタイプ

それぞれのコレクションは、一種類だけのアーティファクトのタイプを受け入れます。指定したタイプは、組織の他のメンバーと一緒にそのコレクションにリンクできるアーティファクトの種類を制限します。

アーティファクトのタイプは、プログラミング言語、例えば Python のデータタイプに似ています。この類推では、コレクションは文字列、整数、または浮動小数点数を格納できますが、これらのデータタイプの混合はできません。

例えば、「データセット」アーティファクトタイプを受け入れるコレクションを作成したとします。これにより、「データセット」タイプを持つ将来のアーティファクトバージョンのみをこのコレクションにリンクできます。同様に、「モデル」タイプのアーティファクトは、モデルアーティファクトタイプのみを受け入れるコレクションにのみリンクできます。

アーティファクトのタイプは、そのアーティファクトオブジェクトを作成するときに指定します。wandb.Artifact() 内の type フィールドに注意してください。

import wandb

# Run を初期化
run = wandb.init(
  entity = "<team_entity>",
  project = "<project>"
  )

# アーティファクトオブジェクトを作成
artifact = wandb.Artifact(
    name="<artifact_name>", 
    type="<artifact_type>"
    )

コレクションを作成するとき、事前に定義されたアーティファクトタイプのリストから選択できます。使用可能なアーティファクトタイプは、そのコレクションが所属するレジストリによります。アーティファクトをコレクションにリンクしたり新しいコレクションを作成する前に、そのコレクションが受け入れるアーティファクトのタイプを調査してください。

コレクションが受け入れるアーティファクトのタイプを確認する

コレクションにリンクする前に、コレクションが受け入れるアーティファクトタイプを確認してください。W&B Python SDK を使用してプログラム的に、もしくは W&B アプリを使用してインタラクティブに、コレクションが受け入れるアーティファクトタイプを確認することができます。

そのアーティファクトタイプを受け入れないコレクションにアーティファクトをリンクしようとすると、エラーメッセージが表示されます。

W&B App
Python SDK (Beta)

ホームページまたはレジストリの設定ページで、受け入れられるアーティファクトタイプをレジストリカードで見つけることができます。どちらのメソッドでも、まず W&B レジストリアプリに移動します。レジストリアプリのホームページでは、そのレジストリのレジストリカードにスクロールして、受け入れられたアーティファクトタイプを表示できます。レジストリカード内の灰色の水平オーバルには、レジストリが受け入れるアーティファクトタイプが記載されています。

例えば、前の図はレジストリアプリのホームページに複数のレジストリカードを示しています。Modelレジストリカード内で、2つのアーティファクトタイプ: model と model-new を見ることができます。レジストリの設定ページで受け入れられたアーティファクトタイプを表示するには:

設定を表示するレジストリカードをクリックします。
右上のギアアイコンをクリックします。
受け入れられたアーティファクトタイプ フィールドまでスクロールします。

コレクションが受け入れるアーティファクトのタイプを知ったら、コレクションを作成します。

レジストリ内でインタラクティブまたはプログラムでコレクションを作成します。コレクションを作成した後、そのコレクションが受け入れるアーティファクトのタイプを変更することはできません。

プログラム的にコレクションを作成する

wandb.init.link_artifact() メソッドを使用して、アーティファクトをコレクションにリンクします。target_path フィールドに、次の形式のパスとしてコレクションとレジストリの両方を指定します。

f"wandb-registry-{registry_name}/{collection_name}"

ここで、registry_name はレジストリの名前で、collection_name はコレクションの名前です。必ずレジストリ名の前に wandb-registry- プレフィックスを追加してください。

存在しないコレクションにアーティファクトをリンクしようとすると、W&B は自動的にコレクションを作成します。存在するコレクションを指定した場合、W&B はそのアーティファクトを既存のコレクションにリンクします。

次のコードスニペットは、プログラムでコレクションを作成する方法を示しています。他の <> で囲まれた値を必ず自分の値で置き換えてください。

import wandb

# Run を初期化
run = wandb.init(entity = "<team_entity>", project = "<project>")

# アーティファクトオブジェクトを作成
artifact = wandb.Artifact(
  name = "<artifact_name>",
  type = "<artifact_type>"
  )

registry_name = "<registry_name>"
collection_name = "<collection_name>"
target_path = f"wandb-registry-{registry_name}/{collection_name}"

# アーティファクトをコレクションにリンク
run.link_artifact(artifact = artifact, target_path = target_path)

run.finish()

インタラクティブにコレクションを作成する

以下のステップで、W&B レジストリアプリ UI を使用してレジストリ内にコレクションを作成する方法を説明します。

W&B アプリ UI の Registry アプリに移動します。
レジストリを選択します。
右上の Create collection ボタンをクリックします。
Name フィールドにコレクションの名前を入力します。
Type ドロップダウンからタイプを選択します。または、レジストリがカスタムアーティファクトタイプを有効にしている場合は、このコレクションが受け入れる1つ以上のアーティファクトタイプを提供します。
オプションで、Description フィールドにコレクションの説明を追加します。
オプションで、Tags フィールドに1つ以上のタグを追加します。
Link version をクリックします。
Project ドロップダウンから、アーティファクトが保存されているプロジェクトを選択します。
Artifact コレクションのドロップダウンからアーティファクトを選択します。
Version ドロップダウンから、コレクションにリンクしたいアーティファクトバージョンを選択します。
Create collection ボタンをクリックします。

W&B モデル

参照

​コレクションのタイプ

​コレクションが受け入れるアーティファクトのタイプを確認する