torch.histogram

torch.histogram(input, bins, *, range=None, weight=None, density=False, out=None)

计算张量中值的直方图。

bins 可以是整数或一维张量。

如果 bins 是整数，它指定等宽箱的数量。默认情况下，箱的下限和上限由输入张量的最小和最大元素确定。可以提供 range 参数以指定箱的范围。

如果 bins 是一维张量，它指定箱边缘的序列，包括最右边的边缘。它应该至少包含 2 个元素，并且其元素应该递增。

参数

• input (Tensor) – 输入张量。

• bins – 整数或一维张量。如果是整数，则定义等宽箱的数量。如果是张量，则定义箱边缘的序列，包括最右边的边缘。

关键字参数

• range (元组 的 浮点数) – 定义箱的范围。

• weight (Tensor) – 如果提供，权重应该与输入具有相同的形状。输入中的每个值都会对其关联的权重贡献到其箱的结果中。

• density (布尔值) – 如果为 False，结果将包含每个箱中的计数（或总权重）。如果为 True，则结果是概率密度函数在箱上的值，经过归一化，使得在箱的范围内积分的结果为 1。

• out (Tensor, 可选) – 输出张量。（元组，可选）：两个输出张量 (hist, bin_edges) 的结果元组。

返回值

包含直方图值的一维张量。bin_edges(Tensor)：包含直方图箱边缘的一维张量。

返回类型

hist (Tensor)

示例

>>> torch.histogram(torch.tensor([1., 2, 1]), bins=4, range=(0., 3.), weight=torch.tensor([1., 2., 4.]))
(tensor([ 0.,  5.,  2.,  0.]), tensor([0., 0.75, 1.5, 2.25, 3.]))
>>> torch.histogram(torch.tensor([1., 2, 1]), bins=4, range=(0., 3.), weight=torch.tensor([1., 2., 4.]), density=True)
(tensor([ 0.,  0.9524,  0.3810,  0.]), tensor([0., 0.75, 1.5, 2.25, 3.]))