torch.var_mean

torch.var_mean(input, dim=None, *, correction=1, keepdim=False, out=None)

Вычисляет дисперсию и среднее значение по измерениям, заданным с помощью dim. dim может быть одним измерением, списком измерений или None для вычисления по всем измерениям.

Дисперсия ($\sigma^2$) вычисляется как

$$\sigma^2 = \frac{1}{\max(0,~N - \delta N)}\sum_{i=0}^{N-1}(x_i-\bar{x})^2$$

где $x$ — выборка элементов, $\bar{x}$ — выборочное среднее, $N$ — число элементов в выборке, а $\delta N$ — correction.

Если keepdim равен True, выходной тензор имеет тот же размер, что и input, за исключением измерений dim, размер которых равен 1. В противном случае dim удаляет измерения размера 1 (см. torch.squeeze()), и размерность выходного тензора уменьшается на 1 (или на len(dim)).

Параметры:

• input (Tensor) – входной тензор.
• dim (int or tuple of ints, optional) – измерение или измерения, по которым выполняется сведение. Если задано None, выполняется сведение по всем измерениям.

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

• correction (int) –

  разница между размером выборки и числом степеней свободы выборки. По умолчанию используется поправка Бесселя, correction=1.

  Изменено в версии 2.0: Ранее этот аргумент назывался unbiased и имел тип boolean: значение True соответствовало correction=1, а False — correction=0.

• keepdim (bool, optional) – нужно ли сохранять dim в выходном тензоре. По умолчанию: False.
• out (Tensor, optional) – выходной тензор.

Возвращает:

Кортеж (var, mean), содержащий дисперсию и среднее значение.

Пример

>>> a = torch.tensor(
...     [[ 0.2035,  1.2959,  1.8101, -0.4644],
...      [ 1.5027, -0.3270,  0.5905,  0.6538],
...      [-1.5745,  1.3330, -0.5596, -0.6548],
...      [ 0.1264, -0.5080,  1.6420,  0.1992]]
... )  # fmt: skip
>>> torch.var_mean(a, dim=0, keepdim=True)
(tensor([[1.5926, 1.0056, 1.2005, 0.3646]]),
 tensor([[ 0.0645,  0.4485,  0.8707, -0.0665]]))