torch.linalg.matrix_norm

torch.linalg.matrix_norm(A, ord='fro', dim=(-2, -1), keepdim=False, *, dtype=None, out=None) → Tensor

计算矩阵范数。

如果 A 是复数值，则计算 A.abs() 的范数

支持 float, double, cfloat 和 cdouble 数据类型的输入。也支持矩阵批次：范数将在由 2 元组 dim 指定的维度上计算，其他维度将被视为批次维度。输出将具有相同的批次维度。

ord 定义了计算的矩阵范数。支持以下范数：

ord	矩阵范数
‘fro’ (默认)	Frobenius 范数
‘nuc’	核范数
inf	max(sum(abs(x), dim=1))
-inf	min(sum(abs(x), dim=1))
1	max(sum(abs(x), dim=0))
-1	min(sum(abs(x), dim=0))
2	最大奇异值
-2	最小奇异值

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

参数

• A (Tensor) – 具有两个或多个维度的张量。默认情况下，其形状被解释为 (*, m, n)，其中 * 是零个或多个批次维度，但此行为可以使用 dim 控制。

• ord (int, inf, -inf, 'fro', 'nuc', optional) – 范数阶数。默认值：‘fro’

• dim (Tuple[int, int], optional) – 计算范数的维度。默认值：(-2, -1)

• keepdim (bool, optional) – 如果设置为 True，则结果中保留被缩减的维度，其大小为一。默认值：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).reshape(3, 3)
>>> A
tensor([[0., 1., 2.],
        [3., 4., 5.],
        [6., 7., 8.]])
>>> LA.matrix_norm(A)
tensor(14.2829)
>>> LA.matrix_norm(A, ord=-1)
tensor(9.)
>>> B = A.expand(2, -1, -1)
>>> B
tensor([[[0., 1., 2.],
        [3., 4., 5.],
        [6., 7., 8.]],

        [[0., 1., 2.],
        [3., 4., 5.],
        [6., 7., 8.]]])
>>> LA.matrix_norm(B)
tensor([14.2829, 14.2829])
>>> LA.matrix_norm(B, dim=(0, 2))
tensor([ 3.1623, 10.0000, 17.2627])