Registryからアーティファクトをダウンロードする

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

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

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

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

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

波かっこ {} 内の値を、アクセスする Registry 名、コレクション名、およびアーティファクトのバージョンのエイリアスまたはインデックスに置き換えます。リンクされたアーティファクトのパスを取得したら、wandb.Run.use_artifact() メソッドを使用してアーティファクトにアクセスし、その内容をダウンロードします。次のコードスニペットは、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>' # Registry UI に表示されている Full name をコピー＆ペーストします
    fetched_artifact = run.use_artifact(artifact_or_name = artifact_name)  
    download_path = fetched_artifact.download()  

wandb.Run.use_artifact() メソッドは、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 リファレンスの wandb.Run.use_artifact() および Artifact.download() を参照してください。

複数の組織に所属し、個人 entity を持つユーザー複数の組織に所属し、個人 entity を持つユーザーが 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 スクリプト、ノートブック、またはターミナルにコピー＆ペーストして使用できます。

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

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

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

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

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