Mettre à jour un artefact

Mettez à jour un artefact existant pendant qu’un run est actif ou en utilisant uniquement l’API publique.

Transmettez les valeurs souhaitées pour mettre à jour la description, les metadata et l’alias d’un artefact. Mettez à jour un run précédemment consigné dans W&B avec l’API publique W&B (wandb.Api). Utilisez wandb.Run.save() pour mettre à jour un artefact lorsqu’il vient d’être initialisé et qu’il est toujours actif.

Quand utiliser wandb.Artifact.save() ou wandb.Run.log_artifact()

• Utilisez Artifact.save() pour mettre à jour un artefact existant sans démarrer un nouveau run.
• Utilisez wandb.Run.log_artifact() pour créer un nouvel artefact et l’associer à un run spécifique.

Utilisez l’API publique W&B (wandb.Api) pour mettre à jour un artefact. Utilisez la classe wandb.Artifact pendant qu’un run est actif.

Vous ne pouvez pas mettre à jour l’alias d’un artefact lié à un modèle dans le Model Registry.

Pendant un run

L’exemple de code suivant montre comment mettre à jour la description d’un artefact à l’aide de l’API wandb.Artifact :

import wandb

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

API publique W&B

L’exemple suivant met à jour un artefact avec wandb.Api :

import wandb

api = wandb.Api()

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

# Mettre à jour la description
artifact.description = "My new description"

# Mettre à jour certaines clés des métadonnées
artifact.metadata["oldKey"] = "new value"

# Remplacer entièrement les métadonnées
artifact.metadata = {"newKey": "new value"}

# Ajouter un alias
artifact.aliases.append("best")

# Supprimer un alias
artifact.aliases.remove("latest")

# Remplacer complètement les alias
artifact.aliases = ["replaced"]

# Enregistrer toutes les modifications de l'artefact
artifact.save()

Pour plus d’informations, voir l’API Artifact de Weights & Biases.

Avec des collections

Vous pouvez également mettre à jour une collection d’artefacts de la même manière qu’un artefact individuel :

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()

Pour plus d’informations, voir la référence Artifacts Collection.