EmbeddingLossFunction

class lightning_ir.loss.base.EmbeddingLossFunction[source]

Bases: LossFunction

Base class for loss functions that operate on embeddings.

__init__()

Methods

compute_loss(output)

Compute the loss based on the embeddings in the output.
abstract compute_loss(output: BiEncoderOutput) → torch.Tensor[source]

Compute the loss based on the embeddings in the output.

Parameters:

output (BiEncoderOutput) – The output from the model containing query and document embeddings.

Returns:

The computed loss.

Return type:

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