Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 3.14 KB

triplet_margin_with_distance_loss_cn.rst

File metadata and controls

50 lines (34 loc) · 3.14 KB

triplet_margin_with_distance_loss

.. py:function:: paddle.nn.functional.triplet_margin_with_distance_loss(input, positive, negative, distance_function=None,  margin: float = 1.0, swap: bool = False,reduction: str = 'mean', name:str=None)

计算输入 input 和 positive 和 negative 间的 triplet margin loss 损失。

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

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

其中的距离函数 distance_function 可以由用户自定义,使用 lambda 或是 def 都可以。如果未定义则调用 2 范数计算距离

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

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, *],正样本,维度、数据类型与输入 input 相同。
  • negative (Tensor) - [N, *],负样本,维度、数据类型与输入 input 相同。
  • distance_function (Callable,可选) - 手动指定范数,默认为 None,计算欧式距离。
  • margin (float,可选) - 手动指定间距,默认为 1。
  • swap (bool,可选) - 默认为 False。
  • reduction (str,可选) - 指定应用于输出结果的计算方式,可选值有:'none''mean''sum'。默认为 'mean',计算 Loss 的均值;设置为 'sum' 时,计算 Loss 的总和;设置为 'none' 时,则返回原始 Loss。
  • name (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

形状

  • input (Tensor) - [N, *],其中 N 是 batch_size, * 是任意其他维度。数据类型是 float32、float64。
  • positive (Tensor) - [N, *],标签 positive 的维度、数据类型与输入 input 相同。
  • negative (Tensor) - [N, *],标签 negative 的维度、数据类型与输入 input 相同。
  • output (Tensor) - 输出的 Tensor。如果 :attr:`reduction`'none',则输出的维度为 [N, *],与输入 input 的形状相同。如果 :attr:`reduction`'mean''sum',则输出的维度为 []

返回

输出的 Tensor。如果 :attr:`reduction`'none',则输出的维度为 [N, *],与输入 input 的形状相同。如果 :attr:`reduction`'mean''sum',则输出的维度为 []

代码示例

COPY-FROM: paddle.nn.functional.triplet_margin_with_distance_loss