BiEncoderOutput

class lightning_ir.bi_encoder.bi_encoder_model.BiEncoderOutput(scores: Tensor | None = None, query_embeddings: BiEncoderEmbedding | None = None, doc_embeddings: BiEncoderEmbedding | None = None, similarity: Tensor | None = None)[source]

Bases: LightningIROutput

Dataclass containing the output of a bi-encoder model.

__init__(scores: Tensor | None = None, query_embeddings: BiEncoderEmbedding | None = None, doc_embeddings: BiEncoderEmbedding | None = None, similarity: Tensor | None = None) → None: Args:

Methods

__init__([scores, query_embeddings, ...])

Args:

Attributes

`doc_embeddings`	Document embeddings generated by the model.
`query_embeddings`	Query embeddings generated by the model.
`similarity`	Similarity scores between query and document embeddings.

doc_embeddings: BiEncoderEmbedding | None = None: Document embeddings generated by the model.

query_embeddings: BiEncoderEmbedding | None = None: Query embeddings generated by the model.

similarity: Tensor | None = None: Similarity scores between query and document embeddings.