Skip to content

Commit

Permalink
Edit loss docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
domenicoMuscill0 committed Aug 27, 2023
1 parent 6638b0a commit 9805fbe
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions src/pytorch_metric_learning/losses/ranked_list_loss.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@


class RankedListLoss(BaseMetricLossFunction):
"""Ranked List Loss described in https://arxiv.org/abs/1903.03238
r"""Ranked List Loss described in https://arxiv.org/abs/1903.03238
Default parameters correspond to RLL-Simpler, preferred for exploratory analysis.
Args:
margin (float): _
imbalance (float): _
alpha (float): _
Tp & Tn (float): temperatures for, respectively, positive and negative pairs weighting
* margin (float): margin between positive and negative set
* imbalance (float): tradeoff between positive and negative sets. As the name suggests this takes into account
the imbalance between positive and negative samples in the dataset
* alpha (float): smallest distance between negative points
* Tp & Tn (float): temperatures for, respectively, positive and negative pairs weighting
"""
def __init__(self, margin, Tn, imbalance=0.5, alpha = None, Tp = 0, **kwargs):
super().__init__(**kwargs)
Expand Down

0 comments on commit 9805fbe

Please sign in to comment.