kd.kdash.Plot

class kauldron.utils.kdash.Plot(

*,

y_key: str,

x_key: str = 'step',

collections: list[str] = <factory>,

facet_to_collections: dict[str,

list[str]] = <factory>,

collection_to_ykeys: dict[str,

list[str]] = <factory>,

remove_prefix: bool = True,

)

Bases: object

Single plot inside a dashboard.

y_key

Metric to plot.

Type:

str

x_key

step by default.

Type:

str

collections

List of collections to plot.

Type:

list[str]

facet_to_collections

Group the collections by facet. Each facet is displayed as a separate plot. If set, collections= is optional.

Type:

dict[str, list[str]]

collection_to_ykeys

Allow to display multiple y_keys from the same collection together. If set, collections= is optional.

Type:

dict[str, list[str]]

remove_prefix

Remove the losses/, metrics/,… prefixes.

Type:

bool

y_key: str

x_key: str = 'step'

collections: list[str]

facet_to_collections: dict[str, list[str]]

collection_to_ykeys: dict[str, list[str]]

remove_prefix: bool = True

classmethod merge(

plots: list[kauldron.utils.kdash.plot_utils.Plot],

) → kauldron.utils.kdash.plot_utils.Plot

Merges multiple plots with the same y_key.

build(ctx: BuildContext) → fb.Plot

Build the flatboard plot.