torch.histogram

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

计算张量值的直方图。

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

如果 bins 是整数，则指定等宽区间的数量。默认情况下，区间的上下范围由输入张量的最小值和最大值确定。可以提供 range 参数来指定区间的范围。

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

参数

• input (张量) – 输入张量。

• bins – int 或 1D Tensor。如果是整数，则定义等宽区间的数量。如果是张量，则定义区间边缘的序列，包括最右边的边缘。

关键字参数

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

• weight (张量) – 如果提供，weight 应与 input 具有相同的形状。input 中的每个值将其关联的权重贡献给对应的区间的统计结果。

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

• out (张量, 可选) – 输出张量。(tuple, optional): 包含两个输出张量 (hist, bin_edges) 的结果元组。

返回值

包含直方图值的 一维张量。bin_edges(张量): 包含直方图区间边缘的 一维张量。

返回类型

hist (张量)

示例

>>> 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.]))