torcheval.metrics.Sum

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

计算所有输入张量中所有元素的加权和值。当未提供权重时，它计算非加权和。其函数版本为 torcheval.metrics.functional.sum()。

示例

>>> 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

初始化指标对象及其内部状态。

使用 self._add_state() 初始化指标类的状态变量。状态变量应为 torch.Tensor、torch.Tensor 列表、以 torch.Tensor 作为值的字典或 torch.Tensor 的 deque。

方法

__init__(*[, device])	初始化指标对象及其内部状态。
计算()	实现此方法以根据状态变量计算并返回最终指标值。
load_state_dict(state_dict[, strict])	从 state_dict 加载指标状态变量。
merge_state(metrics)	实现此方法以更新当前指标的状态变量，使其成为当前指标和输入指标的合并状态。
重置()	将指标状态变量重置为其默认值。
state_dict()	在 state_dict 中保存指标状态变量。
to(device, *args, **kwargs)	将指标状态变量中的张量移动到设备。
update(input, *[, weight])	使用值和权重更新状态。

属性

设备	Metric.to() 的最后一个输入设备。