BiEncoderOutput

class lightning_ir.bi_encoder.model.BiEncoderOutput(scores: Tensor | None = None, query_embeddings: BiEncoderEmbedding | None = None, doc_embeddings: BiEncoderEmbedding | 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) → None

Methods

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

clear()

copy()

fromkeys(iterable[, value])

Create a new ordered dictionary with keys from iterable and values set to value.

get(key[, default])

Return the value for key if key is in the dictionary, else default.

items

keys

move_to_end(key[, last])

Move an existing element to the end (or beginning if last is false).

pop(*args, **kwargs)

popitem([last])

Remove and return a (key, value) pair from the dictionary.

setdefault(*args, **kwargs)

to_tuple()

Convert self to a tuple containing all the attributes/keys that are not None.

update(*args, **kwargs)

values

Attributes

doc_embeddings

Document embeddings and scoring_mask generated by the model.

query_embeddings

Query embeddings and scoring_mask generated by the model.

scores

clear() → None.  Remove all items from od.
copy() → a shallow copy of od
doc_embeddings: BiEncoderEmbedding | None = None

Document embeddings and scoring_mask generated by the model.

classmethod fromkeys(iterable, value=None)

Create a new ordered dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

move_to_end(key, last=True)

Move an existing element to the end (or beginning if last is false).

Raise KeyError if the element does not exist.

popitem(last=True)

Remove and return a (key, value) pair from the dictionary.

Pairs are returned in LIFO order if last is true or FIFO order if false.

query_embeddings: BiEncoderEmbedding | None = None

Query embeddings and scoring_mask generated by the model.

to_tuple() → Tuple[Any]

Convert self to a tuple containing all the attributes/keys that are not None.