prd

Percent RMS Difference metrics.

Classes

PRD

PRD(normalized: bool = True, name: str = 'prd', **kwargs)

Percent RMS difference metric with optional energy normalization.

PRD is computed as

100 * sqrt(sum((y_true - y_pred)^2) / denom)

where denom is either: - sum(y_true^2) when normalized=True - N (number of elements) when normalized=False

Source code in helia_edge/metrics/prd.py

def __init__(self, normalized: bool = True, name: str = "prd", **kwargs):
    super().__init__(name=name, **kwargs)
    self.normalized = normalized
    self._num = self.add_variable(shape=(), initializer="zeros", name="num")
    self._den = self.add_variable(shape=(), initializer="zeros", name="den")

TruePRD

TruePRD(name: str = 'true_prd', **kwargs)

Compatibility wrapper for normalized PRD.

Source code in helia_edge/metrics/prd.py

def __init__(self, name: str = "true_prd", **kwargs):
    kwargs.pop("normalized", None)
    super().__init__(normalized=True, name=name, **kwargs)