TrainBatch

class lightning_ir.data.data.TrainBatch(queries: Sequence[str], docs: Sequence[Sequence[str]], query_ids: Sequence[str] | None = None, doc_ids: Sequence[Sequence[str]] | None = None, qrels: List[Dict[str, int]] | None = None, targets: Tensor | None = None)

Bases: RankBatch

A batch of ranking data that combines multiple RankSample instances

queries

List of query texts.

Type:

Sequence[str]

docs

List of list of document texts.

Type:

Sequence[Sequence[str]]

query_ids

Optional list of query ids. Defaults to None.

Type:

Sequence[str] | None

doc_ids

Optional list of list of document ids. Defaults to None.

Type:

Sequence[Sequence[str]] | None

qrels

Optional list of dictionaries mapping document ids to relevance labels. Defaults to None.

Type:

List[Dict[str, int]] | None

targets

Optional list of target labels denoting the relevance of a document for the query. Defaults to None.

Type:

torch.Tensor | None

__init__(queries: Sequence[str], docs: Sequence[Sequence[str]], query_ids: Sequence[str] | None = None, doc_ids: Sequence[Sequence[str]] | None = None, qrels: List[Dict[str, int]] | None = None, targets: Tensor | None = None) → None

Methods

__init__(queries, docs[, query_ids, ...])

Attributes

targets
queries
docs