QueryDataset

class lightning_ir.data.dataset.QueryDataset(query_dataset: str, num_queries: int | None = None)

Bases: IRDataset, _DataParallelIterableDataset

__init__(query_dataset: str, num_queries: int | None = None) → None

Dataset containing queries.

Parameters:

• query_dataset (str) – Path to file containing queries or valid ir_datasets id.

• num_queries (int | None, optional) – Number of queries in dataset. If None, the number of queries will attempted to be inferred. Defaults to None.

Methods

__init__(query_dataset[, num_queries])	Dataset containing queries.
prepare_data()	Downloads queries using ir_datasets if needed.

Attributes

property DASHED_DATASET_MAP: Dict[str, str]

Map of dataset names with dashes to dataset names with slashes.

Returns:

Dataset map.

Return type:

Dict[str, str]

property dataset: str

Dataset name.

Returns:

Dataset name.

Return type:

str

property dataset_id: str

Dataset id.

Returns:

Dataset id.

Return type:

str

property docs: Docstore | Dict[str, GenericDoc]

Documents in the dataset.

Returns:

Documents.

Return type:

ir_datasets.indices.Docstore | Dict[str, GenericDoc]

Raises:

ValueError – If no documents are found in the dataset.

property docs_dataset_id: str

ID of the dataset containing the documents.

Returns:

Document dataset id.

Return type:

str

property ir_dataset: Dataset | None

Instance of ir_datasets.Dataset.

Returns:

Instance of ir_datasets.Dataset or None if the dataset is not found.

Return type:

ir_datasets.Dataset | None

prepare_constituent(constituent: Literal['qrels', 'queries', 'docs', 'scoreddocs', 'docpairs']) → None

Downloads the constituent of the dataset using ir_datasets if needed.

Parameters:

constituent (Literal["qrels", "queries", "docs", "scoreddocs", "docpairs"]) – Constituent to download.

prepare_data() → None

Downloads queries using ir_datasets if needed.

property qrels: DataFrame | None

Qrels in the dataset.

Returns:

Qrels.

Return type:

pd.DataFrame | None

property queries: Series

Queries in the dataset.

Returns:

Queries.

Return type:

pd.Series

Raises:

ValueError – If no queries are found in the dataset.