torch.norm

torch.norm(input, p='fro', dim=None, keepdim=False, out=None, dtype=None)

返回给定张量的矩阵范数或向量范数。

警告

torch.norm 已被弃用，并可能在未来的 PyTorch 版本中被移除。 其文档和行为可能不正确，且不再积极维护。

在计算向量范数时使用 torch.linalg.vector_norm()， 在计算矩阵范数时使用 torch.linalg.matrix_norm()。 对于与此函数行为类似的函数，请参见 torch.linalg.norm()。 但请注意，这些函数的签名与 torch.norm 的签名略有不同。

Parameters

• 输入 (张量) – 输入张量。其数据类型必须是浮点型或复数型。对于复数输入，范数是使用每个元素的绝对值计算的。如果输入是复数且未指定dtype或out，结果的数据类型将是相应的浮点类型（例如，如果input是complexfloat，则为float）。

• p (int, float, inf, -inf, 'fro', 'nuc', optional) –

  范数的阶。默认值：'fro' 可以计算以下范数：

  ord	矩阵范数	向量范数
  ’fro’	Frobenius范数	–
  ‘nuc’	核范数	–
  数字	–	sum(abs(x)**ord)**(1./ord)

  向量范数可以在任意数量的维度上计算。 input 的相应维度被展平为一个维度，并且在该展平维度上计算范数。

  Frobenius范数在所有情况下产生与 p=2 相同的结果，除非 dim 是三个或更多维的列表，在这种情况下，Frobenius范数会抛出错误。

  核范数只能在恰好两个维度上计算。

• dim (int, tuple 的 ints, list 的 ints, 可选) – 指定计算 input 的哪个维度或哪些维度上的范数。如果 dim 是 None，范数将在 input 的所有维度上计算。如果由 p 指示的范数类型不支持指定的维度数量，将发生错误。

• keepdim (布尔值, 可选) – 输出张量是否保留dim。如果dim = None且out = None，则忽略。默认值：False

• out (Tensor, 可选) – 输出张量。如果 dim = None 且 out = None，则忽略。

• dtype (torch.dtype, 可选) – 返回张量的所需数据类型。如果指定，输入张量在执行操作时会被转换为dtype。默认值：None。

注意

尽管p='fro'支持任意数量的维度，但Frobenius范数的真正数学定义仅适用于具有恰好两个维度的张量。torch.linalg.matrix_norm()与ord='fro'对齐，因为它只能应用于恰好两个维度。

示例：

>>> import torch
>>> a = torch.arange(9, dtype= torch.float) - 4
>>> b = a.reshape((3, 3))
>>> torch.norm(a)
tensor(7.7460)
>>> torch.norm(b)
tensor(7.7460)
>>> torch.norm(a, float('inf'))
tensor(4.)
>>> torch.norm(b, float('inf'))
tensor(4.)
>>> c = torch.tensor([[ 1, 2, 3], [-1, 1, 4]] , dtype=torch.float)
>>> torch.norm(c, dim=0)
tensor([1.4142, 2.2361, 5.0000])
>>> torch.norm(c, dim=1)
tensor([3.7417, 4.2426])
>>> torch.norm(c, p=1, dim=1)
tensor([6., 6.])
>>> d = torch.arange(8, dtype=torch.float).reshape(2, 2, 2)
>>> torch.norm(d, dim=(1, 2))
tensor([ 3.7417, 11.2250])
>>> torch.norm(d[0, :, :]), torch.norm(d[1, :, :])
(tensor(3.7417), tensor(11.2250))