Changed to download csv instead of loading local file

Ettinger.py

@@ -22,11 +22,14 @@ import pandas as pd
 # TODO: Add BibTeX citation
 # Find for instance the citation on arxiv or on the dataset repo/website
 _CITATION = """\
-@InProceedings{huggingface:dataset,
-title = {A great new dataset},
-author={huggingface, Inc.
-},
-year={2020}
+@article{ettinger2020bert,
+  title={What BERT is not: Lessons from a new suite of psycholinguistic diagnostics for language models},
+  author={Ettinger, Allyson},
+  journal={Transactions of the Association for Computational Linguistics},
+  volume={8},
+  pages={34--48},
+  year={2020},
+  publisher={MIT Press}
 }
 """
 
@@ -40,16 +43,38 @@ This new dataset is designed to solve this great NLP task and is crafted with a
 _HOMEPAGE = ""
 
 # TODO: Add the licence for the dataset here if you can find it
-_LICENSE = ""
+_LICENSE = """MIT License
+
+Copyright (c) 2020 Allyson Ettinger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
 
 # TODO: Add link to the official dataset URLs here
 # The HuggingFace Datasets library doesn't host the datasets but only points to the original files.
 # This can be an arbitrary nested dict/list of URLs (see below in `_split_generators` method)
-_PATHS = {
-    "CPRAG": "CPRAG/test.csv",
-    "ROLE": "ROLE/test.csv",
-    "NEG-NAT": "NEG-NAT/test.csv",
-    "NEG-SIMP": "NEG-SIMP/test.csv",
+_URL = "https://huggingface.co/datasets/KevinZ/Ettinger/resolve/main/"
+_URLS = {
+    "CPRAG": _URL + "CPRAG/test.csv",
+    "ROLE": _URL + "ROLE/test.csv",
+    "NEG-NAT": _URL + "NEG-NAT/test.csv",
+    "NEG-SIMP": _URL + "NEG-SIMP/test.csv",
 }
 
 # TODO: Name of the dataset usually match the script name with CamelCase instead of snake_case
@@ -139,12 +164,15 @@ class NewDataset(datasets.GeneratorBasedBuilder):
         # dl_manager is a datasets.download.DownloadManager that can be used to download and extract URLS
         # It can accept any type or nested list/dict and will give back the same structure with the url replaced with path to local files.
         # By default the archives will be extracted and a path to a cached folder where they are extracted is returned instead of the archive
+
+        downloaded_files = dl_manager.download_and_extract(_URLS)
+
         return [
             datasets.SplitGenerator(
                 name=datasets.Split.TEST,
                 # These kwargs will be passed to _generate_examples
                 gen_kwargs={
-                    "filepath": _PATHS[self.config.name],
+                    "filepath": downloaded_files[self.config.name],
                     "split": "test"
                 },
             ),
@@ -152,28 +180,9 @@ class NewDataset(datasets.GeneratorBasedBuilder):
 
     # method parameters are unpacked from `gen_kwargs` as given in `_split_generators`
     def _generate_examples(self, filepath, split):
-        # TODO: This method handles input defined in _split_generators to yield (key, example) tuples from the dataset.
         # The `key` is for legacy reasons (tfds) and is not important in itself, but must be unique for each example.
         df = pd.read_csv(filepath)
         for index, row in df.iterrows():
-            if self.config.name == "NEG-NAT":
-                features = datasets.Features(
-                    {
-                        "context_aff": datasets.Value("string"),
-                        "context_neg": datasets.Value("string"),
-                        "target_aff": datasets.Value("string"),
-                        "target_neg": datasets.Value("string"),
-                    }
-                )
-            elif self.config.name == "NEG-SIMP":
-                features = datasets.Features(
-                    {
-                        "context_aff": datasets.Value("string"),
-                        "context_neg": datasets.Value("string"),
-                        "target_aff": datasets.Value("string"),
-                        "target_neg": datasets.Value("string"),
-                    }
-                )
             if self.config.name == "CPRAG":
                 # Yields examples as (key, example) tuples
                 yield index, {

dataset_infos.json

@@ -0,0 +1 @@
+{"CPRAG": {"description": "This new dataset is designed to solve this great NLP task and is crafted with a lot of care.\n", "citation": "@article{ettinger2020bert,\n  title={What BERT is not: Lessons from a new suite of psycholinguistic diagnostics for language models},\n  author={Ettinger, Allyson},\n  journal={Transactions of the Association for Computational Linguistics},\n  volume={8},\n  pages={34--48},\n  year={2020},\n  publisher={MIT Press}\n}\n", "homepage": "", "license": "MIT License\n\nCopyright (c) 2020 Allyson Ettinger\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n", "features": {"context_s1": {"dtype": "string", "id": null, "_type": "Value"}, "context_s2": {"dtype": "string", "id": null, "_type": "Value"}, "expected": {"dtype": "string", "id": null, "_type": "Value"}, "within_category": {"dtype": "string", "id": null, "_type": "Value"}, "between_category": {"dtype": "string", "id": null, "_type": "Value"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "new_dataset", "config_name": "CPRAG", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"test": {"name": "test", "num_bytes": 5202, "num_examples": 34, "dataset_name": "new_dataset"}}, "download_checksums": {"https://huggingface.co/datasets/KevinZ/Ettinger/resolve/main/CPRAG/test.csv": {"num_bytes": 4875, "checksum": "17e185c8abcc3b6ea0f28485e43334608cd50105c51f18e93ffa2d5d935b37a9"}, "https://huggingface.co/datasets/KevinZ/Ettinger/resolve/main/ROLE/test.csv": {"num_bytes": 8668, "checksum": "6c23629624cb61044210439586f9fe4514f3baef2fa256f580e44cb981de0649"}, "https://huggingface.co/datasets/KevinZ/Ettinger/resolve/main/NEG-NAT/test.csv": {"num_bytes": 1450, "checksum": "5f3efad556ade6d624d612314e60b522d34ffd901a5911cdeb1f1563b6bb4e06"}, "https://huggingface.co/datasets/KevinZ/Ettinger/resolve/main/NEG-SIMP/test.csv": {"num_bytes": 996, "checksum": "b756a3d8c2bd4e919986e38b3e64f85b10aabc06c967b59eb098821a584dfc28"}}, "download_size": 15989, "post_processing_size": null, "dataset_size": 5202, "size_in_bytes": 21191}, "ROLE": {"description": "This new dataset is designed to solve this great NLP task and is crafted with a lot of care.\n", "citation": "@article{ettinger2020bert,\n  title={What BERT is not: Lessons from a new suite of psycholinguistic diagnostics for language models},\n  author={Ettinger, Allyson},\n  journal={Transactions of the Association for Computational Linguistics},\n  volume={8},\n  pages={34--48},\n  year={2020},\n  publisher={MIT Press}\n}\n", "homepage": "", "license": "MIT License\n\nCopyright (c) 2020 Allyson Ettinger\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n", "features": {"context": {"dtype": "string", "id": null, "_type": "Value"}, "expected": {"dtype": "string", "id": null, "_type": "Value"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "new_dataset", "config_name": "ROLE", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"test": {"name": "test", "num_bytes": 6290, "num_examples": 88, "dataset_name": "new_dataset"}}, "download_checksums": {"https://huggingface.co/datasets/KevinZ/Ettinger/resolve/main/CPRAG/test.csv": {"num_bytes": 4875, "checksum": "17e185c8abcc3b6ea0f28485e43334608cd50105c51f18e93ffa2d5d935b37a9"}, "https://huggingface.co/datasets/KevinZ/Ettinger/resolve/main/ROLE/test.csv": {"num_bytes": 8668, "checksum": "6c23629624cb61044210439586f9fe4514f3baef2fa256f580e44cb981de0649"}, "https://huggingface.co/datasets/KevinZ/Ettinger/resolve/main/NEG-NAT/test.csv": {"num_bytes": 1450, "checksum": "5f3efad556ade6d624d612314e60b522d34ffd901a5911cdeb1f1563b6bb4e06"}, "https://huggingface.co/datasets/KevinZ/Ettinger/resolve/main/NEG-SIMP/test.csv": {"num_bytes": 996, "checksum": "b756a3d8c2bd4e919986e38b3e64f85b10aabc06c967b59eb098821a584dfc28"}}, "download_size": 15989, "post_processing_size": null, "dataset_size": 6290, "size_in_bytes": 22279}, "NEG-NAT": {"description": "This new dataset is designed to solve this great NLP task and is crafted with a lot of care.\n", "citation": "@article{ettinger2020bert,\n  title={What BERT is not: Lessons from a new suite of psycholinguistic diagnostics for language models},\n  author={Ettinger, Allyson},\n  journal={Transactions of the Association for Computational Linguistics},\n  volume={8},\n  pages={34--48},\n  year={2020},\n  publisher={MIT Press}\n}\n", "homepage": "", "license": "MIT License\n\nCopyright (c) 2020 Allyson Ettinger\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n", "features": {"context_aff": {"dtype": "string", "id": null, "_type": "Value"}, "context_neg": {"dtype": "string", "id": null, "_type": "Value"}, "target_aff": {"dtype": "string", "id": null, "_type": "Value"}, "target_neg": {"dtype": "string", "id": null, "_type": "Value"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "new_dataset", "config_name": "NEG-NAT", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"test": {"name": "test", "num_bytes": 1546, "num_examples": 16, "dataset_name": "new_dataset"}}, "download_checksums": {"https://huggingface.co/datasets/KevinZ/Ettinger/resolve/main/CPRAG/test.csv": {"num_bytes": 4875, "checksum": "17e185c8abcc3b6ea0f28485e43334608cd50105c51f18e93ffa2d5d935b37a9"}, "https://huggingface.co/datasets/KevinZ/Ettinger/resolve/main/ROLE/test.csv": {"num_bytes": 8668, "checksum": "6c23629624cb61044210439586f9fe4514f3baef2fa256f580e44cb981de0649"}, "https://huggingface.co/datasets/KevinZ/Ettinger/resolve/main/NEG-NAT/test.csv": {"num_bytes": 1450, "checksum": "5f3efad556ade6d624d612314e60b522d34ffd901a5911cdeb1f1563b6bb4e06"}, "https://huggingface.co/datasets/KevinZ/Ettinger/resolve/main/NEG-SIMP/test.csv": {"num_bytes": 996, "checksum": "b756a3d8c2bd4e919986e38b3e64f85b10aabc06c967b59eb098821a584dfc28"}}, "download_size": 15989, "post_processing_size": null, "dataset_size": 1546, "size_in_bytes": 17535}, "NEG-SIMP": {"description": "This new dataset is designed to solve this great NLP task and is crafted with a lot of care.\n", "citation": "@article{ettinger2020bert,\n  title={What BERT is not: Lessons from a new suite of psycholinguistic diagnostics for language models},\n  author={Ettinger, Allyson},\n  journal={Transactions of the Association for Computational Linguistics},\n  volume={8},\n  pages={34--48},\n  year={2020},\n  publisher={MIT Press}\n}\n", "homepage": "", "license": "MIT License\n\nCopyright (c) 2020 Allyson Ettinger\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n", "features": {"context_aff": {"dtype": "string", "id": null, "_type": "Value"}, "context_neg": {"dtype": "string", "id": null, "_type": "Value"}, "target_aff": {"dtype": "string", "id": null, "_type": "Value"}, "target_neg": {"dtype": "string", "id": null, "_type": "Value"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "new_dataset", "config_name": "NEG-SIMP", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"test": {"name": "test", "num_bytes": 1166, "num_examples": 18, "dataset_name": "new_dataset"}}, "download_checksums": {"https://huggingface.co/datasets/KevinZ/Ettinger/resolve/main/CPRAG/test.csv": {"num_bytes": 4875, "checksum": "17e185c8abcc3b6ea0f28485e43334608cd50105c51f18e93ffa2d5d935b37a9"}, "https://huggingface.co/datasets/KevinZ/Ettinger/resolve/main/ROLE/test.csv": {"num_bytes": 8668, "checksum": "6c23629624cb61044210439586f9fe4514f3baef2fa256f580e44cb981de0649"}, "https://huggingface.co/datasets/KevinZ/Ettinger/resolve/main/NEG-NAT/test.csv": {"num_bytes": 1450, "checksum": "5f3efad556ade6d624d612314e60b522d34ffd901a5911cdeb1f1563b6bb4e06"}, "https://huggingface.co/datasets/KevinZ/Ettinger/resolve/main/NEG-SIMP/test.csv": {"num_bytes": 996, "checksum": "b756a3d8c2bd4e919986e38b3e64f85b10aabc06c967b59eb098821a584dfc28"}}, "download_size": 15989, "post_processing_size": null, "dataset_size": 1166, "size_in_bytes": 17155}}