Skip to main content
Pass desired values to update the description, metadata, and alias of an artifact. Call the save() method to update the artifact on the W&B servers. You can update an artifact during a W&B Run or outside of a Run.
When to use Artifact.save() or wandb.Run.log_artifact()
  • Use Artifact.save() to update an existing artifact without creating a new run.
  • Use wandb.Run.log_artifact() to create a new artifact and associate it with a specific run.
Use the W&B Public API (wandb.Api) to update an artifact outside of a run. Use the Artifact API (wandb.Artifact) to update an artifact during a run.
You can not update the alias of artifact linked to a model in Model Registry.
  • During a run
  • Outside of a run
  • With collections
The proceeding code example demonstrates how to update the description of an artifact using the wandb.Artifact API:
import wandb

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