QuerySample

class lightning_ir.data.data.QuerySample(query_id: str, query: str, qrels: List[Dict[str, Any]] | None = None)[source]

Bases: object

A sample of query data containing a query and its id.

Parameters:

  • query_id (str) – Id of the query

  • query – Query text

  • qrels (List[Dict[str, Any]], optional) – Optional list of dictionaries mapping document ids to relevance labels

__init__(query_id: str, query: str, qrels: List[Dict[str, Any]] | None = None) → None

Methods

__init__(query_id, query[, qrels])

from_ir_dataset_sample(sample)

Create a QuerySample from a an ir_datasets sample.

Attributes

qrels

query_id

query

classmethod from_ir_dataset_sample(sample: GenericQuery) → QuerySample[source]

Create a QuerySample from a an ir_datasets sample.

Parameters:

sample (GenericQuery) – ir_datasets sample

Returns:

Query sample

Return type:

QuerySample