评价此页

torch.linalg.vector_norm#

torch.linalg.vector_norm(x, ord=2, dim=None, keepdim=False, *, dtype=None, out=None) Tensor#

计算向量范数。

如果 x 是复数值,则计算 x.abs() 的范数。

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

此函数不一定将多维 x 视为向量批次,而是

  • 如果 dim= None,则在计算范数之前将 x 展平。

  • 如果 diminttuple,则将在这些维度上计算范数,而其他维度将被视为批处理维度。

此行为是为了与 torch.linalg.norm() 保持一致。

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

ord

向量范数

2 (默认)

2-范数(如下所述)

inf

max(abs(x))

-inf

min(abs(x))

0

sum(x != 0)

其他 intfloat

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

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

dtype 可用于以更精确的 dtype 执行计算。它在语义上等同于调用 linalg.vector_norm(x.to(dtype)),但在某些情况下更快。

另请参阅

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

参数
  • x (Tensor) – 张量,默认展平,但此行为可通过 dim 控制。(注意:关键字参数 input 也可用作 x 的别名。)

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

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

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

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

  • dtype (torch.dtype, optional) – 用于执行累加和返回的类型。如果指定,将在执行操作之前将 x 转换为 dtype,并且如果 x 是复数,则返回张量的类型将是其复数对应类型,否则为实数。如果 x 是复数,则 dtype 也可以是复数,否则它必须是实数。 x 应可无损地转换为 dtype。默认为 None。

返回

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

示例

>>> 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.vector_norm(a, ord=3.5)
tensor(5.4345)
>>> LA.vector_norm(B, ord=3.5)
tensor(5.4345)