hc4_fa.py

"""
""" # TODO
try:
    import ir_datasets
except ImportError as e:
    raise ImportError('ir-datasets package missing; `pip install ir-datasets`')
import datasets

IRDS_ID = 'hc4/fa'
IRDS_ENTITY_TYPES = {'docs': {'doc_id': 'string', 'title': 'string', 'text': 'string', 'url': 'string', 'time': 'string', 'cc_file': 'string'}}

_CITATION = '@article{Lawrie2022HC4,\n  author = {Dawn Lawrie and James Mayfield and Douglas W. Oard and Eugene Yang},\n  title = {HC4: A New Suite of Test Collections for Ad Hoc CLIR},\n  booktitle = {{Advances in Information Retrieval. 44th European Conference on IR Research (ECIR 2022)},\n  year = {2022},\n  month = apr,\n  publisher = {Springer},\n  series = {Lecture Notes in Computer Science},\n  site = {Stavanger, Norway},\n  url = {https://arxiv.org/abs/2201.09992}\n}'

_DESCRIPTION = "" # TODO

class hc4_fa(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/hc4#hc4/fa",
            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)