wikir_en1k / wikir_en1k.py
Sean MacAvaney
commit files to HF hub
34faf26
"""
""" # TODO
try:
import ir_datasets
except ImportError as e:
raise ImportError('ir-datasets package missing; `pip install ir-datasets`')
import datasets
IRDS_ID = 'wikir/en1k'
IRDS_ENTITY_TYPES = {'docs': {'doc_id': 'string', 'text': 'string'}}
_CITATION = '@inproceedings{Frej2020Wikir,\n title={WIKIR: A Python toolkit for building a large-scale Wikipedia-based English Information Retrieval Dataset},\n author={Jibril Frej and Didier Schwab and Jean-Pierre Chevallet},\n booktitle={LREC},\n year={2020}\n}\n@inproceedings{Frej2020MlWikir,\n title={MLWIKIR: A Python Toolkit for Building Large-scale Wikipedia-based Information Retrieval Datasets in Chinese, English, French, Italian, Japanese, Spanish and More},\n author={Jibril Frej and Didier Schwab and Jean-Pierre Chevallet},\n booktitle={CIRCLE},\n year={2020}\n}'
_DESCRIPTION = "" # TODO
class wikir_en1k(datasets.GeneratorBasedBuilder):
BUILDER_CONFIGS = [datasets.BuilderConfig(name=e) for e in IRDS_ENTITY_TYPES]
def _info(self):
return datasets.DatasetInfo(
description=_DESCRIPTION,
features=datasets.Features({k: datasets.Value(v) for k, v in IRDS_ENTITY_TYPES[self.config.name].items()}),
homepage=f"https://ir-datasets.com/wikir#wikir/en1k",
citation=_CITATION,
)
def _split_generators(self, dl_manager):
return [datasets.SplitGenerator(name=self.config.name)]
def _generate_examples(self):
dataset = ir_datasets.load(IRDS_ID)
for i, item in enumerate(getattr(dataset, self.config.name)):
key = i
if self.config.name == 'docs':
key = item.doc_id
elif self.config.name == 'queries':
key = item.query_id
yield key, item._asdict()
def as_dataset(self, split=None, *args, **kwargs):
split = self.config.name # always return split corresponding with this config to avid returning a redundant DatasetDict layer
return super().as_dataset(split, *args, **kwargs)