commit files to HF hub

README.md

@@ -0,0 +1,56 @@
+---
+pretty_name: '`codec`'
+viewer: false
+source_datasets: []
+task_categories:
+- text-retrieval
+---
+
+# Dataset Card for `codec`
+
+The `codec` dataset, provided by the [ir-datasets](https://ir-datasets.com/) package.
+For more information about the dataset, see the [documentation](https://ir-datasets.com/codec#codec).
+
+# Data
+
+This dataset provides:
+ - `docs` (documents, i.e., the corpus); count=729,824
+ - `queries` (i.e., topics); count=42
+ - `qrels`: (relevance assessments); count=6,186
+
+
+This dataset is used by: [`codec_economics`](https://huggingface.co/datasets/irds/codec_economics), [`codec_history`](https://huggingface.co/datasets/irds/codec_history), [`codec_politics`](https://huggingface.co/datasets/irds/codec_politics)
+
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+docs = load_dataset('irds/codec', 'docs')
+for record in docs:
+    record # {'doc_id': ..., 'title': ..., 'text': ..., 'url': ...}
+
+queries = load_dataset('irds/codec', 'queries')
+for record in queries:
+    record # {'query_id': ..., 'query': ..., 'domain': ..., 'guidelines': ...}
+
+qrels = load_dataset('irds/codec', 'qrels')
+for record in qrels:
+    record # {'query_id': ..., 'doc_id': ..., 'relevance': ..., 'iteration': ...}
+
+```
+
+Note that calling `load_dataset` will download the dataset (or provide access instructions when it's not public) and make a copy of the
+data in 🤗 Dataset format.
+
+## Citation Information
+
+```
+@inproceedings{mackie2022codec,
+   title={CODEC: Complex Document and Entity Collection},
+   author={Mackie, Iain and Owoicho, Paul and Gemmell, Carlos and Fischer, Sophie and MacAvaney, Sean and Dalton, Jeffery},
+   booktitle={Proceedings of the 45th International ACM SIGIR Conference on Research and Development in Information Retrieval},
+   year={2022}
+}
+```

codec.py

@@ -0,0 +1,43 @@
+
+"""
+""" # TODO
+try:
+    import ir_datasets
+except ImportError as e:
+    raise ImportError('ir-datasets package missing; `pip install ir-datasets`')
+import datasets
+
+IRDS_ID = 'codec'
+IRDS_ENTITY_TYPES = {'docs': {'doc_id': 'string', 'title': 'string', 'text': 'string', 'url': 'string'}, 'queries': {'query_id': 'string', 'query': 'string', 'domain': 'string', 'guidelines': 'string'}, 'qrels': {'query_id': 'string', 'doc_id': 'string', 'relevance': 'int64', 'iteration': 'string'}}
+
+_CITATION = '@inproceedings{mackie2022codec,\n   title={CODEC: Complex Document and Entity Collection},\n   author={Mackie, Iain and Owoicho, Paul and Gemmell, Carlos and Fischer, Sophie and MacAvaney, Sean and Dalton, Jeffery},\n   booktitle={Proceedings of the 45th International ACM SIGIR Conference on Research and Development in Information Retrieval},\n   year={2022}\n}'
+
+_DESCRIPTION = "" # TODO
+
+class codec(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/codec#codec",
+            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)