TripletMarginLoss

class torch.nn.modules.loss.TripletMarginLoss(margin=1.0, p=2.0, eps=1e-06, swap=False, size_average=None, reduce=None, reduction='mean') [source]

Создаёт функцию потерь, вычисляющую триплетную функцию потерь для входных тензоров $x1$, $x2$, $x3$ и отступа со значением больше $0$. Эта функция используется для измерения относительного сходства между образцами. Триплет состоит из a, p и n (то есть соответственно anchor, positive examples и negative examples). Формы всех входных тензоров должны быть $(N, D)$.

Перестановка расстояний подробно описана в статье Обучение неглубоких дескрипторов свёрточных признаков с помощью триплетных функций потерь В. Балнтаса, Э. Рибы и др.

Функция потерь для каждого образца в мини-пакете имеет вид:

$$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; для численной устойчивости добавляется небольшая константа $\varepsilon$.

См. также TripletMarginWithDistanceLoss, которая вычисляет триплетную функцию потерь с отступом для входных тензоров, используя пользовательскую функцию расстояния.

Параметры:

• margin (float, необязательно) – Значение по умолчанию: $1$.
• p (int, необязательно) – Порядок нормы для попарного расстояния. Значение по умолчанию: $2$.
• eps (float, необязательно) – Небольшая константа для численной устойчивости. Значение по умолчанию: $1e-6$.
• swap (bool, необязательно) – Перестановка расстояний подробно описана в статье Learning shallow convolutional feature descriptors with triplet losses В. Балнтаса, Э. Рибы и др. Значение по умолчанию: False.
• size_average (bool, необязательно) – Устарело (см. reduction). По умолчанию значения потерь усредняются по каждому элементу потерь в пакете. Обратите внимание, что для некоторых функций потерь на образец приходится несколько элементов. Если для поля size_average задано значение False, вместо этого потери суммируются для каждого мини-пакета. Игнорируется, если reduce равно False. Значение по умолчанию: True
• reduce (bool, необязательно) – Устарело (см. reduction). По умолчанию значения потерь усредняются или суммируются по наблюдениям для каждого мини-пакета в зависимости от size_average. Если reduce равно False, вместо этого возвращается значение потерь для каждого элемента пакета, а size_average игнорируется. Значение по умолчанию: True
• reduction (str, необязательно) – Определяет способ сведения выходных данных: 'none' | 'mean' | 'sum'. 'none': сведение не выполняется, 'mean': сумма выходных данных делится на количество элементов в выходных данных, 'sum': выходные данные суммируются. Примечание: size_average и reduce постепенно выводятся из употребления; пока что указание любого из этих аргументов переопределяет reduction. Значение по умолчанию: 'mean'

Форма:

• Входные данные: $(N, D)$ или $(D)$, где $D$ — размерность вектора.
• Выходные данные: тензор формы $(N)$, если reduction равно 'none' и форма входных данных — $(N, D)$; в противном случае — скаляр.

Примеры:

>>> triplet_loss = nn.TripletMarginLoss(margin=1.0, p=2, eps=1e-7)
>>> anchor = torch.randn(100, 128, requires_grad=True)
>>> positive = torch.randn(100, 128, requires_grad=True)
>>> negative = torch.randn(100, 128, requires_grad=True)
>>> output = triplet_loss(anchor, positive, negative)
>>> output.backward()

forward(anchor, positive, negative) [source]

Выполняет прямой проход.

Тип возвращаемого значения:

Tensor