CrossEncoderModel
- class lightning_ir.cross_encoder.cross_encoder_model.CrossEncoderModel(config: CrossEncoderConfig, *args, **kwargs)[source]
Bases:
LightningIRModel,ABC- __init__(config: CrossEncoderConfig, *args, **kwargs)[source]
A cross-encoder model that jointly encodes a query and document(s). The contextualized embeddings are aggragated into a single vector and fed to a linear layer which computes a final relevance score.
- Parameters:
config (CrossEncoderConfig) – Configuration for the cross-encoder model.
Methods
__init__(config, *args, **kwargs)A cross-encoder model that jointly encodes a query and document(s).
forward(encoding)Computes contextualized embeddings for the joint query-document input sequence and computes a relevance score.
Attributes
training- config_class
Configuration class for cross-encoder models.
alias of
CrossEncoderConfig
- abstractmethod forward(encoding: BatchEncoding) CrossEncoderOutput[source]
Computes contextualized embeddings for the joint query-document input sequence and computes a relevance score.
- Parameters:
encoding (BatchEncoding) – Tokenizer encoding for the joint query-document input sequence.
- Returns:
Output of the model.
- Return type: