UniCoilModel

class lightning_ir.models.bi_encoders.coil.UniCoilModel(config: UniCoilConfig, *args, **kwargs)[source]

Bases: SingleVectorBiEncoderModel

Single-vector UniCOIL model. See UniCoilConfig for configuration options.

__init__(config: UniCoilConfig, *args, **kwargs) → None[source]

Initializes a UniCOIL model given a UniCoilConfig configuration.

Parameters:

config (UniCoilConfig) – Configuration for the UniCOIL model.

Methods

__init__(config, *args, **kwargs)

Initializes a UniCOIL model given a UniCoilConfig configuration.

encode(encoding, input_type)

Encodes a batched tokenized text sequences and returns the embeddings and scoring mask.

Attributes

training

config_class

Configuration class for UniCOIL models.

alias of UniCoilConfig

encode(encoding: BatchEncoding, input_type: 'query' | 'doc') → BiEncoderEmbedding[source]

Encodes a batched tokenized text sequences and returns the embeddings and scoring mask.

Parameters:

  • encoding (BatchEncoding) – Tokenizer encodings for the text sequence.

  • input_type (Literal["query", "doc"]) – Type of input, either “query” or “doc”.

Returns:

Embeddings and scoring mask.

Return type:

BiEncoderEmbedding