コレクションを作成する

コレクション とは、Registry 内にリンクされたアーティファクトのバージョンの集まりです。各コレクションは、それぞれ一意のタスクまたはユースケースを表します。たとえば、1 つの Registry 内に複数のコレクションを作成し、各コレクションに MNIST、CIFAR-10、ImageNet など、それぞれ異なるデータセットを格納できます。別の例として、「chatbot」という Registry を作成し、その中にモデルアーティファクト用、データセットアーティファクト用、ファインチューニングしたモデルのアーティファクト用のコレクションをそれぞれ用意することもできます。 Registry とそのコレクションをどのように整理するかは自由です。

W&B モデルレジストリをご存知の方は、Registered Models についてもご存知かもしれません。モデルレジストリの Registered Models は、Registry ではコレクションと呼ばれるようになりました。

コレクションタイプ

各コレクションが受け入れるアーティファクトのタイプは 1 つだけです。指定したタイプによって、自分や組織の他のメンバーがそのコレクションにリンクできるアーティファクトの種類が制限されます。

アーティファクトタイプは、Python などのプログラミング言語におけるデータタイプのようなものと考えるとわかりやすいでしょう。このたとえで言えば、コレクションには文字列、整数、浮動小数点数のいずれかを格納できますが、これらのデータタイプを混在させることはできません。

たとえば、“dataset” アーティファクトタイプを受け入れるコレクションを作成したとします。この場合、今後そのコレクションにリンクできるのは、タイプが “dataset” のアーティファクトのバージョンだけです。同様に、モデルアーティファクトタイプのみを受け入れるコレクションには、タイプが “model” のアーティファクトしかリンクできません。

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

import wandb

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

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

コレクションを作成する際は、事前定義されたアーティファクトタイプの一覧から選択できます。選択できるアーティファクトタイプは、そのコレクションが属する Registry によって異なります。アーティファクトをコレクションにリンクする前や、新しいコレクションを作成する前に、そのコレクションが受け入れるアーティファクトタイプを確認してください。

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

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

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

W&B App
W&B Python SDK (Beta)

受け入れ可能なアーティファクトタイプは、ホームページのRegistryカード、またはRegistryの設定ページで確認できます。どちらの方法でも、まず Registry にアクセスします。Registry のホームページで対象RegistryのRegistryカードまでスクロールすると、受け入れ可能なアーティファクトタイプを確認できます。Registryカード内にある灰色の横長の楕円に、そのRegistryが受け入れるアーティファクトタイプが表示されます。

Registryの設定ページで受け入れ可能なアーティファクトタイプを確認するには、次の手順に従います。

設定を確認したいRegistryのRegistryカードをクリックします。
右上の歯車アイコンをクリックします。
Accepted artifact types フィールドまでスクロールします。

W&B Python SDK を使用して、Registryが受け入れるアーティファクトタイプをプログラムで確認します。

import wandb

registry_name = "<registry_name>"
artifact_types = wandb.Api().project(name=f"wandb-registry-{registry_name}").artifact_types()
print(artifact_type.name for artifact_type in artifact_types)

以下のコードスニペットでは run を初期化しない点に注意してください。W&B API をクエリするだけで、実験やアーティファクトなどをトラッキングしない場合は、run を作成する必要はありません。

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