# helia_edge.metrics.prd

Percent RMS Difference metrics.

## helia_edge.metrics.prd.PRD

`class` · `python`

```python
PRD(normalized: bool = True, name: str = 'prd', **kwargs={})
```

Percent RMS difference metric with optional energy normalization.

:::note[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: `helia_edge/metrics/prd.py:8`

### helia_edge.metrics.prd.PRD.normalized

`attribute` · `python`

```python
normalized = normalized
```

Source: `helia_edge/metrics/prd.py:22`

### helia_edge.metrics.prd.PRD.update_state

`method` · `python`

```python
update_state(y_true, y_pred, sample_weight=None)
```

Source: `helia_edge/metrics/prd.py:26`

### helia_edge.metrics.prd.PRD.result

`method` · `python`

```python
result()
```

Source: `helia_edge/metrics/prd.py:53`

### helia_edge.metrics.prd.PRD.reset_state

`method` · `python`

```python
reset_state()
```

Source: `helia_edge/metrics/prd.py:59`

### helia_edge.metrics.prd.PRD.get_config

`method` · `python`

```python
get_config()
```

Source: `helia_edge/metrics/prd.py:63`

## helia_edge.metrics.prd.TruePRD

`class` · `python`

```python
TruePRD(name: str = 'true_prd', **kwargs={})
```

Compatibility wrapper for normalized PRD.



Base class: [PRD](/helia-edge/reference/api/helia_edge/metrics/prd/#helia_edge.metrics.prd.PRD).

Inherited from [PRD](/helia-edge/reference/api/helia_edge/metrics/prd/#helia_edge.metrics.prd.PRD): [get_config()](/helia-edge/reference/api/helia_edge/metrics/prd/#helia_edge.metrics.prd.PRD.get_config), [reset_state()](/helia-edge/reference/api/helia_edge/metrics/prd/#helia_edge.metrics.prd.PRD.reset_state), [result()](/helia-edge/reference/api/helia_edge/metrics/prd/#helia_edge.metrics.prd.PRD.result), [update_state()](/helia-edge/reference/api/helia_edge/metrics/prd/#helia_edge.metrics.prd.PRD.update_state).

Source: `helia_edge/metrics/prd.py:67`