aac_metrics.classes.base module

class AACMetric(

**kwargs: Any,

)

Bases: Module, Generic[OutType]

Base Metric module for AAC metrics. Similar to torchmetrics.Metric.

compute() → OutType

forward(

*args: Any,

**kwargs: Any,

) → OutType

Define the computation performed at every call.

Should be overridden by all subclasses.

Note

Although the recipe for forward pass needs to be defined within this function, one should call the Module instance afterwards instead of this since the former takes care of running the registered hooks while the latter silently ignores them.

full_state_update: ClassVar[bool | None] = False

higher_is_better: ClassVar[bool | None] = None

is_differentiable: ClassVar[bool | None] = False

max_value: ClassVar[float] = inf

min_value: ClassVar[float] = -inf

reset() → None

training: bool

update(

*args,

**kwargs,

) → None