Nicer private/public distinction in dataset script using separate configs

cc_gigafida.py

@@ -8,6 +8,7 @@ import os.path
 import re
 import xml.etree.ElementTree as ET
 from copy import deepcopy
+from typing import Optional
 
 import datasets
 
@@ -52,6 +53,16 @@ class CcGigafida(datasets.GeneratorBasedBuilder):
 
     VERSION = datasets.Version("1.0.0")
 
+    BUILDER_CONFIGS = [
+        datasets.BuilderConfig(name="public", version=VERSION,
+                               description="Load the publicly available dataset (ccGigafida)."),
+        datasets.BuilderConfig(name="private", version=VERSION,
+                               description="Load the privately available dataset (Gigafida/Gigafida2) by manuallly "
+                                           "providing the path to the data."),
+    ]
+
+    DEFAULT_CONFIG_NAME = "public"
+
     def _info(self):
         features = datasets.Features(
             {
@@ -78,13 +89,16 @@ class CcGigafida(datasets.GeneratorBasedBuilder):
         )
 
     def _split_generators(self, dl_manager):
-        # Allow user to specify path to the full Gigafida directory: `load_dataset(..., data_dir=...)`
-        if dl_manager.manual_dir is not None:
-            data_dir = dl_manager.manual_dir
-        else:
+        if self.config.name == "public":
             urls = _URLS["ccGigafida"]
             data_dir = dl_manager.download_and_extract(urls)
             data_dir = os.path.join(data_dir, "ccGigafidaV1_0")
+        else:
+            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 Gigafida directory: `load_dataset(..., data_dir=...)`
+            data_dir = dl_manager.manual_dir
 
         return [
             datasets.SplitGenerator(

dataset_infos.json

@@ -1 +1 @@
-{"default": {"description": "The ccGigafida corpus contains a subsample of the Gigafida corpus. The Gigafida corpus is an extensive collection of \nSlovene text of various genres, from daily newspapers, magazines, all kinds of books (fiction, non-fiction, textbooks), \nweb pages, transcriptions of parliamentary debates and similar.\n", "citation": "@misc{ccGigafida,\n    title = {Written corpus {ccGigafida} 1.0},\n    author = {Logar, Nata{\u000b s}a and Erjavec, Toma{\u000b z} and Krek, Simon and Gr{\u000b c}ar, Miha and Holozan, Peter},\n    url = {http://hdl.handle.net/11356/1035},\n    note = {Slovenian language resource repository {CLARIN}.{SI}},\n    copyright = {Creative Commons - Attribution-{NonCommercial}-{ShareAlike} 4.0 International ({CC} {BY}-{NC}-{SA} 4.0)},\n    issn = {2820-4042},\n    year = {2013}\n}\n", "homepage": "http://eng.slovenscina.eu/korpusi/proste-zbirke", "license": "Creative Commons - Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)", "features": {"id_doc": {"dtype": "string", "id": null, "_type": "Value"}, "doc_title": {"dtype": "string", "id": null, "_type": "Value"}, "authors": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "publish_date": {"dtype": "string", "id": null, "_type": "Value"}, "publisher": {"dtype": "string", "id": null, "_type": "Value"}, "genres": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "doc_tokenized": {"feature": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "doc_lemmas": {"feature": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "doc_msds": {"feature": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "doc_string": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "id_sents": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "cc_gigafida", "config_name": "default", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 4242404354, "num_examples": 31722, "dataset_name": "cc_gigafida"}}, "download_checksums": {"https://www.clarin.si/repository/xmlui/bitstream/handle/11356/1035/ccGigafidaV1_0.zip": {"num_bytes": 954116273, "checksum": "448e284d6f92d54f123e2b7fa433c9d84d060f2db07c589e9b45a356a1f5242e"}}, "download_size": 954116273, "post_processing_size": null, "dataset_size": 4242404354, "size_in_bytes": 5196520627}}
+{"default": {"description": "The ccGigafida corpus contains a subsample of the Gigafida corpus. The Gigafida corpus is an extensive collection of \nSlovene text of various genres, from daily newspapers, magazines, all kinds of books (fiction, non-fiction, textbooks), \nweb pages, transcriptions of parliamentary debates and similar.\n", "citation": "@misc{ccGigafida,\n    title = {Written corpus {ccGigafida} 1.0},\n    author = {Logar, Nata{\u000b s}a and Erjavec, Toma{\u000b z} and Krek, Simon and Gr{\u000b c}ar, Miha and Holozan, Peter},\n    url = {http://hdl.handle.net/11356/1035},\n    note = {Slovenian language resource repository {CLARIN}.{SI}},\n    copyright = {Creative Commons - Attribution-{NonCommercial}-{ShareAlike} 4.0 International ({CC} {BY}-{NC}-{SA} 4.0)},\n    issn = {2820-4042},\n    year = {2013}\n}\n", "homepage": "http://eng.slovenscina.eu/korpusi/proste-zbirke", "license": "Creative Commons - Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)", "features": {"id_doc": {"dtype": "string", "id": null, "_type": "Value"}, "doc_title": {"dtype": "string", "id": null, "_type": "Value"}, "authors": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "publish_date": {"dtype": "string", "id": null, "_type": "Value"}, "publisher": {"dtype": "string", "id": null, "_type": "Value"}, "genres": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "doc_tokenized": {"feature": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "doc_lemmas": {"feature": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "doc_msds": {"feature": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "doc_string": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "id_sents": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "cc_gigafida", "config_name": "default", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 4242404354, "num_examples": 31722, "dataset_name": "cc_gigafida"}}, "download_checksums": {"https://www.clarin.si/repository/xmlui/bitstream/handle/11356/1035/ccGigafidaV1_0.zip": {"num_bytes": 954116273, "checksum": "448e284d6f92d54f123e2b7fa433c9d84d060f2db07c589e9b45a356a1f5242e"}}, "download_size": 954116273, "post_processing_size": null, "dataset_size": 4242404354, "size_in_bytes": 5196520627}, "public": {"description": "The ccGigafida corpus contains a subsample of the Gigafida corpus. The Gigafida corpus is an extensive collection of \nSlovene text of various genres, from daily newspapers, magazines, all kinds of books (fiction, non-fiction, textbooks), \nweb pages, transcriptions of parliamentary debates and similar.\n", "citation": "@misc{ccGigafida,\n    title = {Written corpus {ccGigafida} 1.0},\n    author = {Logar, Nata{\u000b s}a and Erjavec, Toma{\u000b z} and Krek, Simon and Gr{\u000b c}ar, Miha and Holozan, Peter},\n    url = {http://hdl.handle.net/11356/1035},\n    note = {Slovenian language resource repository {CLARIN}.{SI}},\n    copyright = {Creative Commons - Attribution-{NonCommercial}-{ShareAlike} 4.0 International ({CC} {BY}-{NC}-{SA} 4.0)},\n    issn = {2820-4042},\n    year = {2013}\n}\n", "homepage": "http://eng.slovenscina.eu/korpusi/proste-zbirke", "license": "Creative Commons - Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)", "features": {"id_doc": {"dtype": "string", "id": null, "_type": "Value"}, "doc_title": {"dtype": "string", "id": null, "_type": "Value"}, "authors": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "publish_date": {"dtype": "string", "id": null, "_type": "Value"}, "publisher": {"dtype": "string", "id": null, "_type": "Value"}, "genres": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "doc_tokenized": {"feature": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "doc_lemmas": {"feature": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "doc_msds": {"feature": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "doc_string": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "id_sents": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "cc_gigafida", "config_name": "public", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 4242404354, "num_examples": 31722, "dataset_name": "cc_gigafida"}}, "download_checksums": {"https://www.clarin.si/repository/xmlui/bitstream/handle/11356/1035/ccGigafidaV1_0.zip": {"num_bytes": 954116273, "checksum": "448e284d6f92d54f123e2b7fa433c9d84d060f2db07c589e9b45a356a1f5242e"}}, "download_size": 954116273, "post_processing_size": null, "dataset_size": 4242404354, "size_in_bytes": 5196520627}, "private": {"description": "The ccGigafida corpus contains a subsample of the Gigafida corpus. The Gigafida corpus is an extensive collection of \nSlovene text of various genres, from daily newspapers, magazines, all kinds of books (fiction, non-fiction, textbooks), \nweb pages, transcriptions of parliamentary debates and similar.\n", "citation": "@misc{ccGigafida,\n    title = {Written corpus {ccGigafida} 1.0},\n    author = {Logar, Nata{\u000b s}a and Erjavec, Toma{\u000b z} and Krek, Simon and Gr{\u000b c}ar, Miha and Holozan, Peter},\n    url = {http://hdl.handle.net/11356/1035},\n    note = {Slovenian language resource repository {CLARIN}.{SI}},\n    copyright = {Creative Commons - Attribution-{NonCommercial}-{ShareAlike} 4.0 International ({CC} {BY}-{NC}-{SA} 4.0)},\n    issn = {2820-4042},\n    year = {2013}\n}\n", "homepage": "http://eng.slovenscina.eu/korpusi/proste-zbirke", "license": "Creative Commons - Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)", "features": {"id_doc": {"dtype": "string", "id": null, "_type": "Value"}, "doc_title": {"dtype": "string", "id": null, "_type": "Value"}, "authors": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "publish_date": {"dtype": "string", "id": null, "_type": "Value"}, "publisher": {"dtype": "string", "id": null, "_type": "Value"}, "genres": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "doc_tokenized": {"feature": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "doc_lemmas": {"feature": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "doc_msds": {"feature": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "doc_string": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}, "id_sents": {"feature": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "length": -1, "id": null, "_type": "Sequence"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "cc_gigafida", "config_name": "private", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 0, "num_examples": 0, "dataset_name": "cc_gigafida"}}, "download_checksums": {}, "download_size": 0, "post_processing_size": null, "dataset_size": 0, "size_in_bytes": 0}}