register_metric

cubie.outputhandling.summarymetrics.register_metric(registry: SummaryMetrics) Callable[source]

Create a decorator that registers a metric on instantiation.

Parameters:

registry – SummaryMetrics instance that accepts the metric.

Returns:

Decorator that instantiates and registers the wrapped metric class.

Return type:

Callable

Notes

The decorator immediately instantiates the class so that registration occurs when the module importing the metric executes.