Link an artifact version to a registry

Artifact の バージョンをコレクションにリンクして、組織内の他のメンバーが利用できるようにします。

Artifact をレジストリにリンクすると、その Artifact がそのレジストリに「公開」されます。そのレジストリへのアクセス権を持つ ユーザー は、コレクション内のリンクされた Artifact の バージョン にアクセスできます。

言い換えれば、Artifact をレジストリ コレクションにリンクすると、その Artifact の バージョン がプライベートなプロジェクトレベルのスコープから、共有の組織レベルのスコープに移行します。

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

Artifact の バージョン を、インタラクティブまたはプログラムでコレクションにリンクします。

ユースケース に基づいて、以下のタブに記載されている手順に従って、Artifact の バージョン をリンクしてください。

• Python SDK
• Registry App
• Artifact browser

wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}

import wandb

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

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

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

# Artifact のリンク先のコレクションとレジストリを指定します
REGISTRY_NAME = "<registry_name>"
COLLECTION_NAME = "<collection_name>"
target_path=f"wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}"

# Artifact をコレクションにリンクする
run.link_artifact(artifact = artifact, target_path = target_path)

Registry アプリ で、リンクされた Artifact の メタデータ、バージョン データ、使用状況、リネージ 情報を表示します。

レジストリ内のリンクされた Artifact を表示する

Registry アプリ で、メタデータ、リネージ、使用状況情報など、リンクされた Artifact に関する情報を表示します。

1. Registry アプリ に移動します。
2. Artifact をリンクしたレジストリの名前を選択します。
3. コレクションの名前を選択します。
4. コレクションの Artifact がメトリクスを ログ に記録する場合は、メトリクスの表示 をクリックして バージョン 全体のメトリクスを比較します。
5. Artifact の バージョン のリストから、アクセスする バージョン を選択します。バージョン 番号は、v0 から始まるリンクされた各 Artifact の バージョン にインクリメントに割り当てられます。
6. Artifact の バージョン に関する詳細を表示するには、バージョン をクリックします。このページのタブから、その バージョン のメタデータ (ログ に記録されたメトリクスを含む)、リネージ、および使用状況情報を表示できます。

バージョン タブ内の フルネーム フィールドに注意してください。リンクされた Artifact のフルネームは、レジストリ、コレクション名、および Artifact の バージョン の エイリアス または インデックス で構成されます。

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

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

トラブルシューティング

Artifact をリンクできない場合は、以下に示す一般的な確認事項を再確認してください。

個人の アカウント から Artifact を ログ に記録する

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

チーム Entity を検索する

W&B は、チーム の名前を チーム の Entity として使用します。たとえば、チーム の名前が team-awesome の場合、チーム Entity は team-awesome です。

次の方法で チーム の名前を確認できます。

1. チーム の W&B プロファイル ページに移動します。
2. サイト の URL をコピーします。これは https://wandb.ai/<team> の形式です。<team> は チーム の名前と チーム の Entity の両方です。

チーム Entity から ログ に記録する

1. wandb.init() で run を初期化するときに、Entity として チーム を指定します。run を初期化するときに entity を指定しない場合、run はデフォルト の Entity を使用します。これは チーム Entity である場合とそうでない場合があります。

import wandb

run = wandb.init(
  entity='<team_entity>',
  project='<project_name>'
  )

2. run.log_artifact を使用して、または Artifact オブジェクト を作成し、次にファイルを Artifact オブジェクト に追加して、Artifact を run に ログ に記録します。

   artifact = wandb.Artifact(name="<artifact_name>", type="<type>")
   

   Artifact の ログ 方法について詳しくは、Artifact を構築する をご覧ください。

3. Artifact が個人の Entity に ログ に記録されている場合は、組織内の Entity に再度 ログ に記録する必要があります。

W&B App UI でレジストリの パス を確認する

UI を使用してレジストリの パス を確認するには、空のコレクションを作成してコレクションの詳細を表示するか、コレクションの ホーム ページで自動生成された コード をコピーして貼り付けます。

自動生成された コード をコピーして貼り付けます

1. https://wandb.ai/registry/ で Registry アプリ に移動します。
2. Artifact をリンクするレジストリをクリックします。
3. ページの上部に、自動生成された コード ブロックが表示されます。
4. これを コード にコピーして貼り付け、パス の最後の部分をコレクションの名前に置き換えてください。

空のコレクションを作成する

1. https://wandb.ai/registry/ で Registry アプリ に移動します。
2. Artifact をリンクするレジストリをクリックします。
3. 空のコレクションをクリックします。空のコレクションが存在しない場合は、新しいコレクションを作成します。
4. 表示される コードスニペット 内で、.link_artifact() 内の target_path フィールドを特定します。
5. (オプション) コレクションを削除します。

たとえば、概説されている手順を完了した後、target_path パラメータ を使用して コード ブロックを見つけます。

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

これをコンポーネント に分解すると、プログラムで Artifact をリンクするための パス を作成するために使用する必要があるものを確認できます。

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