Sum

Module Interface

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

Aggregate a stream of value into their sum.

As input to forward and update the metric accepts the following input

• value (float or Tensor): a single float or an tensor of float values with arbitary shape (...,).

As output of forward and compute the metric returns the following output

• agg (Tensor): scalar float tensor with aggregated sum over all inputs received

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 (Any) – 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

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

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