gemseo / utils / metrics

Hide inherited members

base_composite_metric module

A metric that relies on another metric.

class gemseo.utils.metrics.base_composite_metric.BaseCompositeMetric(metric)[source]

Bases: BaseMetric[_InputT, _OutputT]

A base class for a metric that relies on another metric.

Initialize self. See help(type(self)) for accurate signature.

Parameters:

metric (BaseMetric[Any, Any]) – The metric the composite metric relies on.

abstract compute(a, b)

Evaluate the metric.

Parameters:

  • a (_InputT) – A first quantity.

  • b (_InputT) – A second quantity.

Returns:

The metric associated with a and b.

Return type:

_OutputT