アーティファクトを更新する

W&B の run の内外で既存のアーティファクトを更新します。

アーティファクトの description、metadata、および alias を更新したい値に設定します。save() メソッドを呼び出すと、W&B サーバー上のアーティファクトが更新されます。アーティファクトは W&B の run 中でも、run の外でも更新できます。

Artifact.save() と wandb.Run.log_artifact() を使うタイミング

• 新しい run を作成せずに既存のアーティファクトを更新するには、Artifact.save() を使用します。
• 新しいアーティファクトを作成して特定の run に関連付けるには、wandb.Run.log_artifact() を使用します。

W&B Public API（wandb.Api）を使用して、run の外でアーティファクトを更新します。Artifact API（wandb.Artifact）を使用して、run 中にアーティファクトを更新します。

Model Registry 内でモデルにリンクされているアーティファクトのエイリアスは更新できません。

run 中

次のコード例は、wandb.Artifact API を使用してアーティファクトの description を更新する方法を示しています。

import wandb

with wandb.init(project="<example>") as run:
    artifact = run.use_artifact("<artifact-name>:<alias>")
    artifact.description = "<description>"
    artifact.save()

run の外部

次のコード例は、wandb.Api API を使用してアーティファクトの description を更新する方法を示しています。

import wandb

api = wandb.Api()

artifact = api.artifact("entity/project/artifact:alias")

# description を更新する
artifact.description = "My new description"

# 特定の metadata キーのみを更新する
artifact.metadata["oldKey"] = "new value"

# metadata を丸ごと置き換える
artifact.metadata = {"newKey": "new value"}

# エイリアスを追加する
artifact.aliases.append("best")

# エイリアスを削除する
artifact.aliases.remove("latest")

# エイリアスを丸ごと置き換える
artifact.aliases = ["replaced"]

# アーティファクトへのすべての変更を永続化する
artifact.save()

詳細については、Weights & Biases の Artifact API を参照してください。

コレクションを利用する場合

単一のアーティファクトと同様の方法で、Artifact コレクションも更新できます。

import wandb
with wandb.init(project="<example>") as run:
    api = wandb.Api()
    artifact = api.artifact_collection(type="<type-name>", collection="<collection-name>")
    artifact.name = "<new-collection-name>"
    artifact.description = "<This is where you'd describe the purpose of your collection.>"
    artifact.save()

詳細については、Artifacts Collection リファレンスを参照してください。