TripletMarginLoss

class torch.nn.TripletMarginLoss(margin=1.0, p=2.0, eps=1e-06, swap=False, size_average=None, reduce=None, reduction='mean')

建立一個準則，該準則根據輸入張量 $x1$、$x2$、$x3$ 和一個大於 $0$ 的邊界值（margin）來度量三元組損失（triplet loss）。這用於度量樣本之間的相對相似性。一個三元組由 a、p 和 n 組成（分別表示 錨點（anchor）、正例（positive examples） 和 負例（negative examples））。所有輸入張量的形狀應為 $(N, D)$。

距離交換（distance swap）在 V. Balntas、E. Riba 等人的論文 Learning shallow convolutional feature descriptors with triplet losses 中有詳細描述。

小批次資料中每個樣本的損失函式為

$$L(a, p, n) = \max \{d(a_i, p_i) - d(a_i, n_i) + {\rm margin}, 0\}$$

其中

$$d(x_i, y_i) = \left\lVert {\bf x}_i - {\bf y}_i \right\rVert_p$$

範數是使用指定的 p 值計算的，並添加了一個小的常數 $\varepsilon$ 以提高數值穩定性。

另請參閱 TripletMarginWithDistanceLoss，該類使用自定義距離函式計算輸入張量的三元組邊界損失。

引數

• margin (float, optional) – 預設值: $1$。

• p (int, optional) – 成對距離的範數階數。預設值: $2$。

• eps (float, optional) – 用於數值穩定性的小常數。預設值: $1e-6$。

• swap (bool, optional) – 距離交換（distance swap）在 V. Balntas、E. Riba 等人的論文 Learning shallow convolutional feature descriptors with triplet losses 中有詳細描述。預設值: False。

• size_average (bool, optional) – 已棄用（參見 reduction）。預設情況下，損失會按批次中每個損失元素進行平均。注意，對於某些損失，每個樣本可能包含多個元素。如果將欄位 size_average 設定為 False，則損失將改為對每個小批次資料求和。當 reduce 為 False 時忽略此引數。預設值: True

• reduce (bool, optional) – 已棄用（參見 reduction）。預設情況下，損失會根據 size_average 對每個小批次資料中的觀測值進行平均或求和。當 reduce 為 False 時，將返回每個批次元素的損失，並忽略 size_average。預設值: True

• reduction (str, optional) – 指定應用於輸出的歸約（reduction）方式：'none' | 'mean' | 'sum'。'none': 不應用歸約，'mean': 輸出總和除以輸出中的元素數量進行平均，'sum': 對輸出求和。注意：size_average 和 reduce 正在棄用過程中，在此期間，指定這兩個引數中的任何一個都將覆蓋 reduction。預設值: 'mean'

形狀

• 輸入: $(N, D)$ 或 $(D)$，其中 $D$ 是向量維度。

• 輸出: 如果 reduction 為 'none' 且輸入形狀為 $(N, D)$，則形狀為 $(N)$ 的張量；否則為標量。

示例

>>> triplet_loss = nn.TripletMarginLoss(margin=1.0, p=2, eps=1e-7)
>>> anchor = torch.randn(100, 128, requires_grad=True)
>>> positive = torch.randn(100, 128, requires_grad=True)
>>> negative = torch.randn(100, 128, requires_grad=True)
>>> output = triplet_loss(anchor, positive, negative)
>>> output.backward()