arl_based_metric_visualizer

ARL-based metric visualizer.

class pysatl_cpd.analysis.visualization.benchmarking.metrics.arl_based_metric_visualizer.ARLBasedMetricVisualizer(*, backend=DrawBackend.MATPLOTLIB, y_metrics, title='ARL Curve', ylabel='Values', style_map=None)

Bases: IMetricVisualizer

Draw metrics as functions of ARL.

Rows that share the same arl value (e.g. different thresholds) are collapsed by taking the minimum of each plotted metric, yielding the lower envelope along the ARL axis.

Parameters:

• backend (DrawBackend | str)

• y_metrics (list[str])

• title (str)

• ylabel (str)

• style_map (dict[str, LineSpec] | None)

__init__(*, backend=DrawBackend.MATPLOTLIB, y_metrics, title='ARL Curve', ylabel='Values', style_map=None)

Parameters:

• backend (DrawBackend | str)

• y_metrics (list[str])

• title (str)

• ylabel (str)

• style_map (dict[str, LineSpec] | None)

Return type:

None

property requirements: list[str]

ARL plus all configured Y metrics.

Type:

Return required columns