torch.histogram

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

Вычисляет гистограмму значений тензора.

bins может быть целым числом или одномерным тензором.

Если bins — целое число, оно задаёт количество интервалов одинаковой ширины. По умолчанию нижняя и верхняя границы интервалов определяются минимальным и максимальным элементами входного тензора. Аргумент range можно указать, чтобы задать диапазон интервалов.

Если bins — одномерный тензор, он задаёт последовательность границ интервалов, включая правую крайнюю границу. Он должен содержать не менее 2 элементов, расположенных в порядке возрастания.

Параметры:

• input (Tensor) – входной тензор.
• bins – целое число или одномерный тензор. Если задано целое число, оно определяет количество интервалов одинаковой ширины. Если задан тензор, он определяет последовательность границ интервалов, включая правую крайнюю границу.

Именованные аргументы:

• range (tuple of float) – задаёт диапазон интервалов.
• weight (Tensor) – если указан, weight должен иметь ту же форму, что и input. Каждое значение input добавляет связанный с ним вес к результату для соответствующего интервала.
• density (bool) – если False, результат содержит количество (или суммарный вес) в каждом интервале. Если True, результат содержит значения функции плотности вероятности для интервалов, нормированные так, чтобы интеграл по диапазону интервалов равнялся 1.
• out (Tensor, optional) – выходной тензор. (кортеж, необязательный): кортеж из двух выходных тензоров (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.]))