besskge.loss.MarginRankingLoss

class besskge.loss.MarginRankingLoss(margin, negative_adversarial_sampling, negative_adversarial_scale=1.0, loss_scale=1.0, activation_function='relu')

The margin ranking (or pairwise hinge) loss function.

Initialize margin ranking loss function.

Parameters:

• margin (float) – see MarginBasedLossFunction.__init__()

• negative_adversarial_sampling (bool) – see BaseLossFunction

• negative_adversarial_scale (float) – see BaseLossFunction

• loss_scale (float) – see BaseLossFunction

• activation_function (str) – The activation function in loss computation. Default: “relu”.

forward(positive_score, negative_score, triple_weight)

Compute batch loss.

Parameters:

• positive_score (Tensor) – shape: (batch_size,) Scores of positive triples.

• negative_score (Tensor) – shape: (batch_size, n_negative) Scores of negative triples.

• triple_weight (Tensor) – shape: (batch_size,) or () Weights of positive triples.

Return type:

Tensor

Returns:

The batch loss.

get_negative_weights(negative_score)

Construct weights of negative samples, based on their score.

Parameters:

negative_score (Tensor) – : (batch_size, n_negative) Scores of negative samples.

Return type:

Tensor

Returns:

shape: (batch_size, n_negative) if BaseLossFunction.negative_adversarial_sampling else () Weights of negative samples.

loss_scale: Tensor

Loss scaling factor, might be needed when using FP16 weights

negative_adversarial_sampling: bool

Use self-adversarial weighting of negative samples.

negative_adversarial_scale: Tensor

Reciprocal temperature of self-adversarial weighting