Skip to content

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

Open
@KevinMusgrave

Description

@KevinMusgrave

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions