isingle_run_metric

Base interface for metrics evaluated on one SingleRun.

class pysatl_cpd.analysis.metrics.abstracts.isingle_run_metric.ISingleRunMetric[source]

Bases: ABC, Generic

Base class for metrics that evaluate one run.

Notes

The generic parameters identify the detection trace type, labeled data provider type, and metric result type.

abstractmethod evaluate(run)[source]

Evaluate one trace/provider pair.

Parameters:

run (SingleRun[TypeVar(TraceT, bound= DetectionTrace), TypeVar(ProviderT, bound= LabeledData)]) – The run to evaluate.

Return type:

TypeVar(ResultT)