torch.linalg.vector_norm

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

计算向量范数。

如果 x 是复数值，它计算 x.abs() 的范数

支持 float、double、cfloat 和 cdouble dtypes 的输入。

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

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

• 如果 dim 是一个 int 或一个 tuple，则将在这些维度上计算范数，而其他维度将被视为批次维度。

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

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

ord	向量范数
2 (默认)	2-范数 (见下文)
inf	max(abs(x))
-inf	min(abs(x))
0	sum(x != 0)
其他 int 或 float	sum(abs(x)^{ord})^{(1 / ord)}

其中 inf 指的是 float('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', 可选) – 范数的阶数。默认值：2

• dim (int, Tuple[int], 可选) – 计算范数的维度。有关 dim= None 时的行为，请参见上文。默认值：None

• keepdim (bool, 可选) – 如果设置为 True，则在结果中保留缩减的维度，作为大小为 1 的维度。默认值：False

关键字参数

• out (Tensor, 可选) – 输出张量。如果为 None，则忽略。默认值：None。

• dtype (torch.dtype, 可选) – 用于执行累加和返回的类型。如果指定，x 将在执行操作之前转换为 dtype，并且如果为实数，则返回张量的类型将为 dtype，如果为复数，则为其对应的实数类型。dtype 在 x 为复数时可以是复数，否则必须为实数。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)