MonoModel

class lightning_ir.models.cross_encoders.mono.MonoModel(config: MonoConfig, *args, **kwargs)[source]

Bases: CrossEncoderModel

__init__(config: MonoConfig, *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 (MonoConfig) – Configuration for the mono 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 mono cross-encoder models.

alias of MonoConfig

forward(encoding: BatchEncoding) CrossEncoderOutput[source]

Computes contextualized embeddings for the joint query-document input sequence and computes a relevance score.

Parameters:

encoding (BatchEncoding) – Tokenizer encodings for the joint query-document input sequence.

Returns:

Output of the model.

Return type:

CrossEncoderOutput