torch.functional.norm

torch.functional.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 的签名略有不同。

参数

• input (Tensor) – 输入张量。其数据类型必须是浮点型或复数型。对于复数输入，范数是使用每个元素的绝对值计算的。如果输入是复数且未指定 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 范数会抛出错误。

  核范数（Nuclear norm）只能跨越恰好两个维度进行计算。

• dim (int, tuple of ints, list of ints, optional) – 指定计算范数的 input 的一个或多个维度。如果 dim 为 None，则范数将在 input 的所有维度上计算。如果 p 指示的范数类型不支持指定的维度数量，则会发生错误。

• keepdim (bool, optional) – 指定输出张量是否保留 dim。如果 dim = None 且 out = None，则忽略此参数。默认为 False。

• out (Tensor, optional) – 输出张量。如果 dim = None 且 out = None，则忽略此参数。

• dtype (torch.dtype, optional) – 返回张量的期望数据类型。如果指定，则在执行操作时将输入张量转换为 dtype。默认为 None。

注意

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

示例

>>> 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))