Mean

Module Interface

class torchmetrics.MeanMetric(nan_strategy='warn', **kwargs)

Aggregate a stream of value into their mean value.

Parameters

nan_strategy (Union[str, float]) –

options:

• 'error': if any nan values are encounted will give a RuntimeError

• 'warn': if any nan values are encounted will give a warning and continue

• 'ignore': all nan values are silently removed

• a float: if a float is provided will impude any nan values with this value

kwargs: Additional keyword arguments, see Advanced metric settings for more info.

Raises

ValueError – If nan_strategy is not one of error, warn, ignore or a float

Example

>>> from torchmetrics import MeanMetric
>>> metric = MeanMetric()
>>> metric.update(1)
>>> metric.update(torch.tensor([2, 3]))
>>> metric.compute()
tensor(2.)

Initializes internal Module state, shared by both nn.Module and ScriptModule.

compute()

Compute the aggregated value.

Return type

Tensor

update(value, weight=1.0)

Update state with data.

Parameters

• value (Union[float, Tensor]) – Either a float or tensor containing data. Additional tensor dimensions will be flattened

• weight (Union[float, Tensor]) – Either a float or tensor containing weights for calculating the average. Shape of weight should be able to broadcast with the shape of value. Default to 1.0 corresponding to simple harmonic average.

Return type

None