Créer une expérience

Utilisez le SDK Python de W&B pour suivre des expériences de machine learning. Vous pouvez ensuite consulter les résultats dans un tableau de bord interactif ou exporter vos données vers Python pour y accéder par programmation avec l’API publique W&B. Ce guide explique comment utiliser les composants de base de W&B pour créer une expérience W&B.

Comment créer une expérience W&B

Créez une expérience W&B en quatre étapes :

Initialiser un run W&B
Enregistrer un dictionnaire d’hyperparamètres
Consigner des métriques dans votre boucle d’entraînement
Enregistrer un artefact dans W&B

Initialiser un run W&B

Utilisez wandb.init() pour créer un run W&B. L’extrait suivant crée un run dans un projet W&B nommé “cat-classification”, avec la description “My first experiment”, afin d’identifier plus facilement ce run. Les tags “baseline” et “paper1” sont inclus pour rappeler qu’il s’agit d’une expérience de référence destinée à une future publication d’article.

import wandb

with wandb.init(
    project="cat-classification",
    notes="My first experiment",
    tags=["baseline", "paper1"],
) as run:
    ...

wandb.init() renvoie un objet Run.

Remarque : les Runs sont ajoutés à des projets existants si ce projet existe déjà lorsque vous appelez wandb.init(). Par exemple, si vous avez déjà un projet nommé “cat-classification”, ce projet continuera d’exister et ne sera pas supprimé. À la place, un nouveau run est ajouté à ce projet.

Enregistrez un dictionnaire d’hyperparamètres

Enregistrez un dictionnaire d’hyperparamètres, comme le taux d’apprentissage ou le type de modèle. Les paramètres du modèle que vous consignez dans la configuration vous seront ensuite utiles pour organiser vos résultats et y effectuer des requêtes.

with wandb.init(
    ...,
    config={"epochs": 100, "learning_rate": 0.001, "batch_size": 128},
) as run:
    ...

Pour en savoir plus sur la configuration d’une expérience, voir Configurer Experiments.

Consigner des métriques dans votre boucle d’entraînement

Appelez run.log() pour consigner des métriques à chaque étape d’entraînement, comme l’accuracy et la perte.

model, dataloader = get_model(), get_data()

for epoch in range(run.config["epochs"]):
    for batch in dataloader:
        loss, accuracy = model.training_step()
        run.log({"accuracy": accuracy, "loss": loss})

Pour plus d’informations sur les différents types de données que vous pouvez journaliser avec W&B, voir Journaliser des objets et des médias.

Journaliser un Artifact dans W&B

Vous pouvez aussi journaliser un W&B Artifact. Les Artifacts facilitent le versionnage des jeux de données et des modèles.

# Vous pouvez sauvegarder n'importe quel fichier ou même un répertoire. Cet exemple suppose
# que le modèle possède une méthode save() qui génère un fichier ONNX.
model.save("path_to_model.onnx")
run.log_artifact("path_to_model.onnx", name="trained-model", type="model")

Pour en savoir plus sur Artifacts ou sur la gestion des versions des modèles dans le registre.

Tout réunir

Le script complet, avec les extraits de code précédents, se trouve ci-dessous :

import wandb

with wandb.init(
    project="cat-classification",
    notes="",
    tags=["baseline", "paper1"],
    # Enregistrer les hyperparamètres du run.
    config={"epochs": 100, "learning_rate": 0.001, "batch_size": 128},
) as run:
    # Configurer le modèle et les données.
    model, dataloader = get_model(), get_data()

    # Lancez l'entraînement en enregistrant les métriques pour visualiser les performances du modèle.
    for epoch in range(run.config["epochs"]):
        for batch in dataloader:
            loss, accuracy = model.training_step()
            run.log({"accuracy": accuracy, "loss": loss})

    # Charger le modèle entraîné en tant qu'artifact.
    model.save("path_to_model.onnx")
    run.log_artifact("path_to_model.onnx", name="trained-model", type="model")

Étapes suivantes : visualisez votre expérience

Utilisez le Workspace de votre projet pour organiser et visualiser les résultats de vos modèles de machine learning. Vous pouvez créer des graphiques interactifs, comme des graphiques en coordonnées parallèles, des analyses d’importance des paramètres et d’autres types de graphiques.

Exemple de Workspace Sweeps du Démarrage rapide

Pour en savoir plus sur l’affichage des expériences et de Runs spécifiques, voir Afficher les résultats des expériences.

Bonnes pratiques

Voici quelques recommandations à suivre lorsque vous créez des expériences :

Gérer les runs avec un gestionnaire de contexte : utilisez wandb.init() dans un bloc with pour terminer automatiquement le run lorsque le code se termine ou lève une exception.
- Dans les notebooks Jupyter, vous préférerez peut-être gérer le run vous-même. Dans ce cas, appelez finish() pour le marquer comme terminé :
  # Dans une cellule de notebook : run = wandb.init() # Dans une autre cellule : run.finish()
Configuration : suivez les hyperparamètres, l’architecture du modèle, les informations sur le dataset et les autres valeurs nécessaires pour reproduire votre modèle. Pour plus d’informations, voir Afficher la configuration dans la section Aperçu d’un run dans l’application W&B.
Project : utilisez les Projects pour organiser les expériences dans un espace centralisé où vous pouvez visualiser les résultats, comparer les runs, afficher et télécharger des artefacts, créer des automatisations, et plus encore.
Notes : ajoutez des notes pour décrire l’objectif d’un run, par exemple baseline model ou tuned hyperparameters. Vous pourrez modifier ces notes plus tard depuis l’aperçu du run dans l’application W&B.
Types de job : ajoutez des types de job à vos runs pour organiser et filtrer les runs par tâche, par exemple train, test ou inference.
Tags : ajoutez des tags aux runs pour étiqueter les runs avec des fonctionnalités ou des attributs qui ne ressortent pas forcément des métriques ou des artefacts enregistrés.

L’exemple suivant montre comment initialiser un run W&B en appliquant ces bonnes pratiques :

import wandb

config = {
    "learning_rate": 0.01,
    "momentum": 0.2,
    "architecture": "CNN",
    "dataset_id": "cats-0192",
}

with wandb.init(
    project="detect-cats",
    notes="tweak baseline",
    tags=["baseline", "paper1"],
    config=config,
) as run:
    ...

Pour plus d’informations sur les paramètres disponibles, voir wandb.init() dans le Guide de référence du SDK Python.

Guides

Intégrations

Référence

Comment créer une expérience W&B

Initialiser un run W&B

Enregistrez un dictionnaire d’hyperparamètres

Consigner des métriques dans votre boucle d’entraînement

Journaliser un Artifact dans W&B

Tout réunir

Étapes suivantes : visualisez votre expérience

Bonnes pratiques

​Comment créer une expérience W&B

​Initialiser un run W&B

​Enregistrez un dictionnaire d’hyperparamètres

​Consigner des métriques dans votre boucle d’entraînement

​Journaliser un Artifact dans W&B

​Tout réunir

​Étapes suivantes : visualisez votre expérience

​Bonnes pratiques

Comment créer une expérience W&B

Initialiser un run W&B

Enregistrez un dictionnaire d’hyperparamètres

Consigner des métriques dans votre boucle d’entraînement

Journaliser un Artifact dans W&B

Tout réunir

Étapes suivantes : visualisez votre expérience

Bonnes pratiques