> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coreweave.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Reports

export const GitHubLink = ({url, compact = false}) => <a href={url} target="_blank" rel="noopener noreferrer" className={compact ? "source-link" : "github-source-link"}>
    {compact ? "View source" : <>
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub source
      </>}
  </a>;

<GitHubLink url="https://github.com/wandb/wandb-workspaces/blob/main/wandb_workspaces/reports/v2/internal.py" />

<Note>
  L’API Report and Workspace de W\&B est en préversion publique.
</Note>

Bibliothèque Python permettant d’utiliser l’API W\&B Reports de manière programmatique.

```python theme={"system"}
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()
```

<h2 id="class-barplot">
  <kbd>classe</kbd> `BarPlot`
</h2>

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.

***

<h2 id="class-blockquote">
  <kbd>classe</kbd> `BlockQuote`
</h2>

Un bloc de texte cité.

**Attributs :**

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

***

<h2 id="class-calloutblock">
  <kbd>classe</kbd> `CalloutBlock`
</h2>

Un bloc de texte d’encadré.

**Attributs :**

* `text` (str) :  Le texte de l’encadré.

***

<h2 id="class-checkedlist">
  <kbd>classe</kbd> `CheckedList`
</h2>

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`.

***

<h2 id="class-checkedlistitem">
  <kbd>classe</kbd> `CheckedListItem`
</h2>

É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`.

***

<h2 id="class-codeblock">
  <kbd>classe</kbd> `CodeBlock`
</h2>

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'.

***

<h2 id="class-codecomparer">
  <kbd>classe</kbd> `CodeComparer`
</h2>

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 ».

***

<h2 id="class-config">
  <kbd>classe</kbd> `Config`
</h2>

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.

***

<h2 id="class-customchart">
  <kbd>classe</kbd> `CustomChart`
</h2>

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.

***

<h3 id="classmethod-from_table">
  <kbd>classmethod</kbd> `from_table`
</h3>

```python theme={"system"}
from_table(
    table_name: str,
    chart_fields: dict = None,
    chart_strings: dict = None
)
```

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.

***

<h2 id="class-gallery">
  <kbd>classe</kbd> `Gallery`
</h2>

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

**Attributs :**

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

***

<h2 id="class-galleryreport">
  <kbd>classe</kbd> `GalleryReport`
</h2>

Référence à un rapport de la galerie.

**Attributs :**

* `report_id` (str) :  ID du rapport.

***

<h2 id="class-galleryurl">
  <kbd>classe</kbd> `GalleryURL`
</h2>

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.

***

<h2 id="class-gradientpoint">
  <kbd>classe</kbd> `GradientPoint`
</h2>

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.

***

<h2 id="class-h1">
  <kbd>classe</kbd> `H1`
</h2>

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

***

<h2 id="class-h2">
  <kbd>classe</kbd> `H2`
</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é.

***

<h2 id="class-h3">
  <kbd>classe</kbd> `H3`
</h2>

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

***

<h2 id="class-heading">
  <kbd>classe</kbd> `Heading`
</h2>

***

<h2 id="class-horizontalrule">
  <kbd>classe</kbd> `HorizontalRule`
</h2>

Ligne horizontale HTML.

***

<h2 id="class-image">
  <kbd>classe</kbd> `Image`
</h2>

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.

***

<h2 id="class-inlinecode">
  <kbd>classe</kbd> `InlineCode`
</h2>

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

**Attributs :**

* `text` (str) :  Le code à afficher dans le rapport.

***

<h2 id="class-inlinelatex">
  <kbd>classe</kbd> `InlineLatex`
</h2>

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.

***

<h2 id="class-latexblock">
  <kbd>classe</kbd> `LatexBlock`
</h2>

Un bloc de texte LaTeX.

**Attributs :**

* `text` (str) :  Le texte LaTeX.

***

<h2 id="class-layout">
  <kbd>classe</kbd> `Layout`
</h2>

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.

***

<h2 id="class-lineplot">
  <kbd>classe</kbd> `LinePlot`
</h2>

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 "{runId}:{metricName}".
* `line_colors` (Optional\[Dict\[str, Any]]) : couleurs par série. Les clés sont au format "{runId}:{metricName}".
* `line_widths` (Optional\[Dict\[str, float]]) : Épaisseurs de ligne par série. Les clés sont au format "{runId}:{metricName}".
* `line_marks` (Optional\[Dict\[str, Mark]]) : styles de tirets par série. Les clés sont au format "{runId}:{metricName}".
* `Valid values` :  "solid", "dashed", "dotted", "dotdash", "dotdotdash", "points".

***

<h2 id="class-link">
  <kbd>classe</kbd> `Link`
</h2>

Un lien vers une URL.

**Attributs :**

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

***

<h2 id="class-markdownblock">
  <kbd>classe</kbd> `MarkdownBlock`
</h2>

Un bloc de texte Markdown. Utile pour rédiger du texte avec la syntaxe Markdown courante.

**Attributs :**

* `text` (str) :  Le texte Markdown.

***

<h2 id="class-markdownpanel">
  <kbd>classe</kbd> `MarkdownPanel`
</h2>

Un panneau qui affiche du contenu Markdown.

**Attributs :**

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

***

<h2 id="class-mediabrowser">
  <kbd>classe</kbd> `MediaBrowser`
</h2>

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.

***

<h2 id="class-metric">
  <kbd>classe</kbd> `Metric`
</h2>

Une métrique journalisée dans votre projet, à afficher dans un rapport.

**Attributs :**

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

***

<h2 id="class-orderby">
  <kbd>classe</kbd> `OrderBy`
</h2>

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`.

***

<h2 id="class-orderedlist">
  <kbd>classe</kbd> `OrderedList`
</h2>

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.

***

<h2 id="class-orderedlistitem">
  <kbd>classe</kbd> `OrderedListItem`
</h2>

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

**Attributs :**

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

***

<h2 id="class-p">
  <kbd>classe</kbd> `P`
</h2>

Un paragraphe de texte.

**Attributs :**

* `text` (str) :  Le texte du paragraphe.

***

<h2 id="class-panel">
  <kbd>classe</kbd> `Panel`
</h2>

Panneau qui affiche une visualisation dans une grille de panneaux.

**Attributs :**

* `layout` (Layout) : un objet `Layout`.

***

<h2 id="class-panelgrid">
  <kbd>classe</kbd> `PanelGrid`
</h2>

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.

***

<h2 id="class-parallelcoordinatesplot">
  <kbd>classe</kbd> `ParallelCoordinatesPlot`
</h2>

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`.

***

<h2 id="class-parallelcoordinatesplotcolumn">
  <kbd>classe</kbd> `ParallelCoordinatesPlotColumn`
</h2>

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.

***

<h2 id="class-parameterimportanceplot">
  <kbd>classe</kbd> `ParameterImportancePlot`
</h2>

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.

***

<h2 id="class-report">
  <kbd>classe</kbd> `Report`
</h2>

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'.

***

<h3 id="property-url">
  <kbd>property</kbd> url
</h3>

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.

***

<h3 id="method-delete">
  <kbd>méthode</kbd> `delete`
</h3>

```python theme={"system"}
delete() → bool
```

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.

***

<h3 id="method-disable_share_link">
  <kbd>méthode</kbd> `disable_share_link`
</h3>

```python theme={"system"}
disable_share_link() → bool
```

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.

***

<h3 id="method-enable_share_link">
  <kbd>méthode</kbd> `enable_share_link`
</h3>

```python theme={"system"}
enable_share_link() → str
```

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.

***

<h3 id="classmethod-from_url">
  <kbd>classmethod</kbd> `from_url`
</h3>

```python theme={"system"}
from_url(url: str, as_model: bool = False)
```

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.

***

<h3 id="method-get_share_url">
  <kbd>méthode</kbd> `get_share_url`
</h3>

```python theme={"system"}
get_share_url() → Optional[str]
```

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

***

<h3 id="method-save">
  <kbd>méthode</kbd> `save`
</h3>

```python theme={"system"}
save(draft: bool = False, clone: bool = False)
```

Enregistre les modifications apportées à un objet rapport.

***

<h3 id="method-to_html">
  <kbd>méthode</kbd> `to_html`
</h3>

```python theme={"system"}
to_html(height: int = 1024, hidden: bool = False) → str
```

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`.

***

<h2 id="class-runcomparer">
  <kbd>classe</kbd> `RunComparer`
</h2>

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.

***

<h2 id="class-runsettings">
  <kbd>classe</kbd> `RunSettings`
</h2>

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.

***

<h2 id="class-runset">
  <kbd>classe</kbd> `Runset`
</h2>

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 :**

```python theme={"system"}
    # Avec des filtres sous forme de chaîne
    wr.Runset(
         entity="my-entity",
         project="my-project",
         filters="Config('learning_rate') = 0.001 and State = 'finished'"
    )

    # Avec une liste de FilterExpr
    wr.Runset(
         entity="my-entity",
         project="my-project",
         filters=[expr.Config("learning_rate") == 0.001]
    )
```

***

<h3 id="method-convert_filterexpr_list_to_string">
  <kbd>méthode</kbd> `convert_filterexpr_list_to_string`
</h3>

```python theme={"system"}
convert_filterexpr_list_to_string()
```

Convertit une liste de FilterExpr en expression de type string.

***

<h3 id="method-merge_custom_run_colors_into_run_settings">
  <kbd>méthode</kbd> `merge_custom_run_colors_into_run_settings`
</h3>

```python theme={"system"}
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é.

***

<h2 id="class-runsetgroup">
  <kbd>classe</kbd> `RunsetGroup`
</h2>

É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.

***

<h2 id="class-runsetgroupkey">
  <kbd>classe</kbd> `RunsetGroupKey`
</h2>

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.

***

<h2 id="class-scalarchart">
  <kbd>classe</kbd> `ScalarChart`
</h2>

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`.

***

<h2 id="class-scatterplot">
  <kbd>classe</kbd> `ScatterPlot`
</h2>

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.

***

<h2 id="class-soundcloud">
  <kbd>classe</kbd> `SoundCloud`
</h2>

Un bloc qui affiche un lecteur SoundCloud.

**Attributs :**

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

***

<h2 id="class-spotify">
  <kbd>classe</kbd> `Spotify`
</h2>

Un bloc qui affiche un lecteur Spotify.

**Attributs :**

* `spotify_id` (str) :  L’identifiant Spotify du titre ou de la playlist.

***

<h2 id="class-summarymetric">
  <kbd>classe</kbd> `SummaryMetric`
</h2>

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

**Attributs :**

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

***

<h2 id="class-tableofcontents">
  <kbd>classe</kbd> `TableOfContents`
</h2>

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

***

<h2 id="class-textwithinlinecomments">
  <kbd>classe</kbd> `TextWithInlineComments`
</h2>

Bloc de texte comportant des commentaires intégrés.

**Attributs :**

* `text` (str) :  Le texte du bloc.

***

<h2 id="class-twitter">
  <kbd>classe</kbd> `Twitter`
</h2>

Bloc qui affiche un fil Twitter.

**Attributs :**

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

***

<h2 id="class-unorderedlist">
  <kbd>classe</kbd> `UnorderedList`
</h2>

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.

***

<h2 id="class-unorderedlistitem">
  <kbd>classe</kbd> `UnorderedListItem`
</h2>

Un élément d’une liste à puces.

**Attributs :**

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

***

<h2 id="class-video">
  <kbd>classe</kbd> `Video`
</h2>

Un bloc qui affiche une vidéo.

**Attributs :**

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

***

<h2 id="class-weaveblockartifact">
  <kbd>classe</kbd> `WeaveBlockArtifact`
</h2>

Bloc qui affiche un artifact consigné dans W\&B. La requête prend la forme suivante :

```python theme={"system"}
project('entity', 'project').artifact('artifact-name')
```

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.

***

<h2 id="class-weaveblockartifactversionedfile">
  <kbd>classe</kbd> `WeaveBlockArtifactVersionedFile`
</h2>

Bloc qui affiche un fichier versionné journalisé dans un artifact W\&B. La requête prend la forme suivante

```python theme={"system"}
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 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.

***

<h2 id="class-weaveblocksummarytable">
  <kbd>classe</kbd> `WeaveBlockSummaryTable`
</h2>

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

```python theme={"system"}
project('entity', 'project').runs.summary['value']
```

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.

***

<h2 id="class-weavepanel">
  <kbd>classe</kbd> `WeavePanel`
</h2>

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.

***

<h2 id="class-weavepanelartifact">
  <kbd>classe</kbd> `WeavePanelArtifact`
</h2>

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.

***

<h2 id="class-weavepanelartifactversionedfile">
  <kbd>classe</kbd> `WeavePanelArtifactVersionedFile`
</h2>

Un panneau qui affiche un fichier versionné journalisé dans un artifact W\&B.

```python theme={"system"}
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 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.

***

<h2 id="class-weavepanelsummarytable">
  <kbd>classe</kbd> `WeavePanelSummaryTable`
</h2>

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

```python theme={"system"}
runs.summary['value']
```

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 :

```python theme={"system"}
    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 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)


## Related topics

- [Reports](/fr/products/wandb/ref/python/public-api/reports.md)