pytorch-metric-learning icon indicating copy to clipboard operation
pytorch-metric-learning copied to clipboard

Add documentation about how mined tuples are used by each loss function

Open KevinMusgrave opened this issue 4 years ago • 0 comments

The docs should have the following type of explanation, plus a short note per loss function

  • If you pass pairs into a triplet loss, then triplets will be formed by combining each positive pair and negative pair that share the same anchor.
  • If you pass triplets into a pair loss, then pairs will be formed by splitting each triplet into two pairs
  • If you pass pairs or triplets into a classification loss, then each embedding's loss will be weighted by how frequently the embedding occurs in the pairs or triplets.

KevinMusgrave avatar Sep 19 '20 03:09 KevinMusgrave