mindspore.ops.triplet_margin_loss

mindspore.ops.triplet_margin_loss(anchor, positive, negative, margin=1.0, p=2, eps=1e-06, swap=False, reduction='mean')[源代码]

三元组损失函数。 详情请查看 mindspore.nn.TripletMarginLoss

参数:
  • anchor (Tensor) - 从训练集随机选取的样本。数据类型为BasicType。

  • positive (Tensor) - 与 anchor 为同一类的样本,数据类型与shape与 anchor 一致。

  • negative (Tensor) - 与 anchor 为异类的样本,数据类型与shape与 anchor 一致。

  • margin (float,可选) - 用于拉进 anchorpositive 之间的距离,拉远 anchornegative 之间的距离。默认值: 1.0

  • p (int,可选) - 成对距离的范数。默认值: 2

  • eps (float,可选) - 防止除数为 0。默认值: 1e-06

  • swap (bool,可选) - 距离交换。默认值: False

  • reduction (str,可选) - 指定要应用于输出的缩减方式,取值为 'mean''sum''none' 。默认值: 'mean'

返回:

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

异常:
  • TypeError - anchorpositive 或者 negative 不是Tensor。

  • TypeError - anchorpositive 或者 negative 的数据类型不一致。

  • TypeError - margin 的数据类型不是float。

  • TypeError - p 的数据类型不是int。

  • TypeError - eps 的数据类型不是float。

  • TypeError - swap 的数据类型不是bool。

  • ValueError - anchorpositivenegative 的维度同时小于等于1。

  • ValueError - anchorpositivenegative 的维度大于等于8。

  • ValueError - anchorpositivenegative 三者之间的shape无法广播。

  • ValueError - reduction 不为”mean”、”sum”或”none”。

支持平台:

GPU

样例:

>>> anchor = 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)
>>> output = ops.triplet_margin_loss(anchor, positive, negative)
>>> print(output)
0.8881968