アーティファクトバージョンをコレクションにリンクする

アーティファクトバージョンを組織で利用できるようにするには、W&B Registry のコレクションに リンク します。リンクすると、そのバージョンはプロジェクトレベルのプライベートなスコープから、組織レベルの共有スコープへ移動します。アーティファクトバージョンは、W&B Python SDK を使ってプログラムから、または W&B App でインタラクティブにリンクできます。アーティファクトをリンクすると、W&B はソースアーティファクトとコレクションのエントリの間に参照を作成します。リンクされたバージョンは、プロジェクト内の run にログされたソースアーティファクトバージョンを参照します。コレクション内のリンクされたバージョンと、それがログされたプロジェクト内のソースバージョンの両方を表示できます。

artifact をコレクションにリンクする

artifact を run 中に作成するか、run なしで作成するか、既存の artifact バージョンをリンクするかに応じて、ワークフローを選択してください。

始める前に、次の点を確認してください。

コレクションで許可されている artifact のタイプ。コレクションのタイプの詳細については、コレクションを作成する内の「コレクションのタイプ」を参照してください。
コレクションが属するレジストリがすでに存在していること。レジストリが存在することを確認するには、Registry App にアクセスして検索し、そのレジストリの名を確認してください。

Python SDK
W&B Registry
Artifact ブラウザ

wandb.Run.link_artifact() または wandb.Artifact.link() を使用して、artifact version をコレクションにプログラムからリンクできます。次の表は、artifact version をコレクションにリンクするために使用できるメソッドと、各メソッドの使用時に W&B が記録する内容をまとめたものです。

Use case	Method	What W&B records
run 中に artifact を作成し、コレクションにリンクする	`wandb.Run.link_artifact()`	artifact をアクティブな run の出力としてログし、その後リンクします
明示的に run を開始せずに artifact を作成してリンクする	ドラフト artifact に対する `wandb.Artifact.link()`	まず artifact を保存します。アクティブな run がない場合は、自動 run を作成します
既存のコミット済み artifact をリンクする	`wandb.Api().artifact()` から取得した artifact に対する `wandb.Artifact.link()`	新しい run を作成せずに artifact をリンクします

宛先コレクションのパスを target_path パラメーターに渡します。パスは、wandb-registry- 接頭辞、Registry 名、コレクション名で構成されます。

wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}

run からアーティファクトをリンクする

アクティブな run 中にアーティファクトバージョンを作成してリンクするには、wandb.Run.link_artifact() を使用します。W&B は、リンクする前にドラフトアーティファクトを run の出力としてログします。アーティファクトバージョンを作成してリンクするには、次の手順に従います。

wandb.init() で run を初期化します。
Artifact オブジェクトを作成し、1 つ以上のファイルを追加します。
wandb.Run.link_artifact() を呼び出して、リンク先のコレクションを指定します。

山かっこ (<>) で囲まれた値は、ご自身の値に置き換えてください。

import wandb

entity = "<team_entity>"          # チーム entity
project = "<project_name>"        # アーティファクトを含む project の名前

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

  # アーティファクト オブジェクトを作成する
  # type パラメーターはアーティファクト オブジェクトのタイプと
  # コレクションのタイプの両方を指定する
  artifact = wandb.Artifact(name = "<name>", type = "<type>")

  # アーティファクト オブジェクトに file を追加する。
  # ローカルマシン上の file のパスを指定する。
  artifact.add_file(local_path = "<local_path_to_artifact>")

  # アーティファクトのリンク先となるコレクションと Registry を指定する
  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)

アーティファクトを作成してリンクする

wandb.Artifact.link() を使用すると、run を明示的に初期化しなくても、ドラフトアーティファクトを作成してリンクできます。リンク前にアーティファクトを保存する必要がある場合は、W&B が必要に応じて自動的に run を作成します。アーティファクトバージョンを作成してリンクするには、次の手順に従います。

Artifact オブジェクトを作成し、1 つ以上のファイルを追加します。
wandb.Artifact.link() を呼び出し、リンク先のコレクションを指定します。

山かっこ (<>) 内の値を実際の値に置き換えてください。

import wandb

# アーティファクト オブジェクトを作成する
# type パラメーターはアーティファクト オブジェクトのタイプと
# コレクションのタイプの両方を指定する
artifact = wandb.Artifact(name = "<name>", type = "<type>")

# アーティファクト オブジェクトにファイルを追加する。
# ローカルマシン上のファイルへのパスを指定する。
artifact.add_file(local_path = "<local_path_to_artifact>")

# アーティファクトのリンク先となるコレクションと Registry を指定する
REGISTRY_NAME = "<registry_name>"  
COLLECTION_NAME = "<collection_name>"
target_path=f"wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}"

# アーティファクトをコレクションにリンクする
artifact.link(target_path = target_path)

既存のアーティファクトをリンクする

wandb.Api().artifact() で取得したアーティファクトに対して wandb.Artifact.link() を使用すると、新しい run を作成せずに、既存のコミット済みアーティファクトバージョンをリンクできます。

wandb.Api() で Public API クライアントを作成します。
wandb.Api.artifact() でアーティファクトバージョンを取得します。
wandb.Artifact.link() を呼び出し、リンク先のコレクションを指定します。

import wandb

api = wandb.Api()

artifact = api.artifact(
    "<entity>/<project>/<artifact-name>:<alias-or-version>"
)

artifact.link(
    target_path="wandb-registry-<registry-name>/<collection-name>",
    aliases=["latest"],
)

W&B App の project のアーティファクトブラウザにアクセスします: https://wandb.ai/<entity>/<project>/artifacts
プロジェクトのサイドバーで Artifacts アイコンを選択します。
Registry にリンクするアーティファクトバージョンをクリックします。
Version overview セクションで、Link to registry ボタンをクリックします。
画面右側に表示されるモーダルで、Select a register model メニューのドロップダウンからアーティファクトを選択します。
Next step をクリックします。
(任意) Aliases ドロップダウンからエイリアスを選択します。
Link to registry をクリックします。

Registry App では、リンクされたアーティファクトのメタデータ、バージョンデータ、使用状況、リネージ情報などを確認できます。

Registry 内のリンクされた artifact を表示する

W&B Registry で、メタデータ、リネージ、利用状況情報など、リンクされた artifact に関する情報を表示します。

W&B Registry にアクセスします。
artifact をリンクした registry の名を選択します。
collection の名を選択します。
collection の artifact がメトリクスをログしている場合は、Show metrics をクリックして、バージョン間でメトリクスを比較します。
artifact バージョンの一覧から、アクセスしたいバージョンを選択します。バージョン番号は v0 から始まり、リンクされた各 artifact バージョンに段階的に割り当てられます。
artifact バージョンの詳細を表示するには、そのバージョンをクリックします。このページのタブから、そのバージョンのメタデータ (ログされたメトリクスを含む) 、リネージ、利用状況情報を表示できます。

Version タブ内の Full Name フィールドに注目してください。リンクされた artifact の完全名は、registry、collection 名、および artifact バージョンの alias またはインデックスで構成されます。

Full name of a linked artifact

wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}:v{INTEGER}

artifact のバージョンにプログラムからアクセスするには、リンクされた artifact のフルネームが必要です。

トラブルシューティング

artifact をリンクできない場合は、以下の一般的な確認項目を再度確認してください。

個人アカウントから Artifacts をログする

個人の entity で W&B にログされた Artifacts は、レジストリにリンクできません。Artifacts は、組織内のチーム entity を使用してログしてください。組織のレジストリにリンクできるのは、組織内のチームでログされた Artifacts のみです。

artifact をレジストリにリンクする場合は、チーム entity でその artifact をログしてください。

チーム entity を確認する

W&B では、チーム名がそのチームの entity として使用されます。たとえば、チーム名が team-awesome の場合、チーム entity は team-awesome です。次の手順でチーム名を確認できます。

チームの W&B プロフィールページにアクセスします。
サイトの URL をコピーします。形式は https://wandb.ai/<team> です。ここで <team> はチーム名であり、同時にチームの entity でもあります。

チーム entity でログする

wandb.init() で run を初期化するときに、entity としてチームを指定します。run の初期化時に entity を指定しない場合、run にはデフォルトの entity が使用されます。これはチーム entity の場合もあれば、そうでない場合もあります。
import wandb with wandb.init(entity='<team_entity>', project='<project_name>') as run: # ここでアーティファクトをログします
wandb.Run.log_artifact() を使用するか、Artifact object を作成してから次のようにファイルを追加して、アーティファクトを run にログします。
artifact = wandb.Artifact(name="<artifact_name>", type="<type>")
アーティファクトをログする方法については、アーティファクトを構築するを参照してください。
アーティファクトが個人の entity にログされている場合は、組織内の entity に再度ログする必要があります。

W&B App UI で Registry のパスを確認する

W&B App UI で Registry のパスを確認するには、空のコレクションを作成します。手順は次のとおりです。

https://wandb.ai/registry/ の W&B Registry にアクセスします。
アーティファクトをリンクする対象のレジストリをクリックします。
空のコレクションをクリックします。空のコレクションが存在しない場合は、新しいコレクションを作成します。
表示されたコードスニペット内で、.link_artifact() にある target_path フィールドを特定します。
(任意) コレクションを削除します。

たとえば、上記の手順を完了すると、target_path パラメーターを含むコードブロックが表示されます。

target_path = 
      "smle-registries-bug-bash/wandb-registry-Golden Datasets/raw_images"

これを構成要素に分解すると、アーティファクトをプログラムからリンクするためのパスを作成するのに何が必要かがわかります。

ORG_ENTITY_NAME = "smle-registries-bug-bash"
REGISTRY_NAME = "Golden Datasets"
COLLECTION_NAME = "raw_images"

一時コレクションの名を、アーティファクトをリンクする先のコレクションの名に置き換えてください。

ガイド

インテグレーション

リファレンス

アーティファクトバージョンをコレクションにリンクする

artifact をコレクションにリンクする

run からアーティファクトをリンクする

アーティファクトを作成してリンクする

既存のアーティファクトをリンクする

Registry 内のリンクされた artifact を表示する

トラブルシューティング

個人アカウントから Artifacts をログする

チーム entity を確認する

チーム entity でログする

W&B App UI で Registry のパスを確認する

​artifact をコレクションにリンクする

run からアーティファクトをリンクする

アーティファクトを作成してリンクする

既存のアーティファクトをリンクする

​Registry 内のリンクされた artifact を表示する

​トラブルシューティング

​個人アカウントから Artifacts をログする

​チーム entity を確認する

​チーム entity でログする

​W&B App UI で Registry のパスを確認する

artifact をコレクションにリンクする

Registry 内のリンクされた artifact を表示する

トラブルシューティング

個人アカウントから Artifacts をログする

チーム entity を確認する

チーム entity でログする

W&B App UI で Registry のパスを確認する