Fix option to load private version of dataset

dataset_infos.json

@@ -1 +1 @@
-{"default": {"description": "SI-NLI (Slovene Natural Language Inference Dataset) contains 5,937 human-created Slovene sentence pairs \n(premise and hypothesis) that are manually labeled with the labels \"entailment\", \"contradiction\", and \"neutral\". \nThe dataset was created using sentences that appear in the Slovenian reference corpus ccKres. \nAnnotators were tasked to modify the hypothesis in a candidate pair in a way that reflects one of the labels. \nThe dataset is balanced since the annotators created three modifications (entailment, contradiction, neutral) \nfor each candidate sentence pair.\n", "citation": "@misc{sinli,\n    title = {Slovene Natural Language Inference Dataset {SI}-{NLI}},\n    author = {Klemen, Matej and {\u000b Z}agar, Ale{\u000b s} and {\u000b C}ibej, Jaka and Robnik-{\u000b S}ikonja, Marko},\n    url = {http://hdl.handle.net/11356/1707},\n    note = {Slovenian language resource repository {CLARIN}.{SI}},\n    year = {2022}\n}\n", "homepage": "http://hdl.handle.net/11356/1707", "license": "Creative Commons - Attribution 4.0 International (CC BY 4.0)", "features": {"pair_id": {"dtype": "string", "id": null, "_type": "Value"}, "premise": {"dtype": "string", "id": null, "_type": "Value"}, "hypothesis": {"dtype": "string", "id": null, "_type": "Value"}, "annotation1": {"dtype": "string", "id": null, "_type": "Value"}, "annotator1_id": {"dtype": "string", "id": null, "_type": "Value"}, "annotation2": {"dtype": "string", "id": null, "_type": "Value"}, "annotator2_id": {"dtype": "string", "id": null, "_type": "Value"}, "annotation3": {"dtype": "string", "id": null, "_type": "Value"}, "annotator3_id": {"dtype": "string", "id": null, "_type": "Value"}, "annotation_final": {"dtype": "string", "id": null, "_type": "Value"}, "label": {"dtype": "string", "id": null, "_type": "Value"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "si_nli", "config_name": "default", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 1352635, "num_examples": 4392, "dataset_name": "si_nli"}, "validation": {"name": "validation", "num_bytes": 164561, "num_examples": 547, "dataset_name": "si_nli"}, "test": {"name": "test", "num_bytes": 246518, "num_examples": 998, "dataset_name": "si_nli"}}, "download_checksums": {"https://www.clarin.si/repository/xmlui/bitstream/handle/11356/1707/SI-NLI.zip": {"num_bytes": 410093, "checksum": "e2b3be92049ebb68916a236465940880aeb002d148dce7df94b71e8779080274"}}, "download_size": 410093, "post_processing_size": null, "dataset_size": 1763714, "size_in_bytes": 2173807}}
+{"default": {"description": "SI-NLI (Slovene Natural Language Inference Dataset) contains 5,937 human-created Slovene sentence pairs \n(premise and hypothesis) that are manually labeled with the labels \"entailment\", \"contradiction\", and \"neutral\". \nThe dataset was created using sentences that appear in the Slovenian reference corpus ccKres. \nAnnotators were tasked to modify the hypothesis in a candidate pair in a way that reflects one of the labels. \nThe dataset is balanced since the annotators created three modifications (entailment, contradiction, neutral) \nfor each candidate sentence pair.\n", "citation": "@misc{sinli,\n    title = {Slovene Natural Language Inference Dataset {SI}-{NLI}},\n    author = {Klemen, Matej and {\u000b Z}agar, Ale{\u000b s} and {\u000b C}ibej, Jaka and Robnik-{\u000b S}ikonja, Marko},\n    url = {http://hdl.handle.net/11356/1707},\n    note = {Slovenian language resource repository {CLARIN}.{SI}},\n    year = {2022}\n}\n", "homepage": "http://hdl.handle.net/11356/1707", "license": "Creative Commons - Attribution 4.0 International (CC BY 4.0)", "features": {"pair_id": {"dtype": "string", "id": null, "_type": "Value"}, "premise": {"dtype": "string", "id": null, "_type": "Value"}, "hypothesis": {"dtype": "string", "id": null, "_type": "Value"}, "annotation1": {"dtype": "string", "id": null, "_type": "Value"}, "annotator1_id": {"dtype": "string", "id": null, "_type": "Value"}, "annotation2": {"dtype": "string", "id": null, "_type": "Value"}, "annotator2_id": {"dtype": "string", "id": null, "_type": "Value"}, "annotation3": {"dtype": "string", "id": null, "_type": "Value"}, "annotator3_id": {"dtype": "string", "id": null, "_type": "Value"}, "annotation_final": {"dtype": "string", "id": null, "_type": "Value"}, "label": {"dtype": "string", "id": null, "_type": "Value"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "si_nli", "config_name": "default", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 1352635, "num_examples": 4392, "dataset_name": "si_nli"}, "validation": {"name": "validation", "num_bytes": 164561, "num_examples": 547, "dataset_name": "si_nli"}, "test": {"name": "test", "num_bytes": 246518, "num_examples": 998, "dataset_name": "si_nli"}}, "download_checksums": {"https://www.clarin.si/repository/xmlui/bitstream/handle/11356/1707/SI-NLI.zip": {"num_bytes": 410093, "checksum": "e2b3be92049ebb68916a236465940880aeb002d148dce7df94b71e8779080274"}}, "download_size": 410093, "post_processing_size": null, "dataset_size": 1763714, "size_in_bytes": 2173807}, "public": {"description": "SI-NLI (Slovene Natural Language Inference Dataset) contains 5,937 human-created Slovene sentence pairs \n(premise and hypothesis) that are manually labeled with the labels \"entailment\", \"contradiction\", and \"neutral\". \nThe dataset was created using sentences that appear in the Slovenian reference corpus ccKres. \nAnnotators were tasked to modify the hypothesis in a candidate pair in a way that reflects one of the labels. \nThe dataset is balanced since the annotators created three modifications (entailment, contradiction, neutral) \nfor each candidate sentence pair.\n", "citation": "@misc{sinli,\n    title = {Slovene Natural Language Inference Dataset {SI}-{NLI}},\n    author = {Klemen, Matej and {\u000b Z}agar, Ale{\u000b s} and {\u000b C}ibej, Jaka and Robnik-{\u000b S}ikonja, Marko},\n    url = {http://hdl.handle.net/11356/1707},\n    note = {Slovenian language resource repository {CLARIN}.{SI}},\n    year = {2022}\n}\n", "homepage": "http://hdl.handle.net/11356/1707", "license": "Creative Commons - Attribution 4.0 International (CC BY 4.0)", "features": {"pair_id": {"dtype": "string", "id": null, "_type": "Value"}, "premise": {"dtype": "string", "id": null, "_type": "Value"}, "hypothesis": {"dtype": "string", "id": null, "_type": "Value"}, "annotation1": {"dtype": "string", "id": null, "_type": "Value"}, "annotator1_id": {"dtype": "string", "id": null, "_type": "Value"}, "annotation2": {"dtype": "string", "id": null, "_type": "Value"}, "annotator2_id": {"dtype": "string", "id": null, "_type": "Value"}, "annotation3": {"dtype": "string", "id": null, "_type": "Value"}, "annotator3_id": {"dtype": "string", "id": null, "_type": "Value"}, "annotation_final": {"dtype": "string", "id": null, "_type": "Value"}, "label": {"dtype": "string", "id": null, "_type": "Value"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "si_nli", "config_name": "public", "version": {"version_str": "1.0.1", "description": null, "major": 1, "minor": 0, "patch": 1}, "splits": {"train": {"name": "train", "num_bytes": 1352635, "num_examples": 4392, "dataset_name": "si_nli"}, "validation": {"name": "validation", "num_bytes": 164561, "num_examples": 547, "dataset_name": "si_nli"}, "test": {"name": "test", "num_bytes": 246518, "num_examples": 998, "dataset_name": "si_nli"}}, "download_checksums": {"https://www.clarin.si/repository/xmlui/bitstream/handle/11356/1707/SI-NLI.zip": {"num_bytes": 410093, "checksum": "e2b3be92049ebb68916a236465940880aeb002d148dce7df94b71e8779080274"}}, "download_size": 410093, "post_processing_size": null, "dataset_size": 1763714, "size_in_bytes": 2173807}, "private": {"description": "SI-NLI (Slovene Natural Language Inference Dataset) contains 5,937 human-created Slovene sentence pairs \n(premise and hypothesis) that are manually labeled with the labels \"entailment\", \"contradiction\", and \"neutral\". \nThe dataset was created using sentences that appear in the Slovenian reference corpus ccKres. \nAnnotators were tasked to modify the hypothesis in a candidate pair in a way that reflects one of the labels. \nThe dataset is balanced since the annotators created three modifications (entailment, contradiction, neutral) \nfor each candidate sentence pair.\n", "citation": "@misc{sinli,\n    title = {Slovene Natural Language Inference Dataset {SI}-{NLI}},\n    author = {Klemen, Matej and {\u000b Z}agar, Ale{\u000b s} and {\u000b C}ibej, Jaka and Robnik-{\u000b S}ikonja, Marko},\n    url = {http://hdl.handle.net/11356/1707},\n    note = {Slovenian language resource repository {CLARIN}.{SI}},\n    year = {2022}\n}\n", "homepage": "http://hdl.handle.net/11356/1707", "license": "Creative Commons - Attribution 4.0 International (CC BY 4.0)", "features": {"pair_id": {"dtype": "string", "id": null, "_type": "Value"}, "premise": {"dtype": "string", "id": null, "_type": "Value"}, "hypothesis": {"dtype": "string", "id": null, "_type": "Value"}, "annotation1": {"dtype": "string", "id": null, "_type": "Value"}, "annotator1_id": {"dtype": "string", "id": null, "_type": "Value"}, "annotation2": {"dtype": "string", "id": null, "_type": "Value"}, "annotator2_id": {"dtype": "string", "id": null, "_type": "Value"}, "annotation3": {"dtype": "string", "id": null, "_type": "Value"}, "annotator3_id": {"dtype": "string", "id": null, "_type": "Value"}, "annotation_final": {"dtype": "string", "id": null, "_type": "Value"}, "label": {"dtype": "string", "id": null, "_type": "Value"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "si_nli", "config_name": "private", "version": {"version_str": "1.0.1", "description": null, "major": 1, "minor": 0, "patch": 1}, "splits": {}, "download_checksums": {}, "download_size": 0, "post_processing_size": null, "dataset_size": 0, "size_in_bytes": 0}}

si_nli.py

@@ -2,7 +2,7 @@
 
 
 import csv
-import json
+import logging
 import os
 
 import datasets
@@ -42,7 +42,16 @@ UNIFIED_LABELS = {"E": "entailment", "N": "neutral", "C": "contradiction"}
 class SINLI(datasets.GeneratorBasedBuilder):
     """SI-NLI is a Slovene natural language inference dataset."""
 
-    VERSION = datasets.Version("1.0.0")
+    VERSION = datasets.Version("1.0.1")
+
+    BUILDER_CONFIGS = [
+        datasets.BuilderConfig(name="public", version=VERSION,
+                               description="Load the publicly available dataset (without test labels)."),
+        datasets.BuilderConfig(name="private", version=VERSION,
+                               description="Load the privately available dataset by manuallly providing the path to the data."),
+    ]
+
+    DEFAULT_CONFIG_NAME = "public"
 
     def _info(self):
         features = datasets.Features({
@@ -68,8 +77,20 @@ class SINLI(datasets.GeneratorBasedBuilder):
         )
 
     def _split_generators(self, dl_manager):
-        urls = _URLS["si-nli"]
-        data_dir = dl_manager.download_and_extract(urls)
+        if self.config.name == "public":
+            urls = _URLS["si-nli"]
+            data_dir = dl_manager.download_and_extract(urls)
+        else:
+            # `data_dir` must have the map SI-NLI inside and train.tsv, dev.tsv, test.tsv
+            if dl_manager.manual_dir is None or not os.path.exists(dl_manager.manual_dir):
+                logging.warning("data_dir does not point to a valid directory")
+
+            # Allow user to specify path to the private data directory: `load_dataset(..., data_dir=...)`
+            data_dir = dl_manager.manual_dir
+
+            if data_dir is None:
+                return []
+
         return [
             datasets.SplitGenerator(
                 name=datasets.Split.TRAIN,
@@ -88,8 +109,7 @@ class SINLI(datasets.GeneratorBasedBuilder):
             datasets.SplitGenerator(
                 name=datasets.Split.TEST,
                 gen_kwargs={
-                    # Allow the user to load the private test set with this script if they have access to it
-                    "file_path": os.getenv("SI_NLI_TEST_PATH", os.path.join(data_dir, "SI-NLI", "test.tsv")),
+                    "file_path": os.path.join(data_dir, "SI-NLI", "test.tsv"),
                     "split": "test"
                 }
             )