CoilEmbedding

class lightning_ir.models.bi_encoders.coil.CoilEmbedding(embeddings: Tensor, scoring_mask: Tensor | None = None, encoding: BatchEncoding | None = None, ids: List[str] | None = None, token_embeddings: Tensor | None = None, cls_embeddings: Tensor | None = None)[source]

Bases: BiEncoderEmbedding

Dataclass containing embeddings and the encoding for COIL models.

__init__(embeddings: Tensor, scoring_mask: Tensor | None = None, encoding: BatchEncoding | None = None, ids: List[str] | None = None, token_embeddings: Tensor | None = None, cls_embeddings: Tensor | None = None) → None

Methods

__init__(embeddings[, scoring_mask, ...])

Attributes

`cls_embeddings`	Separate [CLS] token embeddings.
`token_embeddings`	Token embeddings of the COIL model.
`embeddings`	Raw embeddings of the COIL model.

cls_embeddings: Tensor | None = None: Separate [CLS] token embeddings.

embeddings: Tensor: Raw embeddings of the COIL model. Should not be used directly for scoring.

token_embeddings: Tensor | None = None: Token embeddings of the COIL model.