Triplet Margin Loss

classtorch.nn.TripletMarginLoss(margin=1.0, p=2.0, eps=1e-06, swap=False, size_average=None, reduce=None, reduction='mean')[源代码]

创建一个用于度量三元组损失的标准，给定输入张量$x1$、$x2$和$x3$以及一个大于$0$的边距。这用于衡量样本之间的相对相似性。一个三元组由基准样例（a）、正例（p）和反例（n）组成，它们分别代表锚点、正样本和负样本。所有输入张量的形状应为$(N, D)$。

距离交换的详细内容见论文 使用三元组损失学习浅层卷积特征描述符，作者为 V. Balntas, E. Riba 等。

mini-batch中每个样本的损失函数为：

$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, 可选) – 默认值为$1$。

• p (int, 可选) – 成对距离的范数度。默认值：$2$。

• eps (float, 可选) – 用于保证数值稳定的微小常量。默认值：$1e-6$。

• swap (bool, optional) – 距离交换的详细描述参见论文《Learning shallow convolutional feature descriptors with triplet losses》，作者为 V. Balntas, E. Riba 等人。默认值：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, 可选) – 指定要应用于输出的缩减方式：'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()