Sum¶
Module Interface¶
- class torchmetrics.SumMetric(nan_strategy='warn', **kwargs)[source]
Aggregate a stream of value into their sum.
- 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 valuekwargs¶ (
Dict
[str
,Any
]) – Additional keyword arguments, see Advanced metric settings for more info.
- Raises
ValueError – If
nan_strategy
is not one oferror
,warn
,ignore
or a float
Example
>>> 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.