torcheval.metrics.Sum

class torcheval.metrics.Sum(*, device: device | None = None)

Calculate the weighted sum value of all elements in all the input tensors. When weight is not provided, it calculates the unweighted sum. Its functional version is torcheval.metrics.functional.sum().

Examples:

>>> import torch
>>> from torcheval.metrics import Sum
>>> metric = Sum()
>>> metric.update(1)
>>> metric.update(torch.tensor([2, 3]))
>>> metric.compute()
tensor(6.)
>>> metric.update(torch.tensor(-1)).compute()
tensor(5.)
>>> metric.reset()
>>> metric.update(torch.tensor(-1)).compute()
tensor(-1.)

>>> metric = Sum()
>>> metric.update(torch.tensor([2, 3]), torch.tensor([0.1, 0.6])).compute()
tensor(2.)
>>> metric.update(torch.tensor([2, 3]), 0.5).compute()
tensor(4.5)
>>> metric.update(torch.tensor([4, 6]), 1).compute()
tensor(14.5)

__init__(*, device: device | None = None) → None

Initialize a metric object and its internal states.

Use self._add_state() to initialize state variables of your metric class. The state variables should be either torch.Tensor, a list of torch.Tensor, a dictionary with torch.Tensor as values, or a deque of torch.Tensor.

Methods

__init__(*[, device])	Initialize a metric object and its internal states.
compute()	Implement this method to compute and return the final metric value from state variables.
load_state_dict(state_dict[, strict])	Loads metric state variables from state_dict.
merge_state(metrics)	Implement this method to update the current metric's state variables to be the merged states of the current metric and input metrics.
reset()	Reset the metric state variables to their default value.
state_dict()	Save metric state variables in state_dict.
to(device, *args, **kwargs)	Move tensors in metric state variables to device.
update(input, *[, weight])	Update states with the values and weights.

Attributes

device

The last input device of Metric.to().