Sean MacAvaney commited on
Commit
e8c6115
·
1 Parent(s): 8592490

commit files to HF hub

Browse files
Files changed (2) hide show
  1. README.md +25 -7
  2. beir_arguana.py +0 -1
README.md CHANGED
@@ -1,27 +1,45 @@
1
  ---
2
  pretty_name: '`beir/arguana`'
3
  viewer: false
 
 
 
4
  ---
5
 
6
  # Dataset Card for `beir/arguana`
7
 
8
- The `beir/arguana` IR dataset, provided by the [ir-datasets](https://ir-datasets.com/) package.
 
9
 
10
- This dataset provides:
11
- - `docs` (documents, i.e., the corpus)
12
- - `queries` (i.e., topics)
13
- - `qrels`: (relevance assessments)
14
 
 
 
 
 
15
 
16
- Find more information about the dataset [here](https://ir-datasets.com/{dsid.split('/')[0]}#{dsid}).
17
 
18
  ## Usage
19
 
20
  ```python
21
  from datasets import load_dataset
22
- dataset = load_dataset({repr("irds/"+hgf_id)})
 
 
 
 
 
 
 
 
 
 
 
 
23
  ```
24
 
 
 
25
 
26
  ## Citation Information
27
 
 
1
  ---
2
  pretty_name: '`beir/arguana`'
3
  viewer: false
4
+ source_datasets: []
5
+ task_categories:
6
+ - text-retrieval
7
  ---
8
 
9
  # Dataset Card for `beir/arguana`
10
 
11
+ The `beir/arguana` 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/arguana).
13
 
14
+ # Data
 
 
 
15
 
16
+ This dataset provides:
17
+ - `docs` (documents, i.e., the corpus); count=8,674
18
+ - `queries` (i.e., topics); count=1,406
19
+ - `qrels`: (relevance assessments); count=1,406
20
 
 
21
 
22
  ## Usage
23
 
24
  ```python
25
  from datasets import load_dataset
26
+
27
+ docs = load_dataset('irds/beir_arguana', 'docs')
28
+ for record in docs:
29
+ record # {'doc_id': ..., 'text': ..., 'title': ...}
30
+
31
+ queries = load_dataset('irds/beir_arguana', 'queries')
32
+ for record in queries:
33
+ record # {'query_id': ..., 'text': ...}
34
+
35
+ qrels = load_dataset('irds/beir_arguana', 'qrels')
36
+ for record in qrels:
37
+ record # {'query_id': ..., 'doc_id': ..., 'relevance': ..., 'iteration': ...}
38
+
39
  ```
40
 
41
+ Note that calling `load_dataset` will download the dataset (or provide access instructions when it's not public) and make a copy of the
42
+ data in 🤗 Dataset format.
43
 
44
  ## Citation Information
45
 
beir_arguana.py CHANGED
@@ -16,7 +16,6 @@ _DESCRIPTION = "" # TODO
16
 
17
  class beir_arguana(datasets.GeneratorBasedBuilder):
18
  BUILDER_CONFIGS = [datasets.BuilderConfig(name=e) for e in IRDS_ENTITY_TYPES]
19
- DEFAULT_CONFIG_NAME = list(IRDS_ENTITY_TYPES)[0]
20
 
21
  def _info(self):
22
  return datasets.DatasetInfo(
 
16
 
17
  class beir_arguana(datasets.GeneratorBasedBuilder):
18
  BUILDER_CONFIGS = [datasets.BuilderConfig(name=e) for e in IRDS_ENTITY_TYPES]
 
19
 
20
  def _info(self):
21
  return datasets.DatasetInfo(