Lier une version d’artifact à une collection

Pour mettre une version d’artifact à la disposition de votre organisation, liez-la à une collection dans le registre. La liaison fait passer la version d’une portée privée, limitée au projet, à une portée partagée, à l’échelle de l’organisation. Vous pouvez lier une version d’artifact par programmation avec le SDK Python W&B ou de manière interactive dans la W&B App. Lorsque vous liez un artifact, W&B crée une référence entre l’artifact source et l’entrée de la collection. La version liée pointe vers la version de l’artifact source journalisée dans un run d’un projet. Vous pouvez consulter à la fois la version liée dans la collection et la version source dans le projet où elle a été journalisée.

Lier un artifact à une collection

Choisissez un flux de travail selon que vous souhaitez créer l’artifact pendant un run, le créer sans run ou lier une version d’artifact existante.

Avant de commencer, vérifiez les points suivants :

Les types d’artifacts autorisés par la collection. Pour en savoir plus sur les types de collections, consultez la section « Types de collections » de la page Créer une collection.
Le registre auquel appartient la collection existe déjà. Pour le vérifier, accédez à la Registry App et recherchez le nom du registre.

SDK Python W&B
Registry
Explorateur d’artifacts

Liez par programmation une version d’artifact à une collection avec wandb.Run.link_artifact() ou wandb.Artifact.link()Le tableau suivant récapitule les méthodes permettant de lier une version d’artifact à une collection, ainsi que ce que W&B enregistre avec chacune d’elles.

Cas d’utilisation	Méthode	Ce que W&B enregistre
Créer un artifact pendant un run et le lier à une collection	`wandb.Run.link_artifact()`	Journalise l’artifact comme sortie du run actif, puis le lie
Créer et lier un artifact sans démarrer explicitement de run	`wandb.Artifact.link()` sur un artifact brouillon	Enregistre d’abord l’artifact ; si aucun run n’est actif, crée un run automatique
Lier un artifact existant déjà validé	`wandb.Artifact.link()` sur un artifact obtenu via `wandb.Api().artifact()`	Lie l’artifact sans créer de nouveau run

Transmettez le chemin de la collection de destination au paramètre target_path. Ce chemin se compose du préfixe wandb-registry-, du nom du registre et du nom de la collection :

wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}

Utilisez wandb.Run.link_artifact() pour créer et lier une version d’artifact pendant un run actif. Avant de les lier, W&B journalise les brouillons d’artifacts en tant que sorties du run.Pour créer et lier une version d’artifact :

Initialisez un run avec wandb.init().
Créez un objet Artifact et ajoutez-y un ou plusieurs fichiers.
Appelez wandb.Run.link_artifact() en indiquant la collection de destination.

Remplacez les valeurs entre chevrons (<>) par vos propres valeurs :

import wandb

entity = "<team_entity>"          # Votre entity d’équipe
project = "<project_name>"        # Le nom du projet qui contient votre artifact

# Initialiser un run
with wandb.init(entity = entity, project = project) as run:

  # Créer un objet artifact
  # Le paramètre type définit à la fois le type de 
  # l’objet artifact et le type de collection
  artifact = wandb.Artifact(name = "<name>", type = "<type>")

  # Ajouter le fichier à l’objet artifact. 
  # Indiquer le chemin du fichier sur votre machine locale.
  artifact.add_file(local_path = "<local_path_to_artifact>")

  # Indiquer la collection et le registre auxquels lier l’artifact
  REGISTRY_NAME = "<registry_name>"  
  COLLECTION_NAME = "<collection_name>"
  target_path=f"wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}"

  # Lier l’artifact à la collection
  run.link_artifact(artifact = artifact, target_path = target_path)

Utilisez wandb.Artifact.link() pour créer et lier un artifact brouillon sans initialiser explicitement de run. Si nécessaire, W&B crée automatiquement un run pour enregistrer l’artifact avant de le lier.Pour créer et lier une version d’artifact :

Créez un objet Artifact et ajoutez-y un ou plusieurs fichiers.
Appelez wandb.Artifact.link() en indiquant la collection de destination.

Remplacez les valeurs entre chevrons (<>) par les vôtres :

import wandb

# Créer un objet artifact
# Le paramètre type définit à la fois le type de
# l’objet artifact et le type de la collection
artifact = wandb.Artifact(name = "<name>", type = "<type>")

# Ajouter le fichier à l’objet artifact.
# Indiquer le chemin du fichier sur votre machine locale.
artifact.add_file(local_path = "<local_path_to_artifact>")

# Indiquer la collection et le registre auxquels lier l’artifact
REGISTRY_NAME = "<registry_name>"  
COLLECTION_NAME = "<collection_name>"
target_path=f"wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}"

# Lier l’artifact à la collection
artifact.link(target_path = target_path)

Utilisez wandb.Artifact.link() sur un artifact récupéré avec wandb.Api().artifact() pour lier une version d’artifact existante et déjà validée, sans créer de nouveau run.

Créez un client d’API publique avec wandb.Api().
Récupérez la version de l’artifact avec wandb.Api.artifact().
Appelez wandb.Artifact.link() en indiquant la collection de destination.

import wandb

api = wandb.Api()

artifact = api.artifact(
    "<entity>/<project>/<artifact-name>:<alias-or-version>"
)

artifact.link(
    target_path="wandb-registry-<registry-name>/<collection-name>",
    aliases=["latest"],
)

Accédez au navigateur d’artifacts de votre projet dans l’application W&B, à l’adresse suivante : https://wandb.ai/<entity>/<project>/artifacts
Sélectionnez l’icône Artifacts dans la barre latérale du projet.
Cliquez sur la version de l’artifact que vous souhaitez lier à votre registre.
Dans la section Version overview, cliquez sur le bouton Link to registry.
Dans la fenêtre modale qui s’affiche à droite de l’écran, sélectionnez un artifact dans le menu déroulant Select a registered model.
Cliquez sur Next step.
(Facultatif) Sélectionnez un alias dans le menu déroulant Aliases.
Cliquez sur Link to registry.

Vous pouvez consulter les métadonnées, les données de version, l’utilisation et les informations de traçabilité d’un artifact lié, entre autres, dans la Registry App.

Dissocier une version d’artifact d’une collection

Utilisez le SDK Python W&B ou le registre pour dissocier une version d’artifact d’une collection. La dissociation retire la version d’artifact de la collection, mais ne supprime ni la version d’artifact source ni ses fichiers.

Lier une version d’artifact à une collection de registre désactive sa politique de durée de vie (TTL) et définit son TTL sur None. Si vous dissociez ultérieurement la version, W&B ne restaure pas le TTL précédent et ne conserve pas sa durée d’origine. Si la version nécessite toujours un TTL, reconfigurez-le après la dissociation.Pour plus d’informations sur les politiques TTL, consultez Gérer la rétention des données des artifacts.

SDK Python W&B
Registry

Pour dissocier une version d’artifact avec le SDK Python W&B :

Créez un client d’API publique avec wandb.Api().
Récupérez la version d’artifact liée avec wandb.Api.artifact().
Appelez wandb.Artifact.unlink() pour dissocier la version d’artifact de la collection.

wandb-registry-<registry_name>/<collection_name>:<version_or_alias>

Remplacez les espaces réservés par vos propres valeurs :

import wandb

registry_name = "your-registry-name"  # Remplacez par le nom du registre
collection_name = "your-collection-name"  # Remplacez par le nom de la collection
version = "version-or-alias"  # Remplacez par la version de l'artifact à dissocier

target_path=f"wandb-registry-{registry_name}/{collection_name}:{version}"

api = wandb.Api()
linked_artifact = api.artifact(name=target_path)

# Dissocier la version d'artifact de la collection
linked_artifact.unlink()

Afficher les artifacts liés dans un registre

Consultez dans le registre les informations relatives aux artifacts liés, telles que les métadonnées, la traçabilité et les informations d’utilisation.

Accédez au registre à l’adresse https://forge.coreweave.com/registry/.
Sélectionnez le nom du registre auquel vous avez lié l’artifact.
Sélectionnez le nom de la collection.
Si les artifacts de la collection journalisent des métriques, cliquez sur Show metrics pour comparer les métriques entre les versions.
Dans la liste des versions d’artifact, sélectionnez la version à laquelle vous souhaitez accéder. Les numéros de version sont attribués de manière incrémentielle à chaque version d’artifact liée, en commençant par v0.
Pour afficher les détails d’une version d’artifact, cliquez sur celle-ci. Les onglets de cette page vous permettent de consulter les métadonnées de cette version (y compris les métriques journalisées), sa traçabilité et ses informations d’utilisation.

Notez la valeur du champ Full Name dans l’onglet Version. Le nom complet d’un artifact lié se compose du registre, du nom de la collection et de l’alias ou de l’index de la version d’artifact.

Full name of a linked artifact

wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}:v{INTEGER}

Pour accéder par programmation à la version d’un artifact lié, vous avez besoin de son nom complet.

Dépannage

Si vous ne parvenez pas à lier un artifact, voici quelques points courants à vérifier.

Journalisation d’artifacts depuis un compte personnel

Les artifacts consignés dans W&B avec une entity personnelle ne peuvent pas être liés au registre. Veillez à journaliser vos artifacts avec une entity d’équipe de votre organisation. Seuls les artifacts journalisés au sein d’une équipe de l’organisation peuvent être liés au registre de celle-ci.

Pour lier un artifact à un registre, veillez à le journaliser avec une entity d’équipe.

Trouver l’entity de votre équipe

W&B utilise le nom de votre équipe comme entity d’équipe. Par exemple, si votre équipe s’appelle team-awesome, l’entity de votre équipe est team-awesome. Pour vérifier le nom de votre équipe :

Accédez à la page de profil W&B de votre équipe.
Copiez l’URL de la page. Elle se présente sous la forme https://wandb.ai/<team>, où <team> correspond à la fois au nom de votre équipe et à son entity.

Journaliser depuis un entity d’équipe

Indiquez l’équipe comme entity lorsque vous initialisez un run avec wandb.init(). Si vous ne précisez pas l’entity lors de l’initialisation d’un run, celui-ci utilise votre entity par défaut, qui n’est pas forcément votre entity d’équipe.
import wandb with wandb.init(entity='<team_entity>', project='<project_name>') as run: # Journalisez votre artifact ici
Journalisez l’artifact dans le run, soit avec wandb.Run.log_artifact(), soit en créant un objet Artifact puis en y ajoutant des fichiers avec :
artifact = wandb.Artifact(name="<artifact_name>", type="<type>")
Pour journaliser des artifacts, consultez Construire des artifacts.
Si un artifact a été journalisé dans votre entity personnel, vous devrez le journaliser à nouveau dans un entity de votre organisation.

Confirmer le chemin d’un registre dans l’interface de l’application W&B

Créez une collection vide pour confirmer le chemin du registre dans l’interface de l’application W&B. Pour ce faire, procédez comme suit :

Accédez au registre à l’adresse https://forge.coreweave.com/registry/.
Cliquez sur le registre auquel vous souhaitez lier un artifact.
Cliquez sur la collection vide. S’il n’en existe aucune, créez une nouvelle collection.
Dans l’extrait de code qui s’affiche, repérez le champ target_path= dans .link_artifact().
(Facultatif) Supprimez la collection.

Par exemple, une fois ces étapes terminées, vous obtenez le bloc de code contenant le paramètre target_path :

target_path = 
      "wandb-registry-Zoo-Classifier-Registry/Temp Collection"

En décomposant ce chemin en ses différents composants, vous pouvez identifier les éléments à utiliser pour construire le chemin qui permet de lier votre artifact par programmation :

ORG_ENTITY_NAME = "wandb"
REGISTRY_NAME = "Zoo-Classifier-Registry"
COLLECTION_NAME = "Temp Collection"

Veillez à remplacer le nom de la collection temporaire par celui de la collection à laquelle vous souhaitez lier votre artifact.

​Lier un artifact à une collection

​Dissocier une version d’artifact d’une collection

​Afficher les artifacts liés dans un registre

​Dépannage

​Journalisation d’artifacts depuis un compte personnel

​Trouver l’entity de votre équipe

​Journaliser depuis un entity d’équipe

​Confirmer le chemin d’un registre dans l’interface de l’application W&B

Lier un artifact à une collection

Dissocier une version d’artifact d’une collection

Afficher les artifacts liés dans un registre

Dépannage

Journalisation d’artifacts depuis un compte personnel

Trouver l’entity de votre équipe

Journaliser depuis un entity d’équipe

Confirmer le chemin d’un registre dans l’interface de l’application W&B