评价此页

torch.linalg.norm#

torch.linalg.norm(A, ord=None, dim=None, keepdim=False, *, out=None, dtype=None) Tensor#

计算向量或矩阵的范数。

支持浮点、双精度、复浮点和复双精度数据类型的输入。

此函数计算向量范数还是矩阵范数取决于以下条件:

  • 如果 dim 是一个 int,则将计算向量范数。

  • 如果 dim 是一个 2-tuple,则将计算矩阵范数。

  • 如果 dim= Noneord= None,则 A 将被展平成一维,并计算由此产生的向量的 2-范数。

  • 如果 dim= Noneord != None,则 A 必须是 1D 或 2D。

ord 定义了要计算的范数。支持以下范数:

ord

矩阵范数

向量范数

None (默认)

Frobenius 范数

2-范数(见下文)

‘fro’

Frobenius 范数

– 不支持 –

‘nuc’

核范数

– 不支持 –

inf

max(sum(abs(x), dim=1))

max(abs(x))

-inf

min(sum(abs(x), dim=1))

min(abs(x))

0

– 不支持 –

sum(x != 0)

1

max(sum(abs(x), dim=0))

如下所示

-1

min(sum(abs(x), dim=0))

如下所示

2

最大的 奇异值

如下所示

-2

最小的 奇异值

如下所示

其他 intfloat

– 不支持 –

sum(abs(x)^{ord})^{(1 / ord)}

其中 inffloat(‘inf’)、NumPy 的 inf 对象或任何等效对象。

另请参阅

torch.linalg.vector_norm() 计算向量范数。

torch.linalg.matrix_norm() 计算矩阵范数。

上述函数通常比使用 torch.linalg.norm() 更清晰、更灵活。例如,torch.linalg.norm(A, ord=1, dim=(0, 1)) 始终计算矩阵范数,而使用 torch.linalg.vector_norm(A, ord=1, dim=(0, 1)) 可以计算两个维度的向量范数。

参数
  • A (Tensor) – 形状为 (*, n)(*, m, n) 的张量,其中 * 是零个或多个批次维度。

  • ord (int, float, inf, -inf, 'fro', 'nuc', optional) – 范数的阶数。默认为 None

  • dim (int, Tuple[int], optional) – 计算向量或矩阵范数的维度。有关 dim= None 时的行为,请参阅上文。默认为 None

  • keepdim (bool, optional) – 如果设置为 True,则结果中的缩减维度将作为大小为 1 的维度保留。默认为 False

关键字参数
  • out (Tensor, optional) – 输出张量。如果为 None 则忽略。默认为 None

  • dtype (torch.dtype, optional) – 如果指定,则在执行操作之前,输入张量将被转换为 dtype,并且返回的张量的类型将是 dtype。默认为 None

返回

一个实值张量,即使 A 是复数。

示例

>>> from torch import linalg as LA
>>> a = torch.arange(9, dtype=torch.float) - 4
>>> a
tensor([-4., -3., -2., -1.,  0.,  1.,  2.,  3.,  4.])
>>> B = a.reshape((3, 3))
>>> B
tensor([[-4., -3., -2.],
        [-1.,  0.,  1.],
        [ 2.,  3.,  4.]])

>>> LA.norm(a)
tensor(7.7460)
>>> LA.norm(B)
tensor(7.7460)
>>> LA.norm(B, 'fro')
tensor(7.7460)
>>> LA.norm(a, float('inf'))
tensor(4.)
>>> LA.norm(B, float('inf'))
tensor(9.)
>>> LA.norm(a, -float('inf'))
tensor(0.)
>>> LA.norm(B, -float('inf'))
tensor(2.)

>>> LA.norm(a, 1)
tensor(20.)
>>> LA.norm(B, 1)
tensor(7.)
>>> LA.norm(a, -1)
tensor(0.)
>>> LA.norm(B, -1)
tensor(6.)
>>> LA.norm(a, 2)
tensor(7.7460)
>>> LA.norm(B, 2)
tensor(7.3485)

>>> LA.norm(a, -2)
tensor(0.)
>>> LA.norm(B.double(), -2)
tensor(1.8570e-16, dtype=torch.float64)
>>> LA.norm(a, 3)
tensor(5.8480)
>>> LA.norm(a, -3)
tensor(0.)

使用 dim 参数计算向量范数

>>> c = torch.tensor([[1., 2., 3.],
...                   [-1, 1, 4]])
>>> LA.norm(c, dim=0)
tensor([1.4142, 2.2361, 5.0000])
>>> LA.norm(c, dim=1)
tensor([3.7417, 4.2426])
>>> LA.norm(c, ord=1, dim=1)
tensor([6., 6.])

使用 dim 参数计算矩阵范数

>>> A = torch.arange(8, dtype=torch.float).reshape(2, 2, 2)
>>> LA.norm(A, dim=(1,2))
tensor([ 3.7417, 11.2250])
>>> LA.norm(A[0, :, :]), LA.norm(A[1, :, :])
(tensor(3.7417), tensor(11.2250))