L’API W&B Report and Workspace est en préversion publique.
Exécutez le notebook Programmatic workspaces pour suivre un tutoriel complet sur la création d’une vue de workspace personnalisée et enregistrée.
Pour modifier un rapport par programmation, vous devez installer l’API W&B Report and Workspace (
wandb-workspaces) ainsi que le SDK Python W&B :Ajouter des graphiques
Les graphiques vous permettent de visualiser les données des runs dans un rapport. Chaque grille de panneaux comporte des ensembles de runs et des panneaux. Les ensembles de runs de la grille de panneaux déterminent les données affichées dans les panneaux de la grille. Créez une nouvelle grille de panneaux si vous souhaitez ajouter des graphiques qui extraient leurs données d’un autre ensemble de runs.- Interface de l’application
- API Report and Workspace
Saisissez une barre oblique (
/) dans le rapport pour afficher un menu déroulant. Sélectionnez Add panel pour ajouter un panneau. Vous pouvez ajouter n’importe quel panneau pris en charge par W&B, notamment un graphique en courbes, un nuage de points ou un graphique en coordonnées parallèles.
Ajouter des ensembles de runs
Ajoutez des ensembles de runs à partir de projets de manière interactive avec l’interface de l’application ou le SDK W&B.- Interface de l’application
- API Report and Workspace
Saisissez une barre oblique (
/) dans le rapport pour afficher un menu déroulant. Dans ce menu, choisissez Panel Grid. W&B importe automatiquement l’ensemble de runs du projet à partir duquel le rapport a été créé.Lorsque vous importez un panneau dans un rapport, celui-ci hérite des noms de runs du projet. Dans le rapport, vous pouvez, si vous le souhaitez, renommer un run pour apporter plus de contexte au lecteur. Le renommage s’applique uniquement au panneau concerné. Si vous clonez le panneau dans le même rapport, le panneau cloné affiche lui aussi le nouveau nom.- Dans le rapport, cliquez sur l’icône en forme de crayon pour ouvrir l’éditeur de rapport.
-
Dans l’ensemble de runs, trouvez le run à renommer. Survolez le nom du run et cliquez sur le menu action (). Sélectionnez l’une des options suivantes, puis soumettez le formulaire.
- Rename run for project : renomme le run dans l’ensemble du projet. Pour générer un nouveau nom aléatoire, laissez le champ vide.
- Rename run for panel grid : renomme le run uniquement dans le rapport, en conservant le nom existant ailleurs. Cette option ne permet pas de générer un nouveau nom aléatoire.
- Cliquez sur Publish report.
Figer un ensemble de runs
Un rapport met automatiquement à jour ses ensembles de runs afin d’afficher les données les plus récentes du projet. Figez un ensemble de runs pour conserver son état à un moment donné dans un rapport, de sorte que les runs ultérieurs ne modifient pas ce qu’affiche le rapport. Pour figer un ensemble de runs lorsque vous consultez un rapport, cliquez sur l’icône en forme de flocon de neige dans sa grille de panneaux, à côté du bouton Filter.
Regrouper un run set par programmation
Regroupez les runs d’un run set par programmation avec l’API Workspace and Reports. Le regroupement rassemble les runs apparentés dans les panneaux, ce qui facilite la comparaison des configurations et des résultats. Vous pouvez regrouper les runs d’un run set par valeurs de configuration, par métadonnées de run ou par métriques de synthèse. Le tableau suivant répertorie les méthodes de regroupement disponibles, ainsi que les clés utilisables pour chacune d’elles :Regrouper les runs par valeurs de configuration
Regroupez les runs par valeurs de configuration pour comparer des runs dont les configurations sont similaires. Les valeurs de configuration sont les paramètres que vous définissez dans la configuration de votre run(wandb.init(config=)). Pour regrouper les runs par valeurs de configuration, utilisez la syntaxe config.[KEY], où [KEY] est le nom de la valeur de configuration à utiliser pour le regroupement.
Par exemple, l’extrait de code suivant initialise d’abord un run avec une valeur de configuration pour group, puis regroupe les runs d’un rapport selon la valeur de configuration group. Remplacez [ENTITY] et [PROJECT] par les noms de votre entity et de votre projet W&B.
config.group :
Regrouper les runs par métadonnées de run
Regroupez les runs par métadonnées pour les organiser selon leurs propriétés intrinsèques plutôt que selon des valeurs journalisées. Vous pouvez les regrouper par nom (Name), par état (State) ou par type de job (JobType).
Pour reprendre l’exemple précédent, vous pouvez regrouper vos runs par nom à l’aide de l’extrait de code suivant :
Le nom du run est celui que vous indiquez dans le paramètre
wandb.init(name=). Si vous n’indiquez pas de nom, W&B génère un nom aléatoire pour le run.Vous trouverez le nom du run sur la page Aperçu du run dans l’application W&B, ou par programmation avec Api.runs().run.name.Grouper les runs par métriques de synthèse
Les exemples suivants montrent comment grouper des runs par métriques de synthèse. Les métriques de synthèse sont les valeurs que vous journalisez dans un run avecwandb.Run.log(). Une fois un run journalisé, les noms de vos métriques de synthèse figurent dans l’App W&B, dans la section Summary de la page Overview du run.
Pour grouper des runs par métriques de synthèse, utilisez la syntaxe summary.[KEY], où [KEY] est le nom de la métrique de synthèse selon laquelle vous souhaitez effectuer le groupement.
Par exemple, supposons que vous journalisiez une métrique de synthèse nommée acc. Remplacez [ENTITY] et [PROJECT] par les noms de votre entity et de votre projet W&B :
summary.acc :
Filtrer un ensemble de runs par programmation
Filtrez des ensembles de runs par programmation et ajoutez-les à un rapport avec l’API Workspace and Reports. Le filtrage permet de limiter un ensemble de runs aux seuls runs que vous souhaitez afficher, en fonction des valeurs de configuration, des métriques, des tags ou des propriétés des runs. La syntaxe générale d’une expression de filtre est la suivante :[KEY] est le nom du filtre, operation est un opérateur de comparaison (par exemple, >, <, ==, in, not in, or et and) et [VALUE] est la valeur à laquelle comparer. Filter est un espace réservé pour le type de filtre que vous souhaitez appliquer. Le tableau suivant répertorie les filtres disponibles et leur description :
Après avoir défini vos filtres, vous pouvez créer un rapport et transmettre les ensembles de runs filtrés à
wr.PanelGrid(runsets=). Consultez les onglets Report and Workspace API de cette page pour savoir comment ajouter par programmation différents éléments à un rapport.
Les exemples suivants montrent comment filtrer des ensembles de runs dans un rapport. Remplacez les valeurs entre crochets (par exemple, [ENTITY] et [PROJECT]) par vos propres valeurs.
Filtres de configuration
Filtrez un run set selon une ou plusieurs valeurs de configuration. Les valeurs de configuration sont les paramètres que vous définissez dans la configuration de votre run (wandb.init(config=)).
Par exemple, l’extrait de code suivant initialise d’abord un run avec des valeurs de configuration pour learning_rate et batch_size, puis filtre les runs d’un rapport en fonction de la valeur de configuration learning_rate.
0.01.
and :
Filtres de métriques
Filtrez les ensembles de runs en fonction du tag d’un run (tags), de son état (state), de son nom (displayName) ou du type de job (jobType).
Les filtres
Metric utilisent une syntaxe différente de celle des autres filtres. Vous devez transmettre les valeurs sous forme de liste.run1, run2 et run3, utilisez le code suivant :
Vous pouvez trouver le nom du run sur la page Overview d’un run dans l’application W&B, ou par programmation avec
Api.runs().run.name.finished, crashed ou running) :
Filtres SummaryMetric
Filtrez un run set selon les métriques de synthèse pour vous concentrer sur les runs qui atteignent certains seuils de résultat, par exemple des valeurs de précision ou de perte. Les métriques de synthèse sont les valeurs que vous journalisez dans un run avecwandb.Run.log(). Une fois un run journalisé, les noms de vos métriques de synthèse figurent dans l’application W&B, dans la section Summary de la page Overview du run.
Filtres par tags
Filtrez un run set par tags pour n’afficher que les runs auxquels vous avez attribué un tag donné. Les tags sont des valeurs que vous ajoutez à un run (par programmation ou via l’application W&B).Ajouter des blocs de code
Ajoutez des blocs de code pour partager une configuration, des exemples ou des extraits de code avec vos résultats. Vous pouvez les ajouter de manière interactive depuis l’interface de l’application ou par programmation avec le SDK W&B.- Interface de l’application
- API Report and Workspace
Saisissez une barre oblique (
/) dans le rapport pour afficher un menu déroulant. Dans ce menu, choisissez Code.Sélectionnez le nom du langage de programmation dans le bloc de code pour ouvrir un menu déroulant. Dans ce menu, sélectionnez la syntaxe de votre langage de programmation. Vous avez le choix entre JavaScript, Python, CSS, JSON, HTML, Markdown et YAML.Ajouter du markdown
Ajoutez du markdown pour mettre en forme le texte narratif, les titres et la mise en valeur du texte dans votre rapport. Vous pouvez ajouter du markdown de manière interactive depuis l’interface de l’application ou par programmation avec le SDK W&B.- Interface de l’application
- API Report et Workspace
Saisissez une barre oblique (
/) dans le rapport pour afficher un menu déroulant. Dans ce menu, choisissez Markdown.Ajouter des éléments HTML
Ajoutez des éléments HTML, tels que des titres et des listes, pour structurer votre rapport. Vous pouvez les ajouter de manière interactive depuis l’interface de l’application ou par programmation avec le SDK W&B.Lorsque vous journalisez une image avec
wandb.Image, W&B enregistre le fichier non pas sous son nom d’origine, mais sous un nom généré qui inclut un hachage du contenu, par exemple media/images/[key]_[step]_[hash].png. Par conséquent, une balise <img> ou une image markdown qui fait référence au nom de fichier d’origine ne peut pas être résolue. Pour intégrer une image journalisée dans un rapport, journalisez d’abord l’image, puis utilisez le chemin de fichier généré comme valeur src de l’image.- Interface de l’application
- API Report and Workspace
Saisissez une barre oblique (
/) dans le rapport pour afficher un menu déroulant. Dans ce menu, sélectionnez un type de bloc de texte. Par exemple, pour créer un bloc de titre H2, sélectionnez l’option Heading 2.Intégrer des liens vers des médias enrichis
Intégrez des médias enrichis, tels que des tweets, des vidéos et des fichiers audio, pour apporter un contexte externe à votre rapport. Vous pouvez intégrer des médias enrichis depuis l’interface de l’application ou avec le SDK W&B.- Interface de l’application
- API Report et Workspace
Copiez-collez des URL dans vos rapports pour y intégrer des médias enrichis. Les animations suivantes montrent comment copier-coller des URL depuis Twitter, YouTube et SoundCloud.Twitter
Copiez-collez l’URL d’un tweet dans un rapport pour l’y afficher.



YouTube
Copiez-collez l’URL d’une vidéo YouTube pour l’intégrer dans le rapport.
SoundCloud
Copiez-collez un lien SoundCloud pour intégrer un fichier audio dans un rapport.
Dupliquer des grilles de panneaux
Dupliquez une grille de panneaux pour réutiliser sa mise en page dans le même rapport ou dans un autre rapport. Sélectionnez une grille de panneaux, puis copiez-collez-la pour la dupliquer dans le même rapport ou collez-la dans un autre rapport. Pour mettre en surbrillance une section entière de grille de panneaux, sélectionnez la poignée de glissement dans le coin supérieur droit. Cliquez et faites glisser le pointeur pour mettre en surbrillance et sélectionner une zone d’un rapport, par exemple des grilles de panneaux, du texte ou des titres.
Supprimer des panel grids
Supprimez une panel grid lorsque vous n’avez plus besoin de sa mise en page ou de son contenu dans le rapport. Pour ce faire, sélectionnez-la et appuyez sur la touchedelete de votre clavier.

Réduire les en-têtes pour organiser les rapports
Réduisez les en-têtes d’un rapport pour masquer le contenu d’un bloc de texte. Au chargement du rapport, seuls les en-têtes développés affichent leur contenu. Réduire les en-têtes permet de mieux organiser le contenu de vos rapports et d’éviter de charger plus de données que nécessaire. L’animation suivante illustre la procédure.
Visualiser les relations sur plusieurs dimensions
Lorsque vous souhaitez faire ressortir les relations entre trois variables ou plus dans un seul graphique, un graphique 2D standard peut s’avérer limité. Pour comparer plus de variables qu’un graphique 2D ne permet d’en afficher, vous pouvez utiliser un dégradé de couleur comme dimension supplémentaire. Représenter l’une des variables par un dégradé de couleur peut rendre les tendances plus faciles à interpréter.- Choisissez une variable à représenter par un dégradé de couleur, comme les scores de pénalité ou les taux d’apprentissage. Vous comprendrez ainsi plus clairement comment la pénalité (couleur) interagit avec la récompense ou les effets secondaires (axe Y) au fil de l’entraînement (axe X).
- Faites ressortir les tendances clés. Survolez un groupe de runs donné pour le mettre en évidence dans la visualisation.

