Annoter les collections

Ajoutez des descriptions et de la documentation aux collections de W&B Registry pour aider les utilisateurs à comprendre leur finalité et leur contenu.

Ajoutez un texte clair et accessible à vos collections pour aider les utilisateurs à comprendre la finalité de la collection et les Artifacts qu’elle contient.

Selon la collection, vous pouvez inclure des informations sur les données d’entraînement, l’architecture du modèle, la tâche, la licence, les références et le déploiement. La liste suivante présente quelques éléments qu’il peut être utile de documenter dans une collection :

W&B recommande d’inclure au minimum les détails suivants :

• Résumé : La finalité de la collection, ainsi que le framework de machine learning utilisé pour l’expérience.
• Licence : Les conditions juridiques et les autorisations associées à l’utilisation du modèle de machine learning. Cela aide les utilisateurs du modèle à comprendre le cadre légal dans lequel ils peuvent utiliser le modèle. Les licences courantes incluent Apache 2.0, MIT et GPL.
• Références : Citations ou références vers des articles de recherche pertinents, des jeux de données ou des ressources externes.

Si votre collection contient des données d’entraînement, envisagez d’inclure ces détails supplémentaires :

• Données d’entraînement : Décrivez les données d’entraînement utilisées.
• Traitement : Traitements appliqués au jeu de données d’entraînement.
• Stockage des données : Où ces données sont stockées et comment y accéder.

Si votre collection contient un modèle de machine learning, envisagez d’inclure ces détails supplémentaires :

• Architecture : Informations sur l’architecture du modèle, les couches et les choix de conception spécifiques.
• Tâche : Le type précis de tâche ou de problème pour lequel le modèle de la collection est conçu. Il s’agit d’une catégorisation de la capacité prévue du modèle.
• Désérialiser le modèle : Indiquez comment un membre de votre équipe peut charger le modèle en mémoire.
• Déploiement : Détails sur la façon et l’endroit où le modèle est déployé, ainsi que des indications sur la manière dont le modèle est intégré à d’autres systèmes d’entreprise, comme des plateformes d’orchestration de flux de travail.

​

Ajouter une description à une collection

Ajoutez, de manière interactive ou programmatique, une description à une collection avec l’UI W&B Registry ou le SDK Python.

W&B Registry UI

1. Accédez à W&B Registry.
2. Cliquez sur une collection.
3. Sélectionnez Voir les détails à côté du nom de la collection.
4. Dans le champ Description, renseignez des informations sur votre collection. Mettez le texte en forme avec la syntaxe Markdown.

Python SDK

Utilisez la méthode wandb.Api().artifact_collection() pour accéder à la description d’une collection. Utilisez la propriété description de l’objet renvoyé pour ajouter ou mettre à jour la description de la collection.

Spécifiez le type de la collection pour le paramètre type_name et le nom complet de la collection pour le paramètre name. Le nom d’une collection se compose du préfixe « wandb-registry », du nom du registre et du nom de la collection, séparés par des barres obliques :

wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}

Copiez-collez l’extrait de code suivant dans votre script ou notebook Python. Remplacez les valeurs entre chevrons (<>) par les vôtres.

import wandb

api = wandb.Api()

collection = api.artifact_collection(
  type_name = "<collection_type>", 
  name = "<collection_name>"
  )


collection.description = "This is a description."
collection.save()  

Par exemple, l’image suivante montre une collection qui documente l’architecture d’un modèle, son usage prévu, ses performances, et plus encore.