triplet_margin_loss

paddle.nn.functional. triplet_margin_loss ( input, positive, negative, margin: float = 1.0, p: float = 2.0, epsilon: float = 1e-6, swap: bool = False, reduction: str = 'mean', name: str = None ) [源代码]

该 api 计算输入 input 和 positive 和 negative 间的 triplet margin loss 损失，测量 input 与 positive examples 和 negative examples 之间的相对相似性。所有输入 Tensor 的形状都为 \((N, *)\)，* 是任意其他维度。

损失函数按照下列公式计算

\[L(input, pos, neg) = \max \{d(input_i, pos_i) - d(input_i, neg_i) + {\rm margin}, 0\}\]

距离函数为

\[d(x_i, y_i) = \left\lVert {\bf x}_i - {\bf y}_i \right\rVert_2\]

p 为距离函数的范数。margin 为（input，positive）与（input，negative）的距离间隔，swap 为 True 时，会比较（input，negative）和（positive，negative）的大小，并将（input，negative）换为其中较小的值，内容详见论文 Learning shallow convolutional feature descriptors with triplet losses 。

参数

  • input (Tensor) - \([N, * ]\)，其中 N 是 batch_size， * 是任意其他维度。数据类型是 float32、float64。

  • positive (Tensor) - \([N, *]\)，正样本。

  • negative (Tensor) - \([N, *]\)，负样本。

  • margin (float，可选) - 手动指定间距，默认为 1。

  • p (float，可选) - 手动指定范数，默认为 2。

  • epsilon (float，可选) - 防止除数为零，默认为 1e-6。

  • swap (bool，可选) - 默认为 False。

  • reduction (str，可选) - 指定应用于输出结果的计算方式，可选值有：'none'， 'mean'， 'sum'。默认为 'mean'，计算 Loss 的均值；设置为 'sum' 时，计算 Loss 的总和；设置为 'none' 时，则返回原始 Loss。

  • name (str，可选) - 具体用法请参见 Name，一般无需设置，默认值为 None。

形状

  • input (Tensor) - \([N, * ]\)，其中 N 是 batch_size， * 是任意其他维度。数据类型是 float32、float64。

  • positive (Tensor) - \([N, *]\)，标签 positive 的维度、数据类型与输入 input 相同。

  • negative (Tensor) - \([N, *]\)，标签 negative 的维度、数据类型与输入 input 相同。

  • output (Tensor) - 输出的 Tensor。如果 reduction 是 'none'，则输出的维度为 \([N, *]\)，与输入 input 的形状相同。如果 reduction 是 'mean' 或 'sum'，则输出的维度为 \([]\) 。

返回

返回计算的 Loss。

代码示例

>>> import paddle
>>> import paddle.nn.functional as F

>>> input = paddle.to_tensor([[1, 5, 3], [0, 3, 2], [1, 4, 1]], dtype=paddle.float32)
>>> positive = paddle.to_tensor([[5, 1, 2], [3, 2, 1], [3, -1, 1]], dtype=paddle.float32)
>>> negative = paddle.to_tensor([[2, 1, -3], [1, 1, -1], [4, -2, 1]], dtype=paddle.float32)
>>> loss = F.triplet_margin_loss(input, positive, negative, margin=1.0, reduction='none')
>>> print(loss)
Tensor(shape=[3], dtype=float32, place=Place(cpu), stop_gradient=True,
       [0.        , 0.57496595, 0.        ])

>>> loss = F.triplet_margin_loss(input, positive, negative, margin=1.0, reduction='mean')
>>> print(loss)
Tensor(shape=[], dtype=float32, place=Place(cpu), stop_gradient=True,
       0.19165532)

使用本API的教程文档