Update germandpr-beir.py

germandpr-beir.py

@@ -1,4 +1,5 @@
 import json
+import os.path
 
 import datasets
 
@@ -6,67 +7,73 @@ import datasets
 _VERSION = "1.0.0"
 
 _DESCRIPTION = "Deepset's germanDPR dataset made compatible with BEIR benchmark framework. One version contains " \
-               "the original dataset 1:1 and the other dataset is preprocessed. See official dataset card for " \
-               "usage of dataset with BEIR."
+               "the original dataset 1:1 (but deduplicated) and the other dataset is furhter preprocessed. " \
+               "See official dataset card for dataset usage with BEIR."
 
-_SUBSETS = ["queries-original", "corpus-original", "queries-processed", "corpus-processed", "qrels"]
+_SUBSETS = ["original-queries", "original-corpus", "original-qrels",
+            "processed-queries", "processed-corpus", "original-qrels"]
 
 
 class GermanDPRBeir(datasets.GeneratorBasedBuilder):
     BUILDER_CONFIGS = (
         [
             datasets.BuilderConfig(
-                name="queries-original",
-                description=f"BEIR queries created 1:1 from deepset/germanDPR.",
+                name="original-queries",
+                description=f"BEIR queries created 1:1 but deduplicated from deepset/germanDPR.",
                 version=_VERSION,
             ),
             datasets.BuilderConfig(
-                name="corpus-original",
-                description=f"BEIR corpus created 1:1 from deepset/germanDPR.",
+                name="original-corpus",
+                description=f"BEIR corpus created 1:1 but deduplicated from deepset/germanDPR.",
                 version=_VERSION,
             ),
             datasets.BuilderConfig(
-                name="queries-processed",
-                description=f"BEIR queries created and further text-processed from deepset/germanDPR.",
+                name="original-qrels",
+                description=f"BEIR qrels for original version of deepset/germanDPR.",
                 version=_VERSION,
             ),
             datasets.BuilderConfig(
-                name="corpus-processed",
-                description=f"BEIR corpus created and further text-processed from deepset/germanDPR.",
+                name="processed-queries",
+                description=f"BEIR queries created, deduplicated and further text-processed from deepset/germanDPR.",
                 version=_VERSION,
             ),
             datasets.BuilderConfig(
-                name="qrels",
-                description=f"BEIR qrels created from deepset/germanDPR for train and test split.",
+                name="processed-corpus",
+                description=f"BEIR corpus created, deduplicated and further text-processed from deepset/germanDPR.",
+                version=_VERSION,
+            ),
+            datasets.BuilderConfig(
+                name="processed-qrels",
+                description=f"BEIR qrels for processed version of deepset/germanDPR.",
                 version=_VERSION,
             )
         ]
     )
 
-    DEFAULT_CONFIG_NAME = "qrels"
+    DEFAULT_CONFIG_NAME = _SUBSETS[0]
 
     def _info(self):
         name = self.config.name
-        _SPLITS = ["queries-original", "corpus-original", "queries-processed", "corpus-processed", "qrels"]
-
-        if name.startswith("queries"):
+        if name.endswith("queries"):
             features = {
                 "_id": datasets.Value("string"),
                 "text": datasets.Value("string")
             }
-        elif name.startswith("corpus"):
+        elif name.endswith("corpus"):
             features = {
                 "_id": datasets.Value("string"),
                 "title": datasets.Value("string"),
                 "text": datasets.Value("string"),
             }
-        else:
+        elif name.endswith("qrels"):
             # name == qrels
             features = {
                 "query-id": datasets.Value("string"),
                 "corpus-id": datasets.Value("string"),
                 "score": datasets.Value("int32")
             }
+        else:
+            raise ValueError(f'Unknown subset, choose from: {", ".join(_SUBSETS)}')
 
         return datasets.DatasetInfo(
             description=f"{_DESCRIPTION}\n{self.config.description}",
@@ -77,26 +84,38 @@ class GermanDPRBeir(datasets.GeneratorBasedBuilder):
 
     def _split_generators(self, dl_manager):
         """Returns SplitGenerators."""
-        _SPLITS = ["queries-original", "corpus-original", "queries-processed", "corpus-processed", "qrels"]
-
         name = self.config.name
-        if name == "qrels":
-            dl_path = dl_manager.download([
-                "https://huggingface.co/datasets/PM-AI/germandpr-beir/resolve/main/data/qrels/train.tsv",
-                "https://huggingface.co/datasets/PM-AI/germandpr-beir/resolve/main/data/qrels/test.tsv"
-            ])
+        if name.startswith("original"):
+            dl_path = dl_manager.download_and_extract("https://huggingface.co/datasets/PM-AI/germandpr-beir/resolve/main/data/original.tar.gz")
+        elif name.startswith("processed"):
+            dl_path = dl_manager.download_and_extract("https://huggingface.co/datasets/PM-AI/germandpr-beir/resolve/main/data/processed.tar.gz")
+        else:
+            raise ValueError(f'Unknown subset, choose from: {", ".join(_SUBSETS)}')
+
+        type1, type2 = name.split("-")
+        if type2 in ["corpus", "queries"]:
             return [
-                datasets.SplitGenerator(name=datasets.Split.TRAIN, gen_kwargs={"filepath": dl_path[0]}),
-                datasets.SplitGenerator(name=datasets.Split.TEST, gen_kwargs={"filepath": dl_path[1]})
+                datasets.SplitGenerator(
+                    name=datasets.Split.TRAIN,
+                    gen_kwargs={"filepath": os.path.join(dl_path, f'{type1}/train/{type2}.jsonl')}),
+                datasets.SplitGenerator(
+                    name=datasets.Split.TEST,
+                    gen_kwargs={"filepath": os.path.join(dl_path, f'{type1}/test/{type2}.jsonl')})
             ]
-        else:
-            dl_path = dl_manager.download(f"https://huggingface.co/datasets/PM-AI/germandpr-beir/resolve/main/data/{name}.jsonl")
+        elif type2 == "qrels":
             return [
-                datasets.SplitGenerator(name=datasets.Split.TRAIN, gen_kwargs={"filepath": dl_path}),
-                datasets.SplitGenerator(name=datasets.Split.TEST, gen_kwargs={"filepath": dl_path})
+                datasets.SplitGenerator(
+                    name=datasets.Split.TRAIN,
+                    gen_kwargs={"filepath": os.path.join(dl_path, f'{type1}/train/qrels/train.tsv')}),
+                datasets.SplitGenerator(
+                    name=datasets.Split.TEST,
+                    gen_kwargs={"filepath": os.path.join(dl_path, f'{type1}/test/qrels/test.tsv')})
             ]
+        else:
+            raise ValueError(f'Unknown subset, choose from: {", ".join(_SUBSETS)}')
 
     def _generate_queries_data(self, filepath):
+        print("filepath: ", filepath)
         with open(filepath, "r", encoding="utf-8") as in_file:
             for idx, line in enumerate(in_file):
                 data = json.loads(line)
@@ -120,10 +139,11 @@ class GermanDPRBeir(datasets.GeneratorBasedBuilder):
     def _generate_examples(self, filepath):
         """Yields examples."""
         name = self.config.name
-        if name.startswith("queries"):
+        if name.endswith("queries"):
             return self._generate_queries_data(filepath)
-        elif name.startswith("corpus"):
+        elif name.endswith("corpus"):
             return self._generate_corpus_data(filepath)
-        else:
-            # name == qrels
+        elif name.endswith("qrels"):
             return self._generate_qrel_data(filepath)
+        else:
+            raise ValueError(f'Unknown subset, choose from: {", ".join(_SUBSETS)}')