updating vukuzenzele monolingual to use a dataset generator

afr.jsonl.zip

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:a5af3a771b3344ccceb11e185716deded04a957d963b54d6515402115bc82ca6
-size 249645

eng.jsonl.zip

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:d28f8da74961aa98a00bcfcfa0155a72d8ff36eba357753c38ef8eaf7b873ba5
-size 191987

nbl.jsonl.zip

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:a8a748e1957dd484615983a25cef59a0ca29b569c33f03ca614871ade8c58687
-size 275532

nso.jsonl.zip

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:6a70167a06503f79a0efc641fb8d7850d0936aa3557840437de50679caaaf13e
-size 255078

sot.jsonl.zip

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:486089fdb22a6330a533e0981739ee0c9b4cde1adeebefa5671b31d42933365d
-size 250336

ssw.jsonl.zip

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:2007f35b3b28fd11b89207be5ec90f7c573a71f40af43d8150d084b8a55ac045
-size 261417

tsn.jsonl.zip

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:d7ce237bc9821289c9dd91a1b43fbf0cd00deb76b8f4d2c965742e30a79267e1
-size 273197

tso.jsonl.zip

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:5e99dc959fd6e4a95cdb00adb48cd18d3ba718f70672c33c01c6e27429c45ec1
-size 243815

ven.jsonl.zip

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:67499af808c6c43d41c8b6dca4bba286945a43256ee77c1f042de96886977c5e
-size 256295

vukuzenzele-monolingual.py

@@ -0,0 +1,107 @@
+
+"""TODO: Add a description here."""
+
+
+import csv
+import json
+import os
+
+import datasets
+
+
+# TODO: Add BibTeX citation
+# Find for instance the citation on arxiv or on the dataset repo/website
+_CITATION = """\
+@dataset{marivate_vukosi_2023_7598540, author = {Marivate, Vukosi and Njini, Daniel and Madodonga, Andani and Lastrucci, Richard and Dzingirai, Isheanesu Rajab, Jenalea}, title = {The Vuk'uzenzele South African Multilingual Corpus}, month = feb, year = 2023, publisher = {Zenodo}, doi = {10.5281/zenodo.7598539}, url = {https://doi.org/10.5281/zenodo.7598539} }
+"""
+
+_DESCRIPTION = """\
+The dataset contains editions from the South African government magazine Vuk'uzenzele. Data was scraped from PDFs that have been placed in the data/raw folder. The PDFS were obtained from the Vuk'uzenzele website.
+"""
+
+# TODO: Add a link to an official homepage for the dataset here
+_HOMEPAGE = "https://arxiv.org/abs/2303.03750"
+
+# TODO: Add the licence for the dataset here if you can find it
+_LICENSE = "CC 4.0 BY"
+
+_URL = "https://raw.githubusercontent.com/dsfsi/vukuzenzele-nlp/master/data/huggingface/"
+_DATAFILE = "data.jsonl"
+
+class VukuzenzeleMonolingualConfig(datasets.BuilderConfig):
+    """BuilderConfig for VukuzenzeleMonolingual"""
+
+    def __init__(self, **kwargs):
+        """BuilderConfig for Masakhaner.
+        Args:
+          **kwargs: keyword arguments forwarded to super.
+        """
+        super(VukuzenzeleMonolingualConfig, self).__init__(**kwargs)
+
+
+# TODO: Name of the dataset usually matches the script name with CamelCase instead of snake_case
+class VukuzenzeleMonolingual(datasets.GeneratorBasedBuilder):
+    """TODO: Short description of my dataset."""
+
+    VERSION = datasets.Version("1.0.0")
+
+    BUILDER_CONFIGS = [
+        datasets.BuilderConfig(name="afr", version=VERSION, description="Vukuzenzele Afrikaans Dataset"),
+        datasets.BuilderConfig(name="eng", version=VERSION, description="Vukuzenzele English Dataset"),
+        datasets.BuilderConfig(name="nbl", version=VERSION, description="Vukuzenzele Ndebele Dataset"),
+        datasets.BuilderConfig(name="nso", version=VERSION, description="Vukuzenzele Sepedi Dataset"),
+        datasets.BuilderConfig(name="sot", version=VERSION, description="Vukuzenzele Sesotho Dataset"),
+        datasets.BuilderConfig(name="ssw", version=VERSION, description="Vukuzenzele siSwati Dataset"),
+        datasets.BuilderConfig(name="tsn", version=VERSION, description="Vukuzenzele Setswana Dataset"),
+        datasets.BuilderConfig(name="tso", version=VERSION, description="Vukuzenzele Xitsonga Dataset"),
+        datasets.BuilderConfig(name="ven", version=VERSION, description="Vukuzenzele Tshivenda Dataset"),
+        datasets.BuilderConfig(name="xho", version=VERSION, description="Vukuzenzele isiXhosa Dataset"),
+        datasets.BuilderConfig(name="zul", version=VERSION, description="Vukuzenzele isiZulu Dataset"),
+    ]
+
+    def _info(self):
+        features = datasets.Features(
+            {
+                "title": datasets.Value("string"),
+                "text": datasets.Value("string"),
+                "language_code": datasets.Value("string"),
+                "edition": datasets.Value("string")
+            }
+        )
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=features,  
+            homepage=_HOMEPAGE,
+            license=_LICENSE,
+            # Citation for the dataset
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+      
+        urls = {
+            "train": f"{_URL}{self.config.name}/{_DATAFILE}"
+        }
+        data_dir = dl_manager.download_and_extract(urls)
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                gen_kwargs={
+                    "filepath": data_dir["train"],
+                    "split": "train",
+                },
+            ),
+        ]
+
+    def _generate_examples(self, filepath, split):
+        with open(filepath, encoding="utf-8") as f:
+            for key, row in enumerate(f):
+                data = json.loads(row)
+                if 'title' not in data.keys(): continue
+                yield key, {
+                    "title": data["title"],
+                    "text": data["text"],
+                    "edition": data["edition"],
+                    "language_code": data["language_code"],
+                }
+             

xho.jsonl.zip

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:1da7270ae308e7e9458cd55daf1f3f10d648dda7f8ba1614d4d62d55a78babf5
-size 265230

zul.jsonl.zip

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:c963ce535b21131cc66136d921f9b652ba8851ed409c69e433e3dddab4127ac7
-size 255139