レジストリからアーティファクトをダウンロードする

レジストリにリンクされたアーティファクトをダウンロードするには、W&B Python SDK を使用します。アーティファクトをダウンロードして使用するには、レジストリの名、コレクションの名、およびダウンロードしたいアーティファクトバージョンのエイリアスまたはインデックスを把握している必要があります。アーティファクトのプロパティがわかれば、リンクされたアーティファクトへのパスを組み立て、アーティファクトをダウンロードできます。あるいは、W&B App UI から事前生成されたコードスニペットをコピー＆ペーストして、レジストリにリンクされたアーティファクトをダウンロードすることもできます。

リンクされたアーティファクトへのパスを構築する

Registry にリンクされたアーティファクトをダウンロードするには、そのアーティファクトへのパスを把握しておく必要があります。パスは、Registry 名、コレクション名、およびアクセスしたいアーティファクトバージョンのエイリアスまたはインデックスで構成されます。アーティファクトバージョンの Registry、コレクション、エイリアスまたはインデックスがわかれば、次の文字列テンプレートを使ってリンクされたアーティファクトへのパスを構築できます:

# バージョンインデックスを指定したアーティファクト名
f"wandb-registry-{REGISTRY}/{COLLECTION}:v{INDEX}"

# エイリアスを指定したアーティファクト名
f"wandb-registry-{REGISTRY}/{COLLECTION}:{ALIAS}"

波かっこ {} 内の値を、アクセスしたいアーティファクトバージョンの Registry 名、コレクション名、および alias またはインデックスに置き換えてください。リンクされたアーティファクトのパスがわかったら、wandb.Run.use_artifact() method を使用してアーティファクトにアクセスし、その内容をダウンロードします。次のコードスニペットは、W&B Registry にリンクされたアーティファクトの使い方とダウンロード方法を示しています。<> 内の値は必ずご自身のものに置き換えてください。

import wandb

REGISTRY = '<registry_name>'
COLLECTION = '<collection_name>'
ALIAS = '<artifact_alias>'

with wandb.init(entity = '<team_name>', project = '<project_name>')  as run:
    artifact_name = f"wandb-registry-{REGISTRY}/{COLLECTION}:{ALIAS}"
    # artifact_name = '<artifact_name>' # W&B Registry UI で指定されたフル ネームをコピー＆ペーストする
    fetched_artifact = run.use_artifact(artifact_or_name = artifact_name)  
    download_path = fetched_artifact.download()  

wandb.Run.use_artifact() method は、run を作成すると同時に、ダウンロードしたアーティファクトをその run の入力としてマークします。アーティファクトを run の入力としてマークすると、W&B はそのアーティファクトのリネージをトラッキングできるようになります。 run を作成したくない場合は、wandb.Api() オブジェクトを使用してアーティファクトにアクセスできます:

import wandb

REGISTRY = "<registry_name>"
COLLECTION = "<collection_name>"
VERSION = "<version>"

api = wandb.Api()
artifact_name = f"wandb-registry-{REGISTRY}/{COLLECTION}:{VERSION}"
artifact = api.artifact(name = artifact_name)

パラメーターと戻り値の型については、API Reference の wandb.Run.use_artifact() と Artifact.download() を参照してください。

複数の組織に属する personal entity を持つ Users複数の組織に属し、personal entity を持つ Users が Registry にリンクされたアーティファクトにアクセスする場合は、組織名を指定するか、チーム entity を使用する必要があります。

import wandb

REGISTRY = "<registry_name>"
COLLECTION = "<collection_name>"
VERSION = "<version>"

# API のインスタンス化には、チーム entity を使用していることを確認してください
api = wandb.Api(overrides={"entity": "<team-entity>"})
artifact_name = f"wandb-registry-{REGISTRY}/{COLLECTION}:{VERSION}"
artifact = api.artifact(name = artifact_name)

# パスを構築
api = wandb.Api()
artifact_name = f"wandb-registry-{REGISTRY}/{COLLECTION}:{VERSION}"
artifact = api.artifact(name = artifact_name)

事前に生成されたコードスニペットをコピー＆ペーストする

W&B では、Registry に関連付けられたアーティファクトをダウンロードするためのコードスニペットが生成されます。このコードスニペットは、Python スクリプト、ノートブック、またはターミナルにコピー＆ペーストして使用できます。

W&B Registry にアクセスします。
アーティファクトが含まれているRegistryの名を選択します。
コレクションの名を選択します。
アーティファクトバージョンの一覧から、アクセスするバージョンを選択します。
Usage タブを選択します。
Usage API セクションに表示されているコードスニペットをコピーします。
コードスニペットを Python スクリプト、ノートブック、またはターミナルに貼り付けます。

​リンクされたアーティファクト へのパスを構築する

​事前に生成されたコードスニペットをコピー＆ペーストする

リンクされたアーティファクトへのパスを構築する

事前に生成されたコードスニペットをコピー＆ペーストする