mindspore.ops.TripletMarginLoss

class mindspore.ops.TripletMarginLoss(p=2, eps=1e-06, swap=False, reduction='mean')[源代码]

三元组损失函数。

创建一个标准，用于计算输入Tensor \(x1\) 、 \(x2\) 和 \(x3\) 与大于 \(0\) 的 margin 之间的三元组损失值。可以用来测量样本之间的相似度。一个三元组包含 a 、 p 和 n （即分别代表示 anchor 、 positive examples 和 negative examples ）。所有输入Tensor的shape都应该为 \((N, D)\) 。距离交换在V. Balntas、E. Riba等人的论文 Learning local feature descriptors with triplets and shallow convolutional neural networks 中有详细的阐述。

对于每个小批量样本，损失值为：

\[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 (int，可选) - 成对距离的范数。默认值： 2 。
eps (float，可选) - 默认值： 1e-6 。
swap (bool，可选) - 距离交换。默认值： False 。
reduction (str，可选) - 指定应用于输出结果的规约计算方式，可选 'none' 、 'mean' 、 'sum' ，默认值： 'mean' 。
- "none"：不应用规约方法。
- "mean"：计算输出元素的平均值。
- "sum"：计算输出元素的总和。

输入：

x (Tensor) - 从训练集随机选取的样本。数据类型为BasicType。
positive (Tensor) - 与 x 为同一类的样本，数据类型与shape与 x 一致。
negative (Tensor) - 与 x 为异类的样本，数据类型与shape与 x 一致。
margin (Tensor) - 拉进 a 和 p 之间的距离，拉远 a 和 n 之间的距离。

输出：

Tensor或Scalar，如果 reduction 为”none”，其shape为 \((N)\)。否则，将返回Scalar。

异常：

TypeError - x 、 positive 、 negative 或者 margin 不是Tensor。
TypeError - x 、 positive 或者 negative 的数据类型不是BasicType。
TypeError - x 、 positive 或者 negative 的数据类型不一致。
TypeError - margin 的数据类型不是float32。
TypeError - p 的数据类型不是int。
TypeError - eps 的数据类型不是float。
TypeError - swap 的数据类型不是bool。
ValueError - x 、 positive 和 negative 的维度同时小于等于1。
ValueError - x 、 positive 或 negative 的维度大于等于8。
ValueError - margin 的shape长度不为0。
ValueError - x 、 positive 和 negative 三者之间的shape无法广播。
ValueError - reduction 不为”mean”、”sum”或”none”。

支持平台：

GPU

样例：

>>> import mindspore
>>> import numpy as np
>>> from mindspore import Tensor, ops
>>> loss = ops.TripletMarginLoss()
>>> x = Tensor(np.array([[0.3, 0.7], [0.5, 0.5]]), mindspore.float32)
>>> positive = Tensor(np.array([[0.4, 0.6], [0.4, 0.6]]), mindspore.float32)
>>> negative = Tensor(np.array([[0.2, 0.9], [0.3, 0.7]]), mindspore.float32)
>>> margin = Tensor(1.0, mindspore.float32)
>>> output = loss(x, positive, negative, margin)
>>> print(output)
0.8881968