RankSample

class lightning_ir.data.data.RankSample(query_id: str, query: str, doc_ids: Sequence[str], docs: Sequence[str], targets: Tensor | None = None, qrels: List[Dict[str, Any]] | None = None)

Bases: object

A sample of ranking data containing a query, a ranked list of documents, and optionally targets and qrels.

query_id

Id of the query.

Type:

str

query

Query text.

Type:

str

doc_ids

List of document ids.

Type:

Sequence[str]

docs

List of document texts.

Type:

Sequence[str]

targets

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

Type:

torch.Tensor

qrels

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

Type:

List[Dict[str, Any]]

__init__(query_id: str, query: str, doc_ids: Sequence[str], docs: Sequence[str], targets: Tensor | None = None, qrels: List[Dict[str, Any]] | None = None) → None

Methods

__init__(query_id, query, doc_ids, docs[, ...])

Attributes

qrels
targets
query_id
query
doc_ids
docs