TripletMarginWithDistanceLoss#

class torch.nn.TripletMarginWithDistanceLoss(*, distance_function=None, margin=1.0, swap=False, reduction='mean')[source]#

创建了一个判别器，用于计算给定输入张量 $a$ 、 $p$ 和 $n$ （分别代表锚点、正例和负例）的三元组损失，以及一个用于计算锚点与正例之间关系（“正例距离”）和锚点与负例之间关系（“负例距离”）的非负实值函数（“距离函数”）。

未归一化的损失（即 reduction 设置为 'none'）可以描述为

\ell(a, p, n) = L = \{l_1,\dots,l_N\}^\top, \quad l_i = \max \{d(a_i, p_i) - d(a_i, n_i) + {\rm margin}, 0\}

其中 $N$ 是批次大小； $d$ 是一个非负的、实值函数，用于量化两个张卡的接近程度，称为 distance_function；并且 $margin$ 是一个非负的边距，表示正距离和负距离之间的最小差值，该差值是损失为 0 所必需的。输入张卡各有 $N$ 个元素，并且可以是距离函数可以处理的任何形状。

如果 reduction 不是 'none'（默认为 'mean'），则

\ell(x, y) = \begin{cases} \operatorname{mean}(L), & \text{if reduction} = \text{`mean';}\\ \operatorname{sum}(L), & \text{if reduction} = \text{`sum'.} \end{cases}

另见 TripletMarginLoss，它使用 $l_p$ 距离作为距离函数来计算输入张卡的 triplet loss。

参数

distance_function (Callable, optional) – 一个非负的、实值函数，用于量化两个张卡的接近程度。如果未指定，将使用 nn.PairwiseDistance。默认为 None
margin (float, optional) – 一个非负的边距，表示正距离和负距离之间的最小差值，该差值是损失为 0 所必需的。较大的边距会惩罚负样本相对于正样本不够远的情况。默认为 $1$ 。
swap (bool, optional) – 是否使用论文 Learning shallow convolutional feature descriptors with triplet losses 中描述的距离交换（V. Balntas, E. Riba 等）。如果为 True，并且正样本比锚点更接近负样本，则在损失计算中交换正样本和锚点。默认为 False。
reduction (str, optional) – 指定应用于输出的（可选）归约：'none' | 'mean' | 'sum'。 'none'：不应用归约，'mean'：输出的总和除以输出中的元素数量，'sum'：输出将被求和。默认为 'mean'

形状

输入： $(N, *)$ ，其中 $*$ 表示距离函数支持的任何其他维度。
输出：一个形状为 $(N)$ 的张量（如果 reduction 是 'none'），否则为标量。

示例

>>> # Initialize embeddings
>>> embedding = nn.Embedding(1000, 128)
>>> anchor_ids = torch.randint(0, 1000, (1,))
>>> positive_ids = torch.randint(0, 1000, (1,))
>>> negative_ids = torch.randint(0, 1000, (1,))
>>> anchor = embedding(anchor_ids)
>>> positive = embedding(positive_ids)
>>> negative = embedding(negative_ids)
>>>
>>> # Built-in Distance Function
>>> triplet_loss = \
>>>     nn.TripletMarginWithDistanceLoss(distance_function=nn.PairwiseDistance())
>>> output = triplet_loss(anchor, positive, negative)
>>> output.backward()
>>>
>>> # Custom Distance Function
>>> def l_infinity(x1, x2):
>>>     return torch.max(torch.abs(x1 - x2), dim=1).values
>>>
>>> triplet_loss = (
>>>     nn.TripletMarginWithDistanceLoss(distance_function=l_infinity, margin=1.5))
>>> output = triplet_loss(anchor, positive, negative)
>>> output.backward()
>>>
>>> # Custom Distance Function (Lambda)
>>> triplet_loss = (
>>>     nn.TripletMarginWithDistanceLoss(
>>>         distance_function=lambda x, y: 1.0 - F.cosine_similarity(x, y)))
>>> output = triplet_loss(anchor, positive, negative)
>>> output.backward()

参考: V. Balntas, et al.: Learning shallow convolutional feature descriptors with triplet losses: https://bmva-archive.org.uk/bmvc/2016/papers/paper119/index.html

TripletMarginWithDistanceLoss#

文档

教程

资源