Reports - Weights & Biases Documentation

L’API W&B Report and Workspace API est en préversion publique.

Bibliothèque Python permettant de travailler par programmation avec l’API W&B Reports.

import wandb_workspaces.reports.v2 as wr

report = wr.Report(
     entity="entity",
     project="project",
     title="An amazing title",
     description="A descriptive description.",
)

blocks = [
     wr.PanelGrid(
         panels=[
             wr.LinePlot(x="time", y="velocity"),
             wr.ScatterPlot(x="time", y="acceleration"),
         ]
     )
]

report.blocks = blocks
report.save()

`class` `BarPlot`

Un objet de panneau qui affiche un graphique en barres 2D. Attributs :

title (Optional[str]) : Le texte qui s’affiche en haut du graphique.
metrics (LList[MetricType]) : orientation Literal[“v”, “h”] : L’orientation du graphique en barres. Définissez-la sur verticale (“v”) ou horizontale (“h”). La valeur par défaut est l’orientation horizontale (“h”).
range_x (Tuple[float | None, float | None]) : Tuple qui spécifie 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]) : Regroupez les runs selon une métrique enregistrée dans votre projet W&B, à partir duquel le rapport extrait les informations.
groupby_aggfunc (Optional[GroupAgg]) : Agrégez les runs à l’aide de la fonction spécifiée. Les options incluent “mean”, “min”, “max”, “median”, “sum”, “samples” ou None.
groupby_rangefunc (Optional[GroupArea]) : Regroupez les runs selon une plage. Les options incluent “minmax”, “stddev”, “stderr”, “none”, “samples” ou None.
max_runs_to_show (Optional[int]) : Le nombre maximal de runs à afficher sur le graphique.
max_bars_to_show (Optional[int]) : Le nombre maximal de barres à afficher sur le graphique en barres.
custom_expressions (Optional[LList[str]]) : Une liste d’expressions personnalisées à utiliser dans le graphique en barres.
legend_template (Optional[str]) : Le modèle de la légende.
font_size ( Optional[FontSize]) : La taille de police du graphique en courbes. Les options incluent “small”, “medium”, “large”, “auto” ou None.
line_titles (Optional[dict]) : Les titres des lignes. Les clés correspondent aux noms des lignes et les valeurs aux titres.
line_colors (Optional[dict]) : Les couleurs des lignes. Les clés correspondent aux noms des lignes et les valeurs aux couleurs.
aggregate (Optional[bool]) : Si défini sur True, les données sont agrégées.

`class` `BlockQuote`

Un bloc de citation. Attributs :

text (str): Le texte du bloc de citation.

`class` `CalloutBlock`

Un bloc de texte d’encadré. Attributs :

text (str): Le texte d’encadré.

`class` `CheckedList`

Une liste d’éléments avec cases à cocher. Ajoutez un ou plusieurs CheckedListItem à CheckedList. Attributs :

items (LList[CheckedListItem]) : une liste d’un ou plusieurs objets CheckedListItem.

`class` `CheckedListItem`

Un élément de liste avec une case à cocher. Ajoutez un ou plusieurs CheckedListItem à CheckedList. Attributs :

text (str): Le texte de l’élément de liste.
checked (bool): Indique si la case à cocher est cochée. Par défaut, la valeur est False.

`class` `CodeBlock`

Un bloc de code. Attributs :

code (str): Le code contenu dans le bloc.
language (Optional[Language]): Le langage du code. Le langage indiqué est utilisé pour la coloration syntaxique. Par défaut, il est défini sur “python”. Les options incluent ‘javascript’, ‘python’, ‘css’, ‘json’, ‘html’, ‘markdown’, ‘yaml’.

`class` `CodeComparer`

Un objet de panneau qui compare le code entre deux runs distincts. Attributs :

diff (Literal[‘split’, ‘unified’]) : Définit comment afficher les différences de code. Les options disponibles sont “split” et “unified”.

`class` `Config`

Métriques enregistrées dans l’objet de configuration d’un run. Les objets de configuration sont généralement enregistrés à l’aide de 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 à sa valeur. Attributs :

name (str): Le nom de la métrique.

`class` `CustomChart`

Un panneau affichant 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é est le nom du champ et la valeur est la requête.
chart_name (str): Le titre du graphique personnalisé.
chart_fields (dict): Paires clé-valeur qui définissent les axes du graphique, où la clé correspond au libellé et la valeur à la métrique.
chart_strings (dict): Paires clé-valeur qui définissent les chaînes du graphique.

`méthode de classe` `from_table`

from_table(
    table_name: str,
    chart_fields: dict = None,
    chart_strings: dict = None
)

Créer 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.

`class` `Gallery`

Un bloc qui affiche une galerie de rapports et d’URL. Attributs :

items (List[Union[GalleryReport, GalleryURL]]): Une liste d’objets GalleryReport et GalleryURL.

`class` `GalleryReport`

Une référence à un rapport de la galerie. Attributs :

report_id (str): L’ID du rapport.

`class` `GalleryURL`

URL d’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.

`class` `GradientPoint`

Un point d’un gradient. Attributs :

color : La couleur du point.
offset : La position du point dans le gradient. La valeur doit être comprise entre 0 et 100.

`class` `H1`

Un titre H1 avec le texte spécifié. Attributs :

text (str): Le texte du titre.
collapsed_blocks (Optional[LList[“BlockTypes”]]): Les blocs à afficher lorsque le titre est replié.

`class` `H2`

Un titre H2 avec 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é.

`class` `H3`

Un titre H3 dont le texte est spécifié. Attributs :

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

`class` `Heading`

`class` `HorizontalRule`

Trait horizontal HTML.

`class` `Image`

Un bloc qui affiche une image. Attributs :

url (str): L’URL de l’image.
caption (str): La légende de l’image. Elle apparaît sous l’image.

`class` `InlineCode`

Code en ligne. N’ajoute pas de saut de ligne après le code. Attributs :

text (str): Le code que vous souhaitez faire apparaître dans le rapport.

`class` `InlineLatex`

Markdown LaTeX en ligne. N’ajoute pas de retour à la ligne après le markdown LaTeX. Attributs :

text (str): Le markdown LaTeX que vous souhaitez voir apparaître dans Reports.

`class` `LatexBlock`

Un bloc de texte en LaTeX. Attributs :

text (str): Le texte en LaTeX.

`class` `Layout`

La mise en page d’un panneau dans un rapport. Ajuste la taille et la position du panneau. Attributs :

x (int): La position x du panneau.
y (int): La position y du panneau.
w (int): La largeur du panneau.
h (int): La hauteur du panneau.

`class` `LinePlot`

Un objet de panneau avec des graphiques en courbes 2D. Attributs :

title (Optional[str]): Le texte qui apparaît en haut du graphique.
x (Optional[MetricType]): Le nom d’une métrique enregistrée dans votre projet W&B, à partir de laquelle le rapport extrait des informations. La métrique spécifiée est utilisée pour l’axe des x.
y (LList[MetricType]): Une ou plusieurs métriques enregistrées dans votre projet W&B, à partir desquelles le rapport extrait des informations. La métrique spécifiée est utilisée pour l’axe des y.
range_x (Tuple[float | None, float | None]): Tuple qui spécifie la plage de l’axe des x.
range_y (Tuple[float | None, float | None]): Tuple qui spécifie la plage de l’axe des y.
log_x (Optional[bool]): Représente les coordonnées x sur une échelle logarithmique en base 10.
log_y (Optional[bool]): Représente les coordonnées y sur une échelle logarithmique en base 10.
title_x (Optional[str]): Le libellé de l’axe des x.
title_y (Optional[str]): Le libellé de l’axe des y.
ignore_outliers (Optional[bool]): Si défini sur True, n’affiche pas les valeurs aberrantes.
groupby (Optional[str]): Regroupe les runs en fonction d’une métrique enregistrée dans votre projet W&B, à partir de laquelle le rapport extrait des informations.
groupby_aggfunc (Optional[GroupAgg]): Agrège les runs avec la fonction spécifiée. Les options incluent “mean”, “min”, “max”, “median”, “sum”, “samples” ou None.
groupby_rangefunc (Optional[GroupArea]): Regroupe les runs selon une plage. Les options incluent “minmax”, “stddev”, “stderr”, “none”, “samples” ou None.
smoothing_factor (Optional[float]): Le facteur de lissage à appliquer au type de lissage. Les valeurs acceptées vont de 0 à 1.
smoothing_type Optional[SmoothingType]: Applique un filtre selon la distribution spécifiée. Les options incluent “exponentialTimeWeighted”, “exponential”, “gaussian”, “average” ou “none”.
smoothing_show_original (Optional[bool]): Si défini sur True, affiche les données d’origine.
max_runs_to_show (Optional[int]): Le nombre maximal de runs à afficher sur le graphique en courbes.
custom_expressions (Optional[LList[str]]): Expressions personnalisées à appliquer aux données.
plot_type Optional[LinePlotStyle]: Le type de graphique en courbes à générer. Les options incluent “line”, “stacked-area” ou “pct-area”.
font_size Optional[FontSize]: La taille de police du graphique en courbes. Les options incluent “small”, “medium”, “large”, “auto” ou None.
legend_position Optional[LegendPosition]: L’emplacement de la légende. Les options incluent “north”, “south”, “east”, “west” ou None.
legend_template (Optional[str]): Le modèle de la légende.
aggregate (Optional[bool]): Si défini sur True, agrège les données.
xaxis_expression (Optional[str]): L’expression pour l’axe des x.
xaxis_format (Optional[str]): Le format de l’axe des x. Cette option apparaît si vous définissez une métrique personnalisée. Par exemple, vous pouvez spécifier ‘datetime’ pour formater l’axe des x comme une date et une heure.
legend_fields (Optional[LList[str]]): Les champs à inclure dans la légende.
metric_regex (Optional[str]): Motif d’expression régulière pour faire correspondre les métriques de l’axe des y. Le backend utilisera 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’il y en a trop à afficher. Les options incluent “bucketing-gorilla” (regroupe les points de données dans des buckets et affiche les valeurs min, max et avg par bucket afin de préserver les valeurs aberrantes et les pics) ou “sampling” (échantillonne aléatoirement les points pour un rendu plus rapide, mais peut manquer certaines valeurs aberrantes).

`class` `Link`

Un lien vers une URL. Attributs :

text (Union[str, TextWithInlineComments]) : Le texte du lien.
url (str) : L’URL vers laquelle renvoie le lien.

`class` `MarkdownBlock`

Un bloc de texte au format Markdown. Utile si vous souhaitez écrire du texte utilisant la syntaxe Markdown courante. Attributs :

text (str): Le texte au format Markdown.

`class` `MarkdownPanel`

Un panneau qui affiche du markdown. Attributs :

markdown (str): Le texte à afficher dans le panneau markdown.

`class` `MediaBrowser`

Un 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 sera 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.

`class` `Metric`

Une métrique à afficher dans les rapports, enregistrée dans votre projet. Attributs :

name (str): Le nom de la métrique.

`class` `OrderBy`

Une métrique servant de critère de tri. Attributs :

name (str): Le nom de la métrique.
ascending (bool): Indique si le tri doit s’effectuer par ordre croissant. Par défaut, la valeur est False.

`class` `OrderedList`

Une liste d’éléments présentés dans une liste numérotée. Attributs :

items (LList[TextLikeField]) : Une liste d’un ou plusieurs objets OrderedListItem. Chaque élément peut être une chaîne ou une liste d’objets TextLike.

`class` `OrderedListItem`

Un élément d’une liste ordonnée. Attributs :

text (str): Le texte de l’élément de liste.

`class` `P`

Un paragraphe de texte. Attributs :

text (str) : Le texte du paragraphe.

`class` `Panel`

Panneau qui affiche une visualisation dans une grille de panneaux. Attributs :

layout (Mise en page) : Un objet Layout.

`class` `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 incluent : LinePlot, ScatterPlot, BarPlot, ScalarChart, CodeComparer, ParallelCoordinatesPlot, ParameterImportancePlot, RunComparer, MediaBrowser, MarkdownPanel, CustomChart, WeavePanel, WeavePanelSummaryTable, WeavePanelArtifactVersionedFile. Attributs :

runsets (LList[“Runset”]): Une liste d’un ou plusieurs objets Runset.
hide_run_sets (bool): Indique s’il faut masquer les ensembles de runs de la grille de panneaux pour les lecteurs du rapport.
panels (LList[“PanelTypes”]): Une liste d’un ou plusieurs objets Panel.
active_runset (Optional[int]): L’index de l’onglet du runset actif. Par défaut, il est défini sur 0.
custom_run_colors (dict): Paires clé-valeur où la clé est le nom d’un run et la valeur une couleur spécifiée sous forme de valeur hexadécimale.

`class` `ParallelCoordinatesPlot`

Objet de panneau affichant un graphique en coordonnées parallèles. Attributs :

columns (LList[ParallelCoordinatesPlotColumn]) : Une liste d’un ou de plusieurs objets ParallelCoordinatesPlotColumn.
title (Optional[str]) : Le texte affiché en haut du graphique.
gradient (Optional[LList[GradientPoint]]) : Une liste de points du gradient.
font_size (Optional[FontSize]) : La taille de police du graphique en courbes. Les options incluent “small”, “medium”, “large”, “auto” ou None.

`class` `ParallelCoordinatesPlotColumn`

Une colonne dans un graphique en coordonnées parallèles. L’ordre des metrics spécifiées détermine l’ordre des axes parallèles (axe des x) dans le graphique en coordonnées parallèles. Attributs :

metric (str | Config | SummaryMetric) : Le nom de la métrique enregistrée dans votre projet W&B dont le Report extrait les informations.
display_name (Optional[str]) : Le nom de la métrique
inverted (Optional[bool]) : Indique s’il faut inverser la métrique.
log (Optional[bool]) : Indique s’il faut appliquer une transformation logarithmique à la métrique.

`class` `ParameterImportancePlot`

Un panneau affichant 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 comparer l’importance des hyperparamètres. Les métriques courantes peuvent inclure la perte, la précision, etc. La métrique que vous spécifiez doit être enregistrée dans le projet à partir duquel le Report extrait les informations.

`class` `Report`

Objet représentant un rapport W&B. Utilisez l’attribut blocks de l’objet renvoyé pour personnaliser votre rapport. Les objets rapport ne sont pas enregistrés automatiquement. Utilisez la méthode save() pour enregistrer les modifications. Attributs :

project (str): Le nom du projet W&B que vous souhaitez charger. Le projet spécifié apparaît dans l’URL du rapport.
entity (str): L’entité W&B à laquelle appartient le rapport. L’entité apparaît dans l’URL du rapport.
title (str): Le titre du rapport. Le titre apparaît en haut du rapport sous forme d’en-tête H1.
description (str): Une description du rapport. La description apparaît 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. Les options incluent ‘readable’, ‘fixed’ et ‘fluid’.

`propriété` url

L’URL où 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’entité à laquelle appartient le rapport et au nom du projet.

`méthode` `delete`

delete() → bool

Supprimez ce rapport de W&B. Cela supprimera également toutes les vues de brouillon qui font référence à ce rapport. Retourne :

bool : True si l’opération de suppression a été confirmée comme réussie par le backend, False sinon.

`méthode` `disable_share_link`

disable_share_link() → bool

Désactive le lien de partage « toute personne disposant du lien peut voir » pour ce rapport. Révoque tous les jetons d’accès public actifs pour le rapport. Retourne :

bool: True si le ou les liens ont été révoqués, False si aucun lien actif n’existait.

`méthode` `enable_share_link`

enable_share_link() → str

Active le partage “toute personne disposant du lien peut voir” pour ce rapport. Crée un token d’accès public pour le rapport. Si un lien de partage existe déjà, renvoie le lien existant. Retourne :

str: L’URL du lien magique à partager.

`méthode de classe` `from_url`

from_url(url: str, as_model: bool = False)

Chargez le rapport dans l’environnement actuel. Fournissez l’URL où le rapport est hébergé. Arguments :

url (str): L’URL où le rapport est hébergé.
as_model (bool): Si True, renvoie l’objet modèle plutôt que l’objet rapport. Par défaut, la valeur est False.

`méthode` `get_share_url`

get_share_url() → Optional[str]

Récupère l’URL du lien magique pour ce rapport, ou None si le partage n’est pas activé. Effectue un appel réseau pour vérifier les tokens d’accès actifs. Renvoie l’URL du rapport avec un token d’accès ajouté, permettant à toute personne disposant du lien de consulter le rapport même si le projet est privé.

`méthode` `save`

save(draft: bool = False, clone: bool = False)

Enregistre les modifications apportées à un objet rapport.

`méthode` `to_html`

to_html(height: int = 1024, hidden: bool = False) → str

Génère le HTML contenant une iframe qui affiche ce rapport. Généralement utilisé dans un Python notebook. Arguments :

height (int): Hauteur de l’iframe.
hidden (bool): Si True, masque l’iframe. La valeur par défaut est False.

`class` `RunComparer`

Panneau qui compare les métriques entre différents runs du projet dont le rapport extrait les 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 Reports de W&B.

`class` `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 chaîne RGB (“rgb(255,0,0)”).
disabled : Si True, masque le run dans les graphiques. Cela équivaut à cliquer sur l’icône en forme d’œil fermé dans l’UI.

`class` `Runset`

Un ensemble de runs à afficher dans une grille de panneaux. Attributs :

entity (str): Une entité qui possède le projet dans lequel les runs sont stockés, ou qui dispose des autorisations appropriées sur ce projet.
project (str): Le nom du projet où les runs sont stockés.
name (str): Le nom de l’ensemble de runs. La valeur par défaut est Run set.
query (str): Une chaîne de requête pour filtrer les runs.
filters (Union[str, LList[expr.FilterExpr]]): Filtres à appliquer aux runs. Peut être :
- Une expression sous forme de chaîne : par exemple, “Config(‘lr’) = 0.001 and State = ‘finished’”
Opérateurs pris en charge: =, ==, !=, <, >, <=, >=, in, not in
- Une liste d’objets FilterExpr : par exemple, [expr.Config(‘lr’) == 0.001]
groupby (LList[str]): Une liste de noms de métriques à utiliser pour le regroupement. Les formats pris en charge sont :
- “group” ou “run.group” pour regrouper par attribut de run
- “config.param” pour regrouper par paramètre de configuration
- “summary.metric” pour regrouper par métrique de résumé
order (LList[OrderBy]): Une liste d’objets OrderBy à utiliser pour le tri.
custom_run_colors (dict): Un dictionnaire qui associe les ID de run (ou les clés RunsetGroup pour les runs groupés) à des couleurs. Pour des couleurs simples par run, préférez utiliser run_settings.
run_settings (Dict[str, RunSettings]): Paramètres d’affichage par run, indexés par ID de run. Utilisez-le pour définir des couleurs et/ou masquer des runs individuels. Voir RunSettings.

Exemple :

    # Utilisation de filtres sous forme de chaîne
    wr.Runset(
         entity="my-entity",
         project="my-project",
         filters="Config('learning_rate') = 0.001 and State = 'finished'"
    )

    # Utilisation d'une liste FilterExpr
    wr.Runset(
         entity="my-entity",
         project="my-project",
         filters=[expr.Config("learning_rate") == 0.001]
    )

`méthode` `convert_filterexpr_list_to_string`

convert_filterexpr_list_to_string()

Convertit une liste de FilterExpr en expression de chaîne pour le traitement interne.

`méthode` `merge_custom_run_colors_into_run_settings`

merge_custom_run_colors_into_run_settings()

Fusionnez les custom_run_colors utilisant des clés de chaîne simples dans run_settings pour assurer la rétrocompatibilité.

`class` `RunsetGroup`

Élément d’interface utilisateur qui affiche un groupe de runsets. Attributs :

runset_name (str): Le nom du runset.
keys (Tuple[RunsetGroupKey, …]): Les clés selon lesquelles effectuer le regroupement. Passez un ou plusieurs objets RunsetGroupKey pour regrouper.

`class` `RunsetGroupKey`

Regroupe les runsets par type et valeur de métrique. Fait partie d’un RunsetGroup. Spécifiez le type et la valeur de métrique à utiliser pour le regroupement sous forme de paires clé-valeur. Attributs :

key (Type[str] | Type[Config] | Type[SummaryMetric] | Type[Metric]): Le type de métrique à utiliser pour le regroupement.
value (str): La valeur de la métrique à utiliser pour le regroupement.

`class` `ScalarChart`

Un objet de panneau qui affiche un graphique scalaire. Attributs :

title (Optional[str]) : Le texte qui apparaît en haut du graphique.
metric (MetricType) : Le nom d’une métrique enregistrée dans votre projet W&B, à partir de laquelle le rapport extrait des informations.
groupby_aggfunc (Optional[GroupAgg]) : Agrège les runs à l’aide de la fonction spécifiée. Les options incluent “mean”, “min”, “max”, “median”, “sum”, “samples” ou None.
groupby_rangefunc (Optional[GroupArea]) : Regroupe les runs en fonction d’une plage. Les options incluent “minmax”, “stddev”, “stderr”, “none”, “samples” ou None.
custom_expressions (Optional[LList[str]]) : Une liste d’expressions personnalisées à utiliser dans le graphique scalaire.
legend_template (Optional[str]) : Le modèle utilisé pour la légende.
font_size Optional[FontSize] : La taille de police du graphique en courbes. Les options incluent “small”, “medium”, “large”, “auto” ou None.

`class` `ScatterPlot`

Objet de panneau qui affiche un nuage de points en 2D ou 3D. Arguments :

title (Optional[str]) : Le texte affiché en haut du graphique.
x Optional[SummaryOrConfigOnlyMetric] : Le nom d’une métrique enregistrée dans votre projet W&B à partir de laquelle le report extrait des informations. La métrique spécifiée est utilisée pour l’axe x.
y Optional[SummaryOrConfigOnlyMetric] : Une ou plusieurs métriques enregistrées dans votre projet W&B à partir desquelles le report extrait des informations. Les métriques spécifiées sont tracées sur l’axe y. z Optional[SummaryOrConfigOnlyMetric] :
range_x (Tuple[float | None, float | None]) : Tuple qui spécifie la plage de l’axe x.
range_y (Tuple[float | None, float | None]) : Tuple qui spécifie la plage de l’axe y.
range_z (Tuple[float | None, float | None]) : Tuple qui spécifie la plage de l’axe z.
log_x (Optional[bool]) : Trace les coordonnées x à l’aide d’une échelle logarithmique en base 10.
log_y (Optional[bool]) : Trace les coordonnées y à l’aide d’une échelle logarithmique en base 10.
log_z (Optional[bool]) : Trace les coordonnées z à l’aide d’une échelle logarithmique en base 10.
running_ymin (Optional[bool]) : Applique une moyenne mobile.
running_ymax (Optional[bool]) : Applique une moyenne mobile.
running_ymean (Optional[bool]) : Applique une moyenne mobile.
legend_template (Optional[str]) : Chaîne qui spécifie le format de la légende.
gradient (Optional[LList[GradientPoint]]) : Liste de points de gradient qui spécifie le dégradé de couleurs du graphique.
font_size (Optional[FontSize]) : La taille de police du graphique en courbes. Les options incluent “small”, “medium”, “large”, “auto” ou None.
regression (Optional[bool]) : Si True, une droite de régression est tracée sur le nuage de points.

`class` `SoundCloud`

Un bloc qui affiche un lecteur SoundCloud. Attributs :

html (str): Le code HTML permettant d’intégrer le lecteur SoundCloud.

`class` `Spotify`

Un bloc qui affiche un lecteur Spotify. Attributs :

spotify_id (str): L’ID Spotify du morceau ou de la playlist.

`class` `SummaryMetric`

Une métrique de synthèse à afficher dans un rapport. Attributs :

name (str): Le nom de la métrique.

`class` `TableOfContents`

Bloc contenant une liste de sections et de sous-sections à l’aide de blocs HTML de niveaux H1, H2 et H3 définis dans un rapport.

`class` `TextWithInlineComments`

Un bloc de texte avec des commentaires intégrés. Attributs :

text (str): Texte du bloc.

`class` `Twitter`

Bloc qui affiche un fil Twitter. Attributs :

html (str): Le code HTML permettant d’afficher le fil Twitter.

`class` `UnorderedList`

Une liste d’éléments présentés sous forme de liste à puces. Attributs :

items (LList[TextLikeField]): Une liste d’un ou de plusieurs objets UnorderedListItem. Chaque élément peut être une chaîne ou une liste d’objets TextLike.

`class` `UnorderedListItem`

Élément d’une liste non ordonnée. Attributs :

text (str): Texte de l’élément de liste.

`class` `Video`

Un bloc qui affiche une vidéo. Attributs :

url (str): L’URL de la vidéo.

`class` `WeaveBlockArtifact`

Bloc qui affiche un artifact enregistré dans W&B. La requête prend la forme de

project('entity', 'project').artifact('artifact-name')

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 suivre et évaluer les LLM. Attributs :

entity (str): L’entité propriétaire du projet, ou disposant des autorisations appropriées sur celui-ci, où l’artifact est stocké.
project (str): Le projet où 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.

`class` `WeaveBlockArtifactVersionedFile`

Bloc qui affiche un fichier versionné enregistré dans un artifact W&B. La requête se présente sous la forme suivante :

project('entity', 'project').artifactVersion('name', 'version').file('file-name')

Le terme “Weave” dans le nom de l’API ne fait pas référence à la boîte à outils W&B Weave utilisé pour le suivi et l’évaluation des LLM. Attributs :

entity (str): L’entité propriétaire du projet, ou celle qui dispose des autorisations appropriées sur le projet où l’artifact est stocké.
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 stocké dans l’artifact à récupérer.

`class` `WeaveBlockSummaryTable`

Bloc qui affiche un tableau W&B, un dataframe pandas, un graphique ou une autre valeur enregistrée dans W&B. La requête se présente sous la forme suivante :

project('entity', 'project').runs.summary['value']

Le terme “Weave” dans le nom de l’API ne désigne pas la boîte à outils W&B Weave utilisé pour le suivi et l’évaluation des LLM. Attributs :

entity (str): L’entité qui possède le projet, ou qui dispose des autorisations appropriées sur le projet dans lequel les valeurs sont enregistrées.
project (str): Le projet dans lequel la valeur est enregistrée.
table_name (str): Le nom du tableau, de la dataframe, du graphique ou de la valeur.

`class` `WeavePanel`

Un panneau de requête vide qui peut être utilisé pour 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é pour le suivi et l’évaluation des LLM.

`class` `WeavePanelArtifact`

Un panneau qui affiche un artifact enregistré 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.

`class` `WeavePanelArtifactVersionedFile`

Panneau affichant un fichier versionné enregistré dans un artifact W&B.

project('entity', 'project').artifactVersion('name', 'version').file('file-name')

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 suivre et évaluer les 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 stocké dans l’artifact à récupérer.

`class` `WeavePanelSummaryTable`

Panneau affichant un tableau W&B, un dataframe pandas, un graphique ou toute autre valeur enregistrée dans W&B. La requête prend la forme de

runs.summary['value']

Le terme “Weave” dans le nom de l’API ne fait pas référence au boîte à outils W&B Weave utilisé 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, y compris sa position et sa taille. Hérité de la classe de base Panel. À utiliser pour ajuster la largeur (w) et la hauteur (h).

Exemple : Créez un Report avec un panneau de tableau récapitulatif qui affiche un tableau avec des dimensions personnalisées :

    import wandb_workspaces.reports as wr

    report = wr.Report(
         project="my-project",
         entity="my-entity",
         title="Summary Table Report"
    )

    report.blocks = [
         wr.PanelGrid(
             runsets=[wr.Runset(project="my-project")],
             panels=[
                 wr.WeavePanelSummaryTable(
                     table_name="my-table-name",
                     layout=wr.Layout(w=24, h=20)
                 )
             ]
         )
    ]

    report.save()

Les paramètres de mise en page contrôlent 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)

Guides

Intégrations

Référence

​class BarPlot

​class BlockQuote

​class CalloutBlock

​class CheckedList

​class CheckedListItem

​class CodeBlock

​class CodeComparer

​class Config

​class CustomChart

​méthode de classe from_table

​class Gallery

​class GalleryReport

​class GalleryURL

​class GradientPoint

​class H1

​class H2

​class H3

​class Heading

​class HorizontalRule

​class Image

​class InlineCode

​class InlineLatex

​class LatexBlock

​class Layout

​class LinePlot

​class Link

​class MarkdownBlock

​class MarkdownPanel

​class MediaBrowser

​class Metric

​class OrderBy

​class OrderedList

​class OrderedListItem

​class P

​class Panel

​class PanelGrid

​class ParallelCoordinatesPlot

​class ParallelCoordinatesPlotColumn

​class ParameterImportancePlot

​class Report

​propriété url

​méthode delete

​méthode disable_share_link

​méthode enable_share_link

​méthode de classe from_url

​méthode get_share_url

​méthode save

​méthode to_html

​class RunComparer

​class RunSettings

​class Runset

​méthode convert_filterexpr_list_to_string

​méthode merge_custom_run_colors_into_run_settings

​class RunsetGroup

​class RunsetGroupKey

​class ScalarChart

​class ScatterPlot

​class SoundCloud

​class Spotify

​class SummaryMetric

​class TableOfContents

​class TextWithInlineComments

​class Twitter

​class UnorderedList

​class UnorderedListItem

​class Video

​class WeaveBlockArtifact

​class WeaveBlockArtifactVersionedFile

​class WeaveBlockSummaryTable

​class WeavePanel

​class WeavePanelArtifact

​class WeavePanelArtifactVersionedFile

​class WeavePanelSummaryTable

`class` `BarPlot`

`class` `BlockQuote`

`class` `CalloutBlock`

`class` `CheckedList`

`class` `CheckedListItem`

`class` `CodeBlock`

`class` `CodeComparer`

`class` `Config`

`class` `CustomChart`

`méthode de classe` `from_table`

`class` `Gallery`

`class` `GalleryReport`

`class` `GalleryURL`

`class` `GradientPoint`

`class` `H1`

`class` `H2`

`class` `H3`

`class` `Heading`

`class` `HorizontalRule`

`class` `Image`

`class` `InlineCode`

`class` `InlineLatex`

`class` `LatexBlock`

`class` `Layout`

`class` `LinePlot`

`class` `Link`

`class` `MarkdownBlock`

`class` `MarkdownPanel`

`class` `MediaBrowser`

`class` `Metric`

`class` `OrderBy`

`class` `OrderedList`

`class` `OrderedListItem`

`class` `P`

`class` `Panel`

`class` `PanelGrid`

`class` `ParallelCoordinatesPlot`

`class` `ParallelCoordinatesPlotColumn`

`class` `ParameterImportancePlot`

`class` `Report`

`propriété` url

`méthode` `delete`

`méthode` `disable_share_link`

`méthode` `enable_share_link`

`méthode de classe` `from_url`

`méthode` `get_share_url`

`méthode` `save`

`méthode` `to_html`

`class` `RunComparer`

`class` `RunSettings`

`class` `Runset`

`méthode` `convert_filterexpr_list_to_string`

`méthode` `merge_custom_run_colors_into_run_settings`

`class` `RunsetGroup`

`class` `RunsetGroupKey`

`class` `ScalarChart`

`class` `ScatterPlot`

`class` `SoundCloud`

`class` `Spotify`

`class` `SummaryMetric`

`class` `TableOfContents`

`class` `TextWithInlineComments`

`class` `Twitter`

`class` `UnorderedList`

`class` `UnorderedListItem`

`class` `Video`

`class` `WeaveBlockArtifact`

`class` `WeaveBlockArtifactVersionedFile`

`class` `WeaveBlockSummaryTable`

`class` `WeavePanel`

`class` `WeavePanelArtifact`

`class` `WeavePanelArtifactVersionedFile`

`class` `WeavePanelSummaryTable`