Python PyTorch histogram用法及代码示例

本文简要介绍python语言中 torch.histogram 的用法。

用法:

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

参数：

• input(Tensor) -输入张量。

• bins-int 或一维张量。如果是 int，则定义equal-width bin 的数量。如果是张量，则定义 bin 边的序列，包括最右边的边。

关键字参数：

• range(python的元组：float) -定义 bin 的范围。

• weight(Tensor) -如果提供，权重应该与输入具有相同的形状。输入中的每个值都为其 bin 的结果贡献其相关权重。

• density(bool) -如果为 False，则结果将包含每个 bin 中的计数(或总重量)。如果为 True，则结果是 bin 上的概率密度函数的值，标准化使得 bin 范围内的积分为 1。

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

返回：

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

返回类型：

历史(Tensor)

计算张量中值的直方图。

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

如果bins 是一个int，它指定equal-width bins 的数量。默认情况下，bin 的下限和上限范围由输入张量的最小和最大元素确定。可以提供 range 参数来指定 bin 的范围。

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

例子：

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