Sean MacAvaney commited on
Commit
be5b8c5
1 Parent(s): 63dcddb

commit files to HF hub

Browse files
Files changed (2) hide show
  1. README.md +68 -0
  2. beir_fever.py +43 -0
README.md ADDED
@@ -0,0 +1,68 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ pretty_name: '`beir/fever`'
3
+ viewer: false
4
+ source_datasets: []
5
+ task_categories:
6
+ - text-retrieval
7
+ ---
8
+
9
+ # Dataset Card for `beir/fever`
10
+
11
+ The `beir/fever` dataset, provided by the [ir-datasets](https://ir-datasets.com/) package.
12
+ For more information about the dataset, see the [documentation](https://ir-datasets.com/beir#beir/fever).
13
+
14
+ # Data
15
+
16
+ This dataset provides:
17
+ - `docs` (documents, i.e., the corpus); count=5,416,568
18
+ - `queries` (i.e., topics); count=123,142
19
+
20
+
21
+ This dataset is used by: [`beir_fever_dev`](https://huggingface.co/datasets/irds/beir_fever_dev), [`beir_fever_test`](https://huggingface.co/datasets/irds/beir_fever_test), [`beir_fever_train`](https://huggingface.co/datasets/irds/beir_fever_train)
22
+
23
+
24
+ ## Usage
25
+
26
+ ```python
27
+ from datasets import load_dataset
28
+
29
+ docs = load_dataset('irds/beir_fever', 'docs')
30
+ for record in docs:
31
+ record # {'doc_id': ..., 'text': ..., 'title': ...}
32
+
33
+ queries = load_dataset('irds/beir_fever', 'queries')
34
+ for record in queries:
35
+ record # {'query_id': ..., 'text': ...}
36
+
37
+ ```
38
+
39
+ Note that calling `load_dataset` will download the dataset (or provide access instructions when it's not public) and make a copy of the
40
+ data in 🤗 Dataset format.
41
+
42
+ ## Citation Information
43
+
44
+ ```
45
+ @inproceedings{Thorne2018Fever,
46
+ title = "{FEVER}: a Large-scale Dataset for Fact Extraction and {VER}ification",
47
+ author = "Thorne, James and
48
+ Vlachos, Andreas and
49
+ Christodoulopoulos, Christos and
50
+ Mittal, Arpit",
51
+ booktitle = "Proceedings of the 2018 Conference of the North {A}merican Chapter of the Association for Computational Linguistics: Human Language Technologies, Volume 1 (Long Papers)",
52
+ month = jun,
53
+ year = "2018",
54
+ address = "New Orleans, Louisiana",
55
+ publisher = "Association for Computational Linguistics",
56
+ url = "https://www.aclweb.org/anthology/N18-1074",
57
+ doi = "10.18653/v1/N18-1074",
58
+ pages = "809--819"
59
+ }
60
+ @article{Thakur2021Beir,
61
+ title = "BEIR: A Heterogenous Benchmark for Zero-shot Evaluation of Information Retrieval Models",
62
+ author = "Thakur, Nandan and Reimers, Nils and Rücklé, Andreas and Srivastava, Abhishek and Gurevych, Iryna",
63
+ journal= "arXiv preprint arXiv:2104.08663",
64
+ month = "4",
65
+ year = "2021",
66
+ url = "https://arxiv.org/abs/2104.08663",
67
+ }
68
+ ```
beir_fever.py ADDED
@@ -0,0 +1,43 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+ """
3
+ """ # TODO
4
+ try:
5
+ import ir_datasets
6
+ except ImportError as e:
7
+ raise ImportError('ir-datasets package missing; `pip install ir-datasets`')
8
+ import datasets
9
+
10
+ IRDS_ID = 'beir/fever'
11
+ IRDS_ENTITY_TYPES = {'docs': {'doc_id': 'string', 'text': 'string', 'title': 'string'}, 'queries': {'query_id': 'string', 'text': 'string'}}
12
+
13
+ _CITATION = '@inproceedings{Thorne2018Fever,\n title = "{FEVER}: a Large-scale Dataset for Fact Extraction and {VER}ification",\n author = "Thorne, James and\n Vlachos, Andreas and\n Christodoulopoulos, Christos and\n Mittal, Arpit",\n booktitle = "Proceedings of the 2018 Conference of the North {A}merican Chapter of the Association for Computational Linguistics: Human Language Technologies, Volume 1 (Long Papers)",\n month = jun,\n year = "2018",\n address = "New Orleans, Louisiana",\n publisher = "Association for Computational Linguistics",\n url = "https://www.aclweb.org/anthology/N18-1074",\n doi = "10.18653/v1/N18-1074",\n pages = "809--819"\n}\n@article{Thakur2021Beir,\n title = "BEIR: A Heterogenous Benchmark for Zero-shot Evaluation of Information Retrieval Models",\n author = "Thakur, Nandan and Reimers, Nils and Rücklé, Andreas and Srivastava, Abhishek and Gurevych, Iryna", \n journal= "arXiv preprint arXiv:2104.08663",\n month = "4",\n year = "2021",\n url = "https://arxiv.org/abs/2104.08663",\n}'
14
+
15
+ _DESCRIPTION = "" # TODO
16
+
17
+ class beir_fever(datasets.GeneratorBasedBuilder):
18
+ BUILDER_CONFIGS = [datasets.BuilderConfig(name=e) for e in IRDS_ENTITY_TYPES]
19
+
20
+ def _info(self):
21
+ return datasets.DatasetInfo(
22
+ description=_DESCRIPTION,
23
+ features=datasets.Features({k: datasets.Value(v) for k, v in IRDS_ENTITY_TYPES[self.config.name].items()}),
24
+ homepage=f"https://ir-datasets.com/beir#beir/fever",
25
+ citation=_CITATION,
26
+ )
27
+
28
+ def _split_generators(self, dl_manager):
29
+ return [datasets.SplitGenerator(name=self.config.name)]
30
+
31
+ def _generate_examples(self):
32
+ dataset = ir_datasets.load(IRDS_ID)
33
+ for i, item in enumerate(getattr(dataset, self.config.name)):
34
+ key = i
35
+ if self.config.name == 'docs':
36
+ key = item.doc_id
37
+ elif self.config.name == 'queries':
38
+ key = item.query_id
39
+ yield key, item._asdict()
40
+
41
+ def as_dataset(self, split=None, *args, **kwargs):
42
+ split = self.config.name # always return split corresponding with this config to avid returning a redundant DatasetDict layer
43
+ return super().as_dataset(split, *args, **kwargs)