Skip to main content
L’API Report and Workspace de W&B est en préversion publique.
Bibliothèque Python permettant d’utiliser l’API W&B Reports de manière programmatique.

classe BarPlot

Un objet de panneau qui affiche un graphique à barres 2D. Attributs :
  • title (Optional[str]) : Le texte affiché en haut du graphique.
  • metrics (LList[MetricType]) : orientation Literal[“v”, “h”] : L’orientation du graphique à barres. Choisissez vertical (“v”) ou horizontal (“h”). Valeur par défaut : horizontal (“h”).
  • range_x (Tuple[float | None, float | None]) : Tuple qui définit la plage de l’axe X.
  • title_x (Optional[str]) : Le libellé de l’axe X.
  • title_y (Optional[str]) : Le libellé de l’axe Y.
  • groupby (Optional[str]) : Regroupe les runs selon une métrique journalisée dans le projet W&B d’où le rapport extrait ses informations.
  • groupby_aggfunc (Optional[GroupAgg]) : Agrège les runs avec la fonction spécifiée. Valeurs possibles : “mean”, “min”, “max”, “median”, “sum”, “samples” ou None.
  • groupby_rangefunc (Optional[GroupArea]) : Regroupe les runs selon une plage. Valeurs possibles : “minmax”, “stddev”, “stderr”, “none”, “samples” ou None.
  • max_runs_to_show (Optional[int]) : Le nombre maximum de runs à afficher sur le graphique.
  • max_bars_to_show (Optional[int]) : Le nombre maximum de barres à afficher sur le graphique à barres.
  • custom_expressions (Optional[LList[str]]) : Une liste d’expressions personnalisées à utiliser dans le graphique à barres.
  • legend_template (Optional[str]) : Le modèle de la légende.
  • font_size ( Optional[FontSize]) : La taille de police du graphique en courbes. Valeurs possibles : “small”, “medium”, “large”, “auto” ou None.
  • line_titles (Optional[dict]) : Les titres des courbes. Les clés correspondent aux noms des courbes et les valeurs aux titres.
  • line_colors (Optional[dict]) : Les couleurs des courbes. Les clés correspondent aux noms des courbes et les valeurs aux couleurs.
  • aggregate (Optional[bool]) : Si la valeur est True, les données sont agrégées.

classe BlockQuote

Un bloc de texte cité. Attributs :
  • text (str) : Le texte du bloc de citation.

classe CalloutBlock

Un bloc de texte d’encadré. Attributs :
  • text (str) : Le texte de l’encadré.

classe CheckedList

Une liste d’éléments avec des cases à cocher. Ajoutez un ou plusieurs CheckedListItem dans CheckedList. Attributs :
  • items (LList[CheckedListItem]) : Une liste d’un ou plusieurs objets CheckedListItem.

classe CheckedListItem

Élément de liste avec une case à cocher. Ajoutez un ou plusieurs CheckedListItem dans CheckedList. Attributs :
  • text (str) : Texte de l’élément de liste.
  • checked (bool) : Indique si la case est cochée. La valeur par défaut est False.

classe CodeBlock

Un bloc de code. Attributs :
  • code (str) : Le code contenu dans le bloc.
  • language (Optional[Language]) : Le langage du code. Le langage indiqué sert à la coloration syntaxique. Valeur par défaut : “python”. Valeurs possibles : ‘javascript’, ‘python’, ‘css’, ‘json’, ‘html’, ‘markdown’, ‘yaml’.

classe CodeComparer

Objet de panneau qui compare le code de deux runs différents. Attributs :
  • diff (Literal[‘split’, ‘unified’]) : Mode d’affichage des différences de code. Les valeurs possibles sont « split » et « unified ».

classe Config

Métriques journalisées dans l’objet de configuration d’un run. Les objets de configuration sont généralement journalisés avec run.config[name] = ... ou en passant une configuration sous forme de dictionnaire de paires clé-valeur, où la clé correspond au nom de la métrique et la valeur à la valeur de cette métrique. Attributs :
  • name (str) : Le nom de la métrique.

classe CustomChart

Un panneau qui affiche un graphique personnalisé. Le graphique est défini par une requête Weave. Attributs :
  • query (dict) : La requête qui définit le graphique personnalisé. La clé correspond au nom du champ et la valeur, à la requête.
  • chart_name (str) : Le titre du graphique personnalisé.
  • chart_fields (dict) : Paires clé-valeur qui définissent les axes du graphique. La clé correspond au libellé et la valeur, à la métrique.
  • chart_strings (dict) : Paires clé-valeur qui définissent les chaînes de caractères du graphique.

classmethod from_table

Crée un graphique personnalisé à partir d’un tableau. Arguments :
  • table_name (str) : Le nom du tableau.
  • chart_fields (dict) : Les champs à afficher dans le graphique.
  • chart_strings (dict) : Les chaînes de caractères à afficher dans le graphique.

Un bloc qui affiche une galerie de rapports et d’URL. Attributs :
  • items (List[Union[GalleryReport, GalleryURL]]) : Une liste d’objets GalleryReport et GalleryURL.

classe GalleryReport

Référence à un rapport de la galerie. Attributs :
  • report_id (str) : ID du rapport.

classe GalleryURL

Une URL pointant vers une ressource externe. Attributs :
  • url (str) : L’URL de la ressource.
  • title (Optional[str]) : Le titre de la ressource.
  • description (Optional[str]) : La description de la ressource.
  • image_url (Optional[str]) : L’URL d’une image à afficher.

classe GradientPoint

Un point d’un dégradé. Attributs :
  • color : La couleur du point.
  • offset : La position du point dans le dégradé. La valeur doit être comprise entre 0 et 100.

classe H1

Un titre H1 contenant le texte spécifié. Attributs :
  • text (str) : Le texte du titre.
  • collapsed_blocks (Optional[LList[“BlockTypes”]]) : Les blocs à afficher lorsque le titre est replié.

classe H2

Un titre H2 contenant le texte spécifié. Attributs :
  • text (str) : Le texte du titre.
  • collapsed_blocks (Optional[LList[“BlockTypes”]]) : Un ou plusieurs blocs à afficher lorsque le titre est replié.

classe H3

Un titre H3 contenant le texte indiqué. Attributs :
  • text (str) : Le texte du titre.
  • collapsed_blocks (Optional[LList[“BlockTypes”]]) : Un ou plusieurs blocs à afficher lorsque le titre est replié.

classe Heading


classe HorizontalRule

Ligne horizontale HTML.

classe Image

Un bloc qui affiche une image. Attributs :
  • url (str) : L’URL de l’image.
  • caption (str) : La légende de l’image. La légende s’affiche sous l’image.

classe InlineCode

Code en ligne. N’ajoute pas de saut de ligne après le code. Attributs :
  • text (str) : Le code à afficher dans le rapport.

classe InlineLatex

Markdown LaTeX en ligne. N’ajoute pas de caractère de saut de ligne après le markdown LaTeX. Attributs :
  • text (str) : markdown LaTeX à afficher dans le rapport.

classe LatexBlock

Un bloc de texte LaTeX. Attributs :
  • text (str) : Le texte LaTeX.

classe Layout

La mise en page d’un panneau dans un rapport. Ajuste la taille et la position du panneau. Attributs :
  • x (int) : La position en x du panneau.
  • y (int) : La position en y du panneau.
  • w (int) : La largeur du panneau.
  • h (int) : La hauteur du panneau.

classe LinePlot

Un objet de panneau contenant des graphiques en courbes 2D. Attributs :
  • title (Optional[str]) : Texte affiché en haut du graphique.
  • x (Optional[MetricType]) : Nom d’une métrique journalisée dans votre projet W&B dont le rapport extrait les informations. La métrique indiquée est utilisée pour l’axe X.
  • y (LList[MetricType]) : Une ou plusieurs métriques journalisées dans votre projet W&B dont le rapport extrait les informations. La métrique indiquée est utilisée pour l’axe Y.
  • range_x (Tuple[float | None, float | None]) : Tuple définissant la plage de l’axe X.
  • range_y (Tuple[float | None, float | None]) : Tuple définissant la plage de l’axe Y.
  • log_x (Optional[bool]) : Trace les coordonnées x sur une échelle logarithmique en base 10.
  • log_y (Optional[bool]) : Trace les coordonnées y sur une échelle logarithmique en base 10.
  • title_x (Optional[str]) : Libellé de l’axe X.
  • title_y (Optional[str]) : Libellé de l’axe Y.
  • ignore_outliers (Optional[bool]) : Si la valeur est True, les valeurs aberrantes ne sont pas tracées.
  • groupby (Optional[str]) : Regroupe les runs en fonction d’une métrique journalisée dans votre projet W&B dont le rapport extrait les informations.
  • groupby_aggfunc (Optional[GroupAgg]) : Agrège les runs à l’aide de la fonction spécifiée. Les valeurs possibles sont “mean”, “min”, “max”, “median”, “sum”, “samples” ou None.
  • groupby_rangefunc (Optional[GroupArea]) : Regroupe les runs en fonction d’une plage. Les valeurs possibles sont “minmax”, “stddev”, “stderr”, “none”, “samples” ou None.
  • smoothing_factor (Optional[float]) : Facteur de lissage à appliquer au type de lissage. Les valeurs acceptées sont comprises entre 0 et 1.
  • smoothing_type Optional[SmoothingType] : Applique un filtre basé sur la distribution spécifiée. Les valeurs possibles sont “exponentialTimeWeighted”, “exponential”, “gaussian”, “average” ou “none”.
  • smoothing_show_original (Optional[bool]) : Si la valeur est True, affiche les données d’origine.
  • max_runs_to_show (Optional[int]) : Nombre maximum de runs à afficher sur le graphique en courbes.
  • custom_expressions (Optional[LList[str]]) : Expressions personnalisées à appliquer aux données.
  • plot_type Optional[LinePlotStyle] : Type de graphique en courbes à générer. Les valeurs possibles sont “line”, “stacked-area” ou “pct-area”.
  • font_size Optional[FontSize] : Taille de police du graphique en courbes. Les valeurs possibles sont “small”, “medium”, “large”, “auto” ou None.
  • legend_position Optional[LegendPosition] : Position de la légende. Les valeurs possibles sont “north”, “south”, “east”, “west” ou None.
  • legend_template (Optional[str]) : Modèle de la légende.
  • aggregate (Optional[bool]) : Si la valeur est True, agrège les données.
  • xaxis_expression (Optional[str]) : Expression de l’axe X.
  • xaxis_format (Optional[str]) : Format de l’axe X. Cette option apparaît si vous définissez une métrique personnalisée. Par exemple, vous pouvez indiquer ‘datetime’ pour afficher l’axe X sous forme de date et d’heure.
  • legend_fields (Optional[LList[str]]): Les champs à inclure dans la légende.
  • metric_regex (Optional[str]): Motif d’expression régulière servant à identifier les métriques de l’axe Y. Le backend utilise ce motif pour sélectionner les métriques correspondantes.
  • point_visualization_method (Optional[PointVizMethod]): La méthode utilisée pour agréger les points lorsqu’ils sont trop nombreux pour être affichés. Les valeurs possibles sont “bucketing-gorilla” (répartit les points de données en intervalles et affiche le min, le max et la moyenne de chaque intervalle afin de conserver les valeurs aberrantes et les pics) ou “sampling” (échantillonne aléatoirement les points pour accélérer le rendu, au risque d’omettre des valeurs aberrantes).
  • line_titles (Optional[Dict[str, str]]) : titres d’affichage par série. Les clés suivent le format ”:”.
  • line_colors (Optional[Dict[str, Any]]) : couleurs par série. Les clés sont au format ”:”.
  • line_widths (Optional[Dict[str, float]]) : Épaisseurs de ligne par série. Les clés sont au format ”:”.
  • line_marks (Optional[Dict[str, Mark]]) : styles de tirets par série. Les clés sont au format ”:”.
  • Valid values : “solid”, “dashed”, “dotted”, “dotdash”, “dotdotdash”, “points”.

Un lien vers une URL. Attributs :
  • text (Union[str, TextWithInlineComments]) : Le texte du lien.
  • url (str) : L’URL vers laquelle pointe le lien.

classe MarkdownBlock

Un bloc de texte Markdown. Utile pour rédiger du texte avec la syntaxe Markdown courante. Attributs :
  • text (str) : Le texte Markdown.

classe MarkdownPanel

Un panneau qui affiche du contenu Markdown. Attributs :
  • markdown (str) : Le texte à afficher dans le panneau Markdown.

classe MediaBrowser

Panneau qui affiche des fichiers multimédias sous forme de galerie ou de grille. Attributs :
  • title (Optional[str]) : Le titre du panneau.
  • num_columns (Optional[int]) : Le nombre de colonnes de la grille.
  • media_keys (LList[str]) : Une liste de clés de médias correspondant aux fichiers multimédias.
  • mode (Optional[Literal[“gallery”, “grid”]]) : Le mode d’affichage du panneau. S’il n’est pas spécifié, il est déduit des axes fournis. Requis si gallery_axis et les axes de la grille sont tous deux spécifiés.
  • gallery_axis (Optional[Literal[“step”, “index”, “run”]]) : Le champ à utiliser pour l’axe en mode galerie.
  • grid_x_axis (Optional[Literal[“step”, “index”, “run”]]) : Le champ à utiliser pour l’axe X en mode grille.
  • grid_y_axis (Optional[Literal[“step”, “index”, “run”]]) : Le champ à utiliser pour l’axe Y en mode grille.

classe Metric

Une métrique journalisée dans votre projet, à afficher dans un rapport. Attributs :
  • name (str) : Le nom de la métrique.

classe OrderBy

Métrique utilisée pour le tri. Attributs :
  • name (str) : Le nom de la métrique.
  • ascending (bool) : Indique s’il faut trier par ordre croissant. Valeur par défaut : False.

classe OrderedList

Liste d’éléments d’une liste numérotée. Attributs :
  • items (LList[TextLikeField]) : liste d’un ou plusieurs objets OrderedListItem. Chaque élément peut être une chaîne de caractères ou une liste d’objets TextLike.

classe OrderedListItem

Un élément d’une liste ordonnée. Attributs :
  • text (str) : Le texte de l’élément de liste.

classe P

Un paragraphe de texte. Attributs :
  • text (str) : Le texte du paragraphe.

classe Panel

Panneau qui affiche une visualisation dans une grille de panneaux. Attributs :
  • layout (Layout) : un objet Layout.

classe PanelGrid

Une grille composée de runsets et de panneaux. Ajoutez des runsets et des panneaux à l’aide des objets Runset et Panel, respectivement. Les panneaux disponibles sont les suivants : LinePlot, ScatterPlot, BarPlot, ScalarChart, CodeComparer, ParallelCoordinatesPlot, ParameterImportancePlot, RunComparer, MediaBrowser, MarkdownPanel, CustomChart, WeavePanel, WeavePanelSummaryTable, WeavePanelArtifactVersionedFile. Attributs :
  • runsets (LList[“Runset”]) : liste d’un ou de plusieurs objets Runset.
  • hide_run_sets (bool) : indique si les ensembles de runs de la grille de panneaux doivent être masqués pour les lecteurs du rapport.
  • panels (LList[“PanelTypes”]) : liste d’un ou de plusieurs objets Panel.
  • active_runset (Optional[int]) : index de l’onglet du runset actif. Valeur par défaut : 0.
  • custom_run_colors (dict) : paires clé-valeur dont la clé est le nom d’un run et la valeur une couleur exprimée en hexadécimal.

classe ParallelCoordinatesPlot

Objet de panneau qui affiche un graphique en coordonnées parallèles. Attributs :
  • columns (LList[ParallelCoordinatesPlotColumn]) : Liste d’un ou plusieurs objets ParallelCoordinatesPlotColumn.
  • title (Optional[str]) : Texte affiché en haut du graphique.
  • gradient (Optional[LList[GradientPoint]]) : Liste de points de dégradé.
  • font_size (Optional[FontSize]) : Taille de la police du graphique en courbes. Valeurs possibles : « small », « medium », « large », « auto » ou None.

classe ParallelCoordinatesPlotColumn

Une colonne d’un graphique de coordonnées parallèles. L’ordre dans lequel les metric sont spécifiées détermine l’ordre des axes parallèles (axe X) du graphique de coordonnées parallèles. Attributs :
  • metric (str | Config | SummaryMetric) : Le nom de la métrique journalisée dans votre projet W&B à partir de laquelle le rapport extrait les informations.
  • display_name (Optional[str]) : Le nom d’affichage de la métrique
  • inverted (Optional[bool]) : Indique si la métrique doit être inversée.
  • log (Optional[bool]) : Indique si une transformation logarithmique doit être appliquée à la métrique.

classe ParameterImportancePlot

Un panneau qui affiche l’importance de chaque hyperparamètre dans la prédiction de la métrique choisie. Attributs :
  • with_respect_to (str) : La métrique par rapport à laquelle vous souhaitez évaluer l’importance des paramètres. Il peut s’agir, par exemple, de la perte ou de la précision. La métrique spécifiée doit être journalisée dans le projet dont le rapport extrait ses informations.

classe Report

Objet représentant un W&B Report. Utilisez l’attribut blocks de l’objet renvoyé pour personnaliser votre rapport. Les objets Report ne sont pas enregistrés automatiquement. Utilisez la méthode save() pour enregistrer les modifications. Attributs :
  • project (str) : Le nom du projet W&B à charger. Le projet spécifié apparaît dans l’URL du rapport.
  • entity (str) : L’entity W&B propriétaire du rapport. L’entity apparaît dans l’URL du rapport.
  • title (str) : Le titre du rapport. Le titre s’affiche en haut du rapport sous forme de titre H1.
  • description (str) : Une description du rapport. La description s’affiche sous le titre du rapport.
  • blocks (LList[BlockTypes]) : Une liste d’une ou plusieurs balises HTML, graphiques, grilles, runsets, etc.
  • width (Literal[‘readable’, ‘fixed’, ‘fluid’]) : La largeur du rapport. Valeurs possibles : ‘readable’, ‘fixed’ et ‘fluid’.

property url

L’URL à laquelle le rapport est hébergé. L’URL du rapport est de la forme https://wandb.ai/{entity}/{project_name}/reports/, où {entity} et {project_name} correspondent respectivement à l’entity à laquelle appartient le rapport et au nom du projet.

méthode delete

Supprime ce rapport de W&B. Cette opération supprime également toutes les vues en brouillon qui font référence à ce rapport. Retourne :
  • bool : True si le backend a confirmé la réussite de l’opération de suppression, False sinon.

Désactive le lien de partage « toute personne disposant du lien peut consulter » pour ce rapport. Révoque tous les jetons d’accès publics actifs du rapport. Retourne :
  • bool : True si un ou plusieurs liens ont été révoqués, False si aucun lien actif n’existait.

Active le partage « toute personne disposant du lien peut consulter » pour ce rapport. Crée un jeton d’accès public pour le rapport. Si un lien de partage existe déjà, renvoie ce lien. Retourne :
  • str : L’URL du lien magique à partager.

classmethod from_url

Charge le rapport dans l’environnement actuel. Transmettez l’URL à laquelle le rapport est hébergé. Arguments :
  • url (str) : L’URL à laquelle le rapport est hébergé.
  • as_model (bool) : Si True, renvoie l’objet modèle au lieu de l’objet Report. Défini sur False par défaut.

méthode get_share_url

Récupère l’URL du lien magique de ce rapport, ou None si le partage n’est pas activé. Effectue un appel réseau pour vérifier s’il existe des jetons d’accès actifs. Renvoie l’URL du rapport suivie d’un jeton d’accès, ce qui permet à toute personne disposant du lien de consulter le rapport, même si le projet est privé.

méthode save

Enregistre les modifications apportées à un objet rapport.

méthode to_html

Génère du code HTML contenant une iframe qui affiche ce rapport. Généralement utilisé dans un notebook Python. Arguments :
  • height (int) : Hauteur de l’iframe.
  • hidden (bool) : Si True, masque l’iframe. Par défaut : False.

classe RunComparer

Panneau qui compare les métriques de différents runs du projet dont le rapport extrait ses informations. Attributs :
  • diff_only (Optional[Literal[“split”, True]]) : Affiche uniquement les différences entre les runs d’un projet. Vous pouvez activer ou désactiver cette fonctionnalité dans l’interface de W&B Report.

classe RunSettings

Configure l’apparence et la visibilité d’un run donné dans une grille de panneaux de rapport. Utilisez RunSettings pour personnaliser le rendu d’un run spécifique dans un Runset, notamment la couleur de sa ligne et sa visibilité dans les graphiques. Attributs :
  • color : Couleur d’affichage du run. Accepte le format hexadécimal (#ff0000), un nom de couleur CSS (red) ou une string RGB (“rgb(255,0,0)”).
  • disabled : Si True, masque le run dans les graphiques. Cela revient à cliquer sur l’icône en forme d’œil barré dans l’interface utilisateur.

classe Runset

Un ensemble de runs à afficher dans une grille de panneaux. Attributs :
  • entity (str) : Une entity propriétaire du projet où sont stockés les runs, ou disposant des autorisations appropriées sur ce projet.
  • project (str) : Le nom du projet où sont stockés les runs.
  • name (str) : Le nom de l’ensemble de runs. Défini sur Run set par défaut.
  • query (str) : Une chaîne de requête pour filtrer les runs.
  • filters (Union[str, LList[expr.FilterExpr]]) : Filtres à appliquer aux runs. Valeurs possibles :
    • Une expression sous forme de chaîne : par ex., “Config(‘lr’) = 0.001 and State = ‘finished’”
  • Supports operators : =, ==, !=, <, >, <=, >=, in, not in, and, or
    • Une liste d’objets FilterExpr : par ex., [expr.Config(‘lr’) == 0.001]
  • groupby (LList[str]) : Une liste de noms de métriques servant au regroupement. Les formats pris en charge sont :
    • “group” ou “run.group” pour regrouper selon un attribut de run
    • “config.param” pour regrouper selon un paramètre de configuration
    • “summary.metric” pour regrouper selon une métrique de synthèse
  • order (LList[OrderBy]) : Une liste d’objets OrderBy définissant l’ordre de tri.
  • custom_run_colors (dict) : Un dictionnaire associant des ID de runs (ou des clés RunsetGroup pour les runs regroupés) à des couleurs. Pour définir simplement une couleur par run, privilégiez run_settings.
  • run_settings (Dict[str, RunSettings]) : Paramètres d’affichage par run, indexés par ID du run. Utilisez-les pour définir des couleurs et/ou masquer des runs individuels. Voir RunSettings.
  • pinned_columns (LList[str]) : Accesseurs des colonnes à épingler à gauche de
  • the runs table (e.g. [“summary : accuracy", "config:lr.value"]). Les colonnes figurant aussi dans hidden_columns sont retirées lors de l’enregistrement.
  • visible_columns (LList[str]) : Accesseurs des colonnes à afficher obligatoirement. À utiliser avec lock_columns=True pour définir précisément l’ensemble visible. Au rechargement, inclut également les colonnes définies uniquement via column_order.
  • hidden_columns (LList[str]) : Accesseurs des colonnes à masquer. Prévaut sur pinned_columns, visible_columns et column_order. Au rechargement, peut inclure des entrées initialisées par le serveur
  • like run : name.
  • column_order (LList[str]) : Ordre des colonnes de gauche à droite. Avec lock_columns=True, les entrées absentes de pinned_columns et de visible_columns sont supprimées.
  • column_widths (Dict[str, int]) : Largeur en pixels de chaque colonne.
  • lock_columns (Optional[bool]) : Verrouillage facultatif de l’ensemble de colonnes du tableau des runs. True affiche uniquement pinned_columns et visible_columns ; False ou None (par défaut) n’impose aucune restriction. Correspond à l’icône de verrou dans la barre d’outils du tableau des runs.
Format des colonnes :
  • Les colonnes sont désignées sous la forme "<section>: <name>" :
    • run:<attr> : propriétés intégrées du run (par ex. run:state)
    • config:<key>.value : clés de configuration (notez le suffixe .value)
    • summary:<key> : métriques de synthèse
    • tags:__ALL__ : tags du run
Limite de colonnes : le tableau des runs du frontend affiche au maximum 500 colonnes. Lorsque l’ensemble visible (épinglées + visibles + column_order, moins les masquées) atteint ou dépasse 500, le SDK émet un avertissement lors de l’enregistrement ; les colonnes masquées ne sont pas prises en compte. Le SDK ne tronque rien : l’ensemble complet est envoyé et le frontend applique la limite lors du rendu. Exemple :

méthode convert_filterexpr_list_to_string

Convertit une liste de FilterExpr en expression de type string.

méthode merge_custom_run_colors_into_run_settings

Fusionne les custom_run_colors dont les clés sont de simples strings dans run_settings, pour assurer la rétrocompatibilité.

classe RunsetGroup

Élément d’interface qui affiche un groupe de runsets. Attributs :
  • runset_name (str) : Le nom du runset.
  • keys (Tuple[RunsetGroupKey, …]) : Les clés de regroupement. Transmettez un ou plusieurs objets RunsetGroupKey selon lesquels regrouper.

classe RunsetGroupKey

Regroupe les runsets selon un type de métrique et une valeur. Fait partie d’un RunsetGroup. Indiquez le type de métrique et la valeur de regroupement sous forme de paires clé-valeur. Attributs :
  • key (Type[str] | Type[Config] | Type[SummaryMetric] | Type[Metric]) : Le type de métrique utilisé pour le regroupement.
  • value (str) : La valeur de la métrique utilisée pour le regroupement.

classe ScalarChart

Objet de panneau qui affiche un graphique scalaire. Attributs :
  • title (Optional[str]) : Texte affiché en haut du graphique.
  • metric (MetricType) : Nom d’une métrique journalisée dans votre projet W&B, dont le rapport extrait les informations.
  • groupby_aggfunc (Optional[GroupAgg]) : Agrège les runs à l’aide de la fonction spécifiée. Valeurs possibles : “mean”, “min”, “max”, “median”, “sum”, “samples” ou None.
  • groupby_rangefunc (Optional[GroupArea]) : Regroupe les runs selon une plage. Valeurs possibles : “minmax”, “stddev”, “stderr”, “none”, “samples” ou None.
  • custom_expressions (Optional[LList[str]]) : Liste d’expressions personnalisées à utiliser dans le graphique scalaire.
  • legend_template (Optional[str]) : Modèle de la légende.
  • font_size Optional[FontSize] : Taille de la police du graphique en courbes. Valeurs possibles : “small”, “medium”, “large”, “auto” ou None.

classe ScatterPlot

Objet de panneau qui affiche un nuage de points en 2D ou en 3D. Arguments :
  • title (Optional[str]) : Texte affiché en haut du graphique.
  • x Optional[SummaryOrConfigOnlyMetric] : Nom d’une métrique journalisée dans votre projet W&B, dont le rapport extrait les informations. La métrique indiquée est utilisée pour l’axe X.
  • y Optional[SummaryOrConfigOnlyMetric] : Une ou plusieurs métriques journalisées dans votre projet W&B, dont le rapport extrait les informations. Les métriques indiquées sont tracées sur l’axe Y. z Optional[SummaryOrConfigOnlyMetric] :
  • range_x (Tuple[float | None, float | None]) : Tuple qui définit la plage de l’axe X.
  • range_y (Tuple[float | None, float | None]) : Tuple qui définit la plage de l’axe Y.
  • range_z (Tuple[float | None, float | None]) : Tuple qui définit la plage de l’axe Z.
  • log_x (Optional[bool]) : Trace les coordonnées x sur une échelle logarithmique en base 10.
  • log_y (Optional[bool]) : Trace les coordonnées y sur une échelle logarithmique en base 10.
  • log_z (Optional[bool]) : Trace les coordonnées z sur une échelle logarithmique en base 10.
  • running_ymin (Optional[bool]) : Applique une moyenne mobile ou glissante.
  • running_ymax (Optional[bool]) : Applique une moyenne mobile ou glissante.
  • running_ymean (Optional[bool]) : Applique une moyenne mobile ou glissante.
  • legend_template (Optional[str]) : String qui définit le format de la légende.
  • gradient (Optional[LList[GradientPoint]]) : Liste de points de dégradé qui définissent le dégradé de couleur du graphique.
  • font_size (Optional[FontSize]) : Taille de la police du graphique en courbes. Valeurs possibles : “small”, “medium”, “large”, “auto” ou None.
  • regression (Optional[bool]) : Si True, une droite de régression est tracée sur le nuage de points.

classe SoundCloud

Un bloc qui affiche un lecteur SoundCloud. Attributs :
  • html (str) : Le code HTML permettant d’intégrer le lecteur SoundCloud.

classe Spotify

Un bloc qui affiche un lecteur Spotify. Attributs :
  • spotify_id (str) : L’identifiant Spotify du titre ou de la playlist.

classe SummaryMetric

Une métrique de synthèse à afficher dans un rapport. Attributs :
  • name (str) : Le nom de la métrique.

classe TableOfContents

Bloc contenant une liste de sections et de sous-sections établie à partir des blocs HTML H1, H2 et H3 définis dans un rapport.

classe TextWithInlineComments

Bloc de texte comportant des commentaires intégrés. Attributs :
  • text (str) : Le texte du bloc.

classe Twitter

Bloc qui affiche un fil Twitter. Attributs :
  • html (str) : code HTML permettant d’afficher le fil Twitter.

classe UnorderedList

Liste d’éléments présentés sous forme de liste à puces. Attributs :
  • items (LList[TextLikeField]) : Liste d’un ou plusieurs objets UnorderedListItem. Chaque élément peut être une string ou une liste d’objets TextLike.

classe UnorderedListItem

Un élément d’une liste à puces. Attributs :
  • text (str) : Le texte de l’élément de liste.

classe Video

Un bloc qui affiche une vidéo. Attributs :
  • url (str) : L’URL de la vidéo.

classe WeaveBlockArtifact

Bloc qui affiche un artifact consigné dans W&B. La requête prend la forme suivante :
Le terme « Weave » figurant dans le nom de l’API ne fait pas référence à la boîte à outils W&B Weave utilisée pour le suivi et l’évaluation des LLM. Attributs :
  • entity (str) : L’entity propriétaire du projet dans lequel l’artifact est stocké, ou disposant des autorisations appropriées sur ce projet.
  • project (str) : Le projet dans lequel l’artifact est stocké.
  • artifact (str) : Le nom de l’artifact à récupérer.
  • tab Literal["overview", "metadata", "usage", "files", "lineage"] : L’onglet à afficher dans le panneau de l’artifact.

classe WeaveBlockArtifactVersionedFile

Bloc qui affiche un fichier versionné journalisé dans un artifact W&B. La requête prend la forme suivante
Le terme « Weave » dans le nom de l’API ne fait pas référence à la boîte à outils W&B Weave utilisée pour le suivi et l’évaluation des LLM. Attributs :
  • entity (str) : L’entity propriétaire du projet où l’artifact est stocké, ou qui dispose des autorisations appropriées sur ce projet.
  • project (str) : Le projet où l’artifact est stocké.
  • artifact (str) : Le nom de l’artifact à récupérer.
  • version (str) : La version de l’artifact à récupérer.
  • file (str) : Le nom du fichier à récupérer, stocké dans l’artifact.

classe WeaveBlockSummaryTable

Bloc qui affiche un tableau W&B, un DataFrame pandas, un graphique ou toute autre valeur consignée dans W&B. La requête prend la forme suivante
Le terme « Weave » dans le nom de l’API ne fait pas référence à la boîte à outils W&B Weave utilisée pour le suivi et l’évaluation des LLM. Attributs :
  • entity (str) : L’entity propriétaire du projet dans lequel les valeurs sont journalisées, ou disposant des autorisations appropriées sur ce projet.
  • project (str) : Le projet dans lequel la valeur est journalisée.
  • table_name (str) : Le nom du tableau, du DataFrame, du graphique ou de la valeur.

classe WeavePanel

Panneau de requête vide permettant d’afficher du contenu personnalisé à l’aide de requêtes. Le terme « Weave » dans le nom de l’API ne fait pas référence à la boîte à outils W&B Weave utilisée pour le suivi et l’évaluation des LLM.

classe WeavePanelArtifact

Un panneau qui affiche un artifact consigné dans W&B. Le terme « Weave » dans le nom de l’API ne fait pas référence à la boîte à outils W&B Weave, utilisée pour le suivi et l’évaluation des LLM. Attributs :
  • artifact (str) : Le nom de l’artifact à récupérer.
  • tab Literal["overview", "metadata", "usage", "files", "lineage"] : L’onglet à afficher dans le panneau de l’artifact.

classe WeavePanelArtifactVersionedFile

Un panneau qui affiche un fichier versionné journalisé dans un artifact W&B.
Le terme « Weave » dans le nom de l’API ne fait pas référence à la boîte à outils W&B Weave, utilisée pour le suivi et l’évaluation des LLM. Attributs :
  • artifact (str) : Le nom de l’artifact à récupérer.
  • version (str) : La version de l’artifact à récupérer.
  • file (str) : Le nom du fichier à récupérer, stocké dans l’artifact.

classe WeavePanelSummaryTable

Un panneau qui affiche un tableau W&B, un DataFrame pandas, un graphique ou toute autre valeur consignée dans W&B. La requête prend la forme suivante
Le terme « Weave » dans le nom de l’API ne fait pas référence à la boîte à outils W&B Weave utilisée pour le suivi et l’évaluation des LLM. Attributs :
  • table_name (str) : Le nom du tableau, du DataFrame, du graphique ou de la valeur.
  • layout (Layout) : La configuration de mise en page du panneau, notamment sa position et sa taille. Hérité de la classe de base Panel. Permet d’ajuster la largeur (w) et la hauteur (h).
Exemple : Créez un rapport contenant un panneau de tableau de synthèse qui affiche un tableau aux dimensions personnalisées :
Les paramètres de mise en page définissent les dimensions du panneau :
  • w (largeur) : largeur en unités de grille (par défaut : 8, max : 24)
    • h (hauteur) : hauteur en unités de grille (par défaut : 6)
    • x (position x) : position horizontale dans la grille (par défaut : 0)
    • y (position y) : position verticale dans la grille (par défaut : 0)
Dernière modification le 30 septembre 2026