kd.kdash.SingleDashboard

kd.kdash.SingleDashboard#

class kauldron.utils.kdash.SingleDashboard(
*,
name: str,
title: str,
plots: list[kauldron.utils.kdash.plot_utils.Plot],
)[source]

Bases: kauldron.utils.kdash.dashboard_utils.DashboardsBase

Single dashboard containing multiple plots.

name

Name of the dashboard (used for XManager artifact, XM UI plot tabs). For example: metrics, losses, perf_stats…

Type:

str

title

Title of the dashboard. This can contain {xid} placeholders. For example: {xid}: Performance statistics

Type:

str

plots

List of plots to display in the dashboard.

Type:

list[kauldron.utils.kdash.plot_utils.Plot]

name: str
title: str
plots: list[kauldron.utils.kdash.plot_utils.Plot]
classmethod from_y_keys(
*,
name: str,
title: str,
y_keys: list[str],
collections: list[str],
) → kauldron.utils.kdash.dashboard_utils.SingleDashboard[source]
normalize() → kauldron.utils.kdash.dashboard_utils.MultiDashboards[source]

Returns a normalized version of the dashboard.

build(
ctx: plot_utils.BuildContext,
) → fb.Dashboard[source]