PairwiseLossFunction

class lightning_ir.loss.base.PairwiseLossFunction[source]

Bases: ScoringLossFunction

Base class for pairwise loss functions.

__init__()

Methods

get_pairwise_idcs(targets)

Get pairwise indices for positive and negative samples based on targets.
abstract compute_loss(output: LightningIROutput, batch: TrainBatch) → torch.Tensor

Compute the loss based on the scores and targets in the output and batch.

Parameters:

  • output (LightningIROutput) – The output from the model containing scores.

  • batch (TrainBatch) – The training batch containing targets.

Returns:

The computed loss.

Return type:

torch.Tensor

get_pairwise_idcs(targets: Tensor) → Tuple[Tensor, ...][source]

Get pairwise indices for positive and negative samples based on targets.

Parameters:

targets (torch.Tensor) – The targets tensor containing relevance labels.

Returns:

Indices of positive and negative samples.

Return type:

Tuple[torch.Tensor, …]

process_scores(output: LightningIROutput) → torch.Tensor

Process the scores from the output.

Parameters:

output (LightningIROutput) – The output from the model.

Returns:

The scores tensor.

Return type:

torch.Tensor

process_targets(scores: torch.Tensor, batch: TrainBatch) → torch.Tensor

Process the targets from the batch.

Parameters:

  • scores (torch.Tensor) – The scores tensor.

  • batch (TrainBatch) – The training batch.

Returns:

The processed targets tensor.

Return type:

torch.Tensor