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