fixed readme

neuclir-2022.py

@@ -1,20 +1,3 @@
-# coding=utf-8
-# Copyright 2020 The HuggingFace Datasets Authors and the current dataset script contributor.
-#
-# Licensed under the Apache License, Version 2.0 (the 'License');
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an 'AS IS' BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Lint as: python3
-
 import json
 
 import datasets
@@ -38,13 +21,19 @@ _DESCRIPTION = 'dataset load script for NeuCLIR 2022'
 
 _DATASET_URLS = {
     lang: {
-        'test': f'https://huggingface.co/datasets/MTEB/neuclir-2022/resolve/main/neuclir-{lang}/queries.jsonl.gz',
+        'test': f'https://huggingface.co/datasets/MTEB/neuclir-2022/resolve/main/neuclir-{lang}/test.jsonl',
     } for lang in _LANGUAGES
 }
 
 _DATASET_CORPUS_URLS = {
     f'corpus-{lang}': {
-        'corpus': f'https://huggingface.co/datasets/MTEB/neuclir-2022/resolve/main/neuclir-{lang}/corpus.jsonl.gz'
+        'corpus': f'https://huggingface.co/datasets/MTEB/neuclir-2022/resolve/main/neuclir-{lang}/corpus.jsonl'
+    } for lang in _LANGUAGES
+}
+
+_DATASET_QUERIES_URLS = {
+    f'queries-{lang}': {
+        'queries': f'https://huggingface.co/datasets/MTEB/neuclir-2022/resolve/main/neuclir-{lang}/queries.jsonl'
     } for lang in _LANGUAGES
 }
 
@@ -52,12 +41,17 @@ _DATASET_CORPUS_URLS = {
 class MLDR(datasets.GeneratorBasedBuilder):
     BUILDER_CONFIGS = [datasets.BuilderConfig(
             version=datasets.Version('1.0.0'),
-            name=lang, description=f'MLDR dataset in language {lang}.'
+            name=lang, description=f'NeuCLIR dataset in language {lang}.'
         ) for lang in _LANGUAGES
     ] + [
         datasets.BuilderConfig(
             version=datasets.Version('1.0.0'),
-            name=f'corpus-{lang}', description=f'corpus of MLDR dataset in language {lang}.'
+            name=f'corpus-{lang}', description=f'corpus of NeuCLIR dataset in language {lang}.'
+        ) for lang in _LANGUAGES
+    ] + [ 
+        datasets.BuilderConfig(
+            version=datasets.Version('1.0.0'),
+            name=f'queries-{lang}', description=f'queries of NeuCLIR dataset in language {lang}.'
         ) for lang in _LANGUAGES
     ]
 
@@ -68,10 +62,16 @@ class MLDR(datasets.GeneratorBasedBuilder):
                 '_id': datasets.Value('string'),
                 'text': datasets.Value('string'),
             })
-        else:
+        elif name.startswith("queries-"):
             features = datasets.Features({
                 '_id': datasets.Value('string'),
-                'query': datasets.Value('string'),
+                'text': datasets.Value('string'),
+            })
+        else:
+            features = datasets.Features({
+                'query-id': datasets.Value('string'),
+                'corpus-id': datasets.Value('string'),
+                'score': datasets.Value('int32'),
             })
 
         return datasets.DatasetInfo(
@@ -81,9 +81,9 @@ class MLDR(datasets.GeneratorBasedBuilder):
             features=features,  # Here we define them above because they are different between the two configurations
             supervised_keys=None,
             # Homepage of the dataset for documentation
-            homepage='https://github.com/FlagOpen/FlagEmbedding',
+            homepage='https://arxiv.org/abs/2304.12367',
             # License for the dataset if available
-            license='mit',
+            license=None,
             # Citation for the dataset
             citation=_CITATION,
         )
@@ -100,6 +100,16 @@ class MLDR(datasets.GeneratorBasedBuilder):
                     },
                 ),
             ]
+        elif name.startswith("queries-"):
+            downloaded_files = dl_manager.download_and_extract(_DATASET_QUERIES_URLS[name])
+            splits = [
+                datasets.SplitGenerator(
+                    name='queries',
+                    gen_kwargs={
+                        'filepath': downloaded_files['queries'],
+                    },
+                ),
+            ]
         else:
             downloaded_files = dl_manager.download_and_extract(_DATASET_URLS[name])
             splits = [
@@ -118,10 +128,18 @@ class MLDR(datasets.GeneratorBasedBuilder):
             with open(filepath, encoding='utf-8') as f:
                 for line in f:
                     data = json.loads(line)
-                    yield data['docid'], data
+                    yield data['_id'], data
+        elif name.startswith("queries-"):
+            with open(filepath, encoding="utf-8") as f:
+                for line in f:
+                    data = json.loads(line)
+                    qid = data['_id']
+                    yield qid, data
         else:
             with open(filepath, encoding="utf-8") as f:
                 for line in f:
                     data = json.loads(line)
-                    qid = data['query_id']
-                    yield qid, data
+                    qid = data['query-id']
+                    pid = data['corpus-id']
+                    yield qid + "-----" + pid, data
+