How to design your Dashboard with custom Panels.
RowCount
metric with different aggregations:
sum
, last
, avg
).
RowCount
metric.
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
title | str | ❌ | None | Title of the panel. |
description | str | ❌ | None | Optional panel description shown as a subtitle. |
size | str | ❌ | "full" | Panel size: "full" (100% width) or "half" (50%). |
values | list | ✅ | — | List of PanelMetric objects to display. |
tab | str | ❌ | None | Dashboard tab name. If not set, defaults to the first tab or creates a new “General” tab. |
create_if_not_exists | bool | ❌ | True | If True , creates the tab if it doesn’t exist. Throws exception if False . |
plot_params | dict | ❌ | {} | Panel visualization settings like "plot_type" : "text" , "line" , "counter" . |
PanelMetric
, e.g., "RowCount"
.
Example:
TextEvals
, ClassificationPreset
, DataDriftPreset
) contain multiple sub-metrics. When logging Reports using a Preset, you must reference the specific metric inside it, such as Accuracy
, Recall
, etc.
metric_labels
to specify what exactly you want to plot.
Example. To plot the share of categories inside “Denials” column:
column
label to specify which column or descriptor it refers to.
For example, in a TextEvals
Report, each text descriptor (e.g., text length, LLM judged “denials”, etc.) is treated as a column. These descriptors are summarized with various statistics. To plot one of these values, you need to:
UniqueValueCount
, MissingValueCount
, MaxValue
, etc.column
label to point the specific descriptor.value
. For example, Accuracy
returns the corresponding accuracy value
. So listing just the Metric
name is enough to specify what exactly you want to plot.
However, some metrics produce more than one metric result, like:
CategoryCount
: returns both share
and count
MAE
: returns both mean
and std
value_type
key, e.g. {"value_type": "share"}
metric
and inspect its structure viareport.dict()
or report.json()
.metric_labels
.
PanelMetric
optionsParameter | Type | Required | Default | Description |
---|---|---|---|---|
legend | str | ❌ | None | Legend name in the panel. If None , one is auto-generated. |
tags | list | ❌ | [] | Optional tags to select values only from a subset of Reports in the Project. |
metadata | dict | ❌ | {} | Optional metadata to select values only from a subset of Reports in the Project. |
metric | str | ✅ | — | Metric name (e.g., "RowCount" ). |
metric_labels | dict | ❌ | {} | Parameters like column names (applies to descriptors too) or value_type . |