diff --git a/README.md b/README.md index dd645dc4c139fe4a55fa3fd23a0427bb1058d729..b2cf1a315e1e35457d5a05a660f142bdaee78afe 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,20 @@ The datasets contain government magazine editions in 11 languages, namely: | isiZulu | (zul) | Xitstonga | (tso) | | Sesotho | (nso) | +## Available pairings + +The alignment direction is bidrectional, i.e. xho-zul is zul-xho + +afr-eng; afr-nbl; afr-nso; afr-sot; afr-ssw; afr-tsn; afr-tso; afr-ven; afr-xho; afr-zul +eng-nbl; eng-nso; eng-sot ;eng-ssw; eng-tsn; eng-tso; eng-ven; eng-xho; eng-zul +nbl-nso; nbl-sot; nbl-ssw; nbl-tsn; nbl-tso; nbl-ven; nbl-xho; nbl-zul +nso-sot; nso-ssw; nso-tsn; nso-tso; nso-ven; nso-xho; nso-zul +sot-ssw; sot-tsn; sot-tso; sot-ven; sot-xho; sot-zul +ssw-tsn; ssw-tso; ssw-ven; ssw-xho; ssw-zul +tsn-tso; tsn-ven; tsn-xho; tsn-zul +tso-ven; tso-xho; tso-zul +ven-xho; ven-zul +xho-zul # Disclaimer diff --git a/aligned_afr_eng.csv.zip b/aligned_afr_eng.csv.zip deleted file mode 100644 index 09579be62e73ace49eef8681545724d1f8e64114..0000000000000000000000000000000000000000 Binary files a/aligned_afr_eng.csv.zip and /dev/null differ diff --git a/aligned_afr_nbl.csv.zip b/aligned_afr_nbl.csv.zip deleted file mode 100644 index 8eb225aca6b10f242a87c3113c7b1c709afa769c..0000000000000000000000000000000000000000 Binary files a/aligned_afr_nbl.csv.zip and /dev/null differ diff --git a/aligned_afr_nso.csv.zip b/aligned_afr_nso.csv.zip deleted file mode 100644 index 00d9581f94da99c14a707869708b07648b022df7..0000000000000000000000000000000000000000 Binary files a/aligned_afr_nso.csv.zip and /dev/null differ diff --git a/aligned_afr_sep.csv.zip b/aligned_afr_sep.csv.zip deleted file mode 100644 index 44d09258ecc094764e0639ba39e8922fdd8935af..0000000000000000000000000000000000000000 Binary files a/aligned_afr_sep.csv.zip and /dev/null differ diff --git a/aligned_afr_ssw.csv.zip b/aligned_afr_ssw.csv.zip deleted file mode 100644 index 91748e5aa9b5abaa75b1d43a9a6a8a37951939f4..0000000000000000000000000000000000000000 Binary files a/aligned_afr_ssw.csv.zip and /dev/null differ diff --git a/aligned_afr_tsn.csv.zip b/aligned_afr_tsn.csv.zip deleted file mode 100644 index 990341cbd8e4dfc1503c3839b49bd197273d6498..0000000000000000000000000000000000000000 Binary files a/aligned_afr_tsn.csv.zip and /dev/null differ diff --git a/aligned_afr_tso.csv.zip b/aligned_afr_tso.csv.zip deleted file mode 100644 index 35ab3b1c15f3979233c2df2f8b47a89e890ffc99..0000000000000000000000000000000000000000 Binary files a/aligned_afr_tso.csv.zip and /dev/null differ diff --git a/aligned_afr_ven.csv.zip b/aligned_afr_ven.csv.zip deleted file mode 100644 index 2deb1a5aadaa2ddf600af04912f82e36e7cd3f78..0000000000000000000000000000000000000000 Binary files a/aligned_afr_ven.csv.zip and /dev/null differ diff --git a/aligned_afr_xho.csv.zip b/aligned_afr_xho.csv.zip deleted file mode 100644 index e77c91df36b8e6fb0cf7d098a4dbebfaad361ea5..0000000000000000000000000000000000000000 Binary files a/aligned_afr_xho.csv.zip and /dev/null differ diff --git a/aligned_afr_zul.csv.zip b/aligned_afr_zul.csv.zip deleted file mode 100644 index c3a4e7a6d8ee40a0a40baa2bdb99f5c90afca4fd..0000000000000000000000000000000000000000 Binary files a/aligned_afr_zul.csv.zip and /dev/null differ diff --git a/aligned_eng_nbl.csv.zip b/aligned_eng_nbl.csv.zip deleted file mode 100644 index 78d19bd5586b1dae10b044405afedbeddaa7546b..0000000000000000000000000000000000000000 Binary files a/aligned_eng_nbl.csv.zip and /dev/null differ diff --git a/aligned_eng_nso.csv.zip b/aligned_eng_nso.csv.zip deleted file mode 100644 index 1d82f1ce752c5f4b6454bed38f2b92d9627727c8..0000000000000000000000000000000000000000 Binary files a/aligned_eng_nso.csv.zip and /dev/null differ diff --git a/aligned_eng_sep.csv.zip b/aligned_eng_sep.csv.zip deleted file mode 100644 index 26058ef96e171c9c079eb8071c0e8f074f0587dc..0000000000000000000000000000000000000000 Binary files a/aligned_eng_sep.csv.zip and /dev/null differ diff --git a/aligned_eng_ssw.csv.zip b/aligned_eng_ssw.csv.zip deleted file mode 100644 index 5ff43cd1cb3184297adebea9f4fef8e18db9c4ca..0000000000000000000000000000000000000000 Binary files a/aligned_eng_ssw.csv.zip and /dev/null differ diff --git a/aligned_eng_tsn.csv.zip b/aligned_eng_tsn.csv.zip deleted file mode 100644 index e0ff82fac9ca712c3d13af471979e5f66369af0e..0000000000000000000000000000000000000000 Binary files a/aligned_eng_tsn.csv.zip and /dev/null differ diff --git a/aligned_eng_tso.csv.zip b/aligned_eng_tso.csv.zip deleted file mode 100644 index 07d122048f667a43d64a42ea0b0f0e05a01ce588..0000000000000000000000000000000000000000 Binary files a/aligned_eng_tso.csv.zip and /dev/null differ diff --git a/aligned_eng_ven.csv.zip b/aligned_eng_ven.csv.zip deleted file mode 100644 index 6910cde76f3fcd3c05bf9c01df29c5b98390d4e0..0000000000000000000000000000000000000000 Binary files a/aligned_eng_ven.csv.zip and /dev/null differ diff --git a/aligned_eng_xho.csv.zip b/aligned_eng_xho.csv.zip deleted file mode 100644 index 4f81d16286bfbc26146d7c041e6833b5c73c28b0..0000000000000000000000000000000000000000 Binary files a/aligned_eng_xho.csv.zip and /dev/null differ diff --git a/aligned_eng_zul.csv.zip b/aligned_eng_zul.csv.zip deleted file mode 100644 index 939848372f98b163322b380cc6295b2cf9c42a0a..0000000000000000000000000000000000000000 Binary files a/aligned_eng_zul.csv.zip and /dev/null differ diff --git a/aligned_nbl_nso.csv.zip b/aligned_nbl_nso.csv.zip deleted file mode 100644 index 622ab1b31edc313209ffc8bfee67b01217c35427..0000000000000000000000000000000000000000 Binary files a/aligned_nbl_nso.csv.zip and /dev/null differ diff --git a/aligned_nbl_sep.csv.zip b/aligned_nbl_sep.csv.zip deleted file mode 100644 index f419544aa4767671f7745e74420933710d6a470a..0000000000000000000000000000000000000000 Binary files a/aligned_nbl_sep.csv.zip and /dev/null differ diff --git a/aligned_nbl_ssw.csv.zip b/aligned_nbl_ssw.csv.zip deleted file mode 100644 index 0e6886a3f7a222ab4385bd9146ebd97a96df7e9c..0000000000000000000000000000000000000000 Binary files a/aligned_nbl_ssw.csv.zip and /dev/null differ diff --git a/aligned_nbl_tsn.csv.zip b/aligned_nbl_tsn.csv.zip deleted file mode 100644 index 8df717cf9174bdab7fdbddd4f544607c08e62677..0000000000000000000000000000000000000000 Binary files a/aligned_nbl_tsn.csv.zip and /dev/null differ diff --git a/aligned_nbl_tso.csv.zip b/aligned_nbl_tso.csv.zip deleted file mode 100644 index fffa27c6ead14d9e27e116579e83989a20c49aba..0000000000000000000000000000000000000000 Binary files a/aligned_nbl_tso.csv.zip and /dev/null differ diff --git a/aligned_nbl_ven.csv.zip b/aligned_nbl_ven.csv.zip deleted file mode 100644 index 040d4214803f9a8a6898aaf5a793a1b77c075799..0000000000000000000000000000000000000000 Binary files a/aligned_nbl_ven.csv.zip and /dev/null differ diff --git a/aligned_nbl_xho.csv.zip b/aligned_nbl_xho.csv.zip deleted file mode 100644 index 1363c366e7f5f92902aa29905df5f18bd043eb73..0000000000000000000000000000000000000000 Binary files a/aligned_nbl_xho.csv.zip and /dev/null differ diff --git a/aligned_nbl_zul.csv.zip b/aligned_nbl_zul.csv.zip deleted file mode 100644 index 94118912ba23a46b84d279e089228aa356ba2a61..0000000000000000000000000000000000000000 Binary files a/aligned_nbl_zul.csv.zip and /dev/null differ diff --git a/aligned_nso_sep.csv.zip b/aligned_nso_sep.csv.zip deleted file mode 100644 index ee85b6888344e54bf4f2217a6f165e8a12a56ed0..0000000000000000000000000000000000000000 Binary files a/aligned_nso_sep.csv.zip and /dev/null differ diff --git a/aligned_nso_ssw.csv.zip b/aligned_nso_ssw.csv.zip deleted file mode 100644 index f994027de5540c69819784997a01be0d0d79917f..0000000000000000000000000000000000000000 Binary files a/aligned_nso_ssw.csv.zip and /dev/null differ diff --git a/aligned_nso_tsn.csv.zip b/aligned_nso_tsn.csv.zip deleted file mode 100644 index 7928875259b9e51da9feac3ec66766b07f1b6860..0000000000000000000000000000000000000000 Binary files a/aligned_nso_tsn.csv.zip and /dev/null differ diff --git a/aligned_nso_tso.csv.zip b/aligned_nso_tso.csv.zip deleted file mode 100644 index 264862891159ab0b94cf7a1b905397cfd25cc094..0000000000000000000000000000000000000000 Binary files a/aligned_nso_tso.csv.zip and /dev/null differ diff --git a/aligned_nso_ven.csv.zip b/aligned_nso_ven.csv.zip deleted file mode 100644 index ee4c13c6a09e335eb6b30bd1a968aad20fefdb22..0000000000000000000000000000000000000000 Binary files a/aligned_nso_ven.csv.zip and /dev/null differ diff --git a/aligned_nso_xho.csv.zip b/aligned_nso_xho.csv.zip deleted file mode 100644 index 74b2a9622b280b6b4c1aeaf7fe54a9cf6e569b0e..0000000000000000000000000000000000000000 Binary files a/aligned_nso_xho.csv.zip and /dev/null differ diff --git a/aligned_nso_zul.csv.zip b/aligned_nso_zul.csv.zip deleted file mode 100644 index a680b1814cf701fcade3975581358a4bef349719..0000000000000000000000000000000000000000 Binary files a/aligned_nso_zul.csv.zip and /dev/null differ diff --git a/aligned_sep_ssw.csv.zip b/aligned_sep_ssw.csv.zip deleted file mode 100644 index ca6768d9de07f6f8a31fc9c5072a7d104e6437f0..0000000000000000000000000000000000000000 Binary files a/aligned_sep_ssw.csv.zip and /dev/null differ diff --git a/aligned_sep_tsn.csv.zip b/aligned_sep_tsn.csv.zip deleted file mode 100644 index 2ed1fc161ddeb1093a87a6d43bd3ffd1799b0bbc..0000000000000000000000000000000000000000 Binary files a/aligned_sep_tsn.csv.zip and /dev/null differ diff --git a/aligned_sep_tso.csv.zip b/aligned_sep_tso.csv.zip deleted file mode 100644 index 225bf55b7f045037745b6c04b7cce91d2de2e547..0000000000000000000000000000000000000000 Binary files a/aligned_sep_tso.csv.zip and /dev/null differ diff --git a/aligned_sep_ven.csv.zip b/aligned_sep_ven.csv.zip deleted file mode 100644 index 8545ad5c21487ef629c6488b3934019d68a5223e..0000000000000000000000000000000000000000 Binary files a/aligned_sep_ven.csv.zip and /dev/null differ diff --git a/aligned_sep_xho.csv.zip b/aligned_sep_xho.csv.zip deleted file mode 100644 index 6ce8bab369c8b1e18466ca3fbf5313e7b16033d1..0000000000000000000000000000000000000000 Binary files a/aligned_sep_xho.csv.zip and /dev/null differ diff --git a/aligned_sep_zul.csv.zip b/aligned_sep_zul.csv.zip deleted file mode 100644 index bbac0542aa2cb78efc18b58057c5643a854c7955..0000000000000000000000000000000000000000 Binary files a/aligned_sep_zul.csv.zip and /dev/null differ diff --git a/aligned_ssw_tsn.csv.zip b/aligned_ssw_tsn.csv.zip deleted file mode 100644 index 9215b73aa572e53b3a42d176522f1d9c2f48379b..0000000000000000000000000000000000000000 Binary files a/aligned_ssw_tsn.csv.zip and /dev/null differ diff --git a/aligned_ssw_tso.csv.zip b/aligned_ssw_tso.csv.zip deleted file mode 100644 index 2ca26a0db7d8af393ef19f121c265cc1561666e3..0000000000000000000000000000000000000000 Binary files a/aligned_ssw_tso.csv.zip and /dev/null differ diff --git a/aligned_ssw_ven.csv.zip b/aligned_ssw_ven.csv.zip deleted file mode 100644 index 81ac421e6ebef15f772118c4ccb13325e52bb962..0000000000000000000000000000000000000000 Binary files a/aligned_ssw_ven.csv.zip and /dev/null differ diff --git a/aligned_ssw_xho.csv.zip b/aligned_ssw_xho.csv.zip deleted file mode 100644 index d36d61063e897e36a808f28993bc446f06861611..0000000000000000000000000000000000000000 Binary files a/aligned_ssw_xho.csv.zip and /dev/null differ diff --git a/aligned_ssw_zul.csv.zip b/aligned_ssw_zul.csv.zip deleted file mode 100644 index 671ce014d8293641452fffd1c50b8193f3df8247..0000000000000000000000000000000000000000 Binary files a/aligned_ssw_zul.csv.zip and /dev/null differ diff --git a/aligned_tsn_tso.csv.zip b/aligned_tsn_tso.csv.zip deleted file mode 100644 index 29b147a7775bf7491c1b0261ea0d544b442fdb8e..0000000000000000000000000000000000000000 Binary files a/aligned_tsn_tso.csv.zip and /dev/null differ diff --git a/aligned_tsn_ven.csv.zip b/aligned_tsn_ven.csv.zip deleted file mode 100644 index 7daa27d41256436032da5f572a550e75e1aeb9c1..0000000000000000000000000000000000000000 Binary files a/aligned_tsn_ven.csv.zip and /dev/null differ diff --git a/aligned_tsn_xho.csv.zip b/aligned_tsn_xho.csv.zip deleted file mode 100644 index 0d94026aeb71d0983f84dc511fdba869c9dec6fa..0000000000000000000000000000000000000000 Binary files a/aligned_tsn_xho.csv.zip and /dev/null differ diff --git a/aligned_tsn_zul.csv.zip b/aligned_tsn_zul.csv.zip deleted file mode 100644 index 78da95365828e6ab4fc8710b2a1fa86749e860bf..0000000000000000000000000000000000000000 Binary files a/aligned_tsn_zul.csv.zip and /dev/null differ diff --git a/aligned_tso_ven.csv.zip b/aligned_tso_ven.csv.zip deleted file mode 100644 index afadf794a18bb5f4f1ce20220593ba320f9d1e3a..0000000000000000000000000000000000000000 Binary files a/aligned_tso_ven.csv.zip and /dev/null differ diff --git a/aligned_tso_xho.csv.zip b/aligned_tso_xho.csv.zip deleted file mode 100644 index d57870960c5f420b612cc03e65dce40e79395f0b..0000000000000000000000000000000000000000 Binary files a/aligned_tso_xho.csv.zip and /dev/null differ diff --git a/aligned_tso_zul.csv.zip b/aligned_tso_zul.csv.zip deleted file mode 100644 index 2c053839c04a906a09fcba0bc124d2576baee27c..0000000000000000000000000000000000000000 Binary files a/aligned_tso_zul.csv.zip and /dev/null differ diff --git a/aligned_ven_xho.csv.zip b/aligned_ven_xho.csv.zip deleted file mode 100644 index 79cb250f309ac2c8cc2a2bd140ff4b5343b23e15..0000000000000000000000000000000000000000 Binary files a/aligned_ven_xho.csv.zip and /dev/null differ diff --git a/aligned_ven_zul.csv.zip b/aligned_ven_zul.csv.zip deleted file mode 100644 index 8be4c56e827659444f5cc7f7aa68c0097304ef43..0000000000000000000000000000000000000000 Binary files a/aligned_ven_zul.csv.zip and /dev/null differ diff --git a/aligned_xho_zul.csv.zip b/aligned_xho_zul.csv.zip deleted file mode 100644 index 93e4effe1d0e325af8a60ef83bd7d331aa470eaf..0000000000000000000000000000000000000000 Binary files a/aligned_xho_zul.csv.zip and /dev/null differ diff --git a/compress.py b/compress.py deleted file mode 100644 index 6a2f0db27928926d4a04f3120e45f01edff249d0..0000000000000000000000000000000000000000 --- a/compress.py +++ /dev/null @@ -1,16 +0,0 @@ -import os, zipfile - -def compress_to_zip(input_file, output_zip): - with zipfile.ZipFile(output_zip, 'w', zipfile.ZIP_DEFLATED) as zipf: - zipf.write(input_file, arcname=input_file) - -if __name__ == "__main__": - csvs = os.listdir('.') - csvs.remove('LICENSE.md') - csvs.remove('README.md') - csvs.remove('.git') - csvs.remove('compress.py') - csvs.remove('.gitattributes') - # csvs.remove('.DS_store') - for csv in csvs: - compress_to_zip(csv, f'{csv}.zip') \ No newline at end of file diff --git a/testing.py b/testing.py new file mode 100644 index 0000000000000000000000000000000000000000..b9edcd5ba5305a26c9a9c71e6e1d216a6ff58859 --- /dev/null +++ b/testing.py @@ -0,0 +1,9 @@ +# from datasets import load_dataset +# dataset = load_dataset('vukuzenzele-sentence-aligned.py', 'aligned-afr-eng.jsonl') + +from itertools import combinations +from pprint import pprint +LANGUAGES = ['afr', 'eng', 'nbl', 'nso', 'sot', 'ssw', 'tsn', 'tso', 'ven', 'xho', 'zul'] +LANGUAGE_PAIRS = list(combinations(LANGUAGES, 2)) + +pprint(LANGUAGE_PAIRS) \ No newline at end of file diff --git a/vukuzenzele-sentence-aligned.py b/vukuzenzele-sentence-aligned.py new file mode 100644 index 0000000000000000000000000000000000000000..adbb1949e78842d3881f48fbccf6f1c25cef524a --- /dev/null +++ b/vukuzenzele-sentence-aligned.py @@ -0,0 +1,97 @@ + +"""TODO: Add a description here.""" + + +import csv +import json +import os + +import datasets + +from itertools import combinations + +LANGUAGES = ['afr', 'eng', 'nbl', 'nso', 'sot', 'ssw', 'tsn', 'tso', 'ven', 'xho', 'zul'] +LANGUAGE_PAIRS = list(combinations(LANGUAGES, 2)) + +_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. +""" + +_HOMEPAGE = "https://arxiv.org/abs/2303.03750" + +_LICENSE = "CC 4.0 BY" + +_URL = "https://raw.githubusercontent.com/dsfsi/vukuzenzele-nlp/master/data/opt_aligned_out/" + +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 = [] + + for pair in LANGUAGE_PAIRS: + name = "aligned-{}-{}.jsonl".format(pair[0], pair[1]) + description = "Vukuzenzele {}-{} aligned dataset".format(pair[0], pair[1]) + BUILDER_CONFIGS.append(datasets.BuilderConfig(name=f"{name}", version=VERSION, description=f"{description}"),) + + def _info(self): + features = datasets.Features( + { + "src": datasets.Value("string"), + "tgt": datasets.Value("string"), + "score": datasets.Value("float"), + } + ) + 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}" + } + 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) + yield key, { + "src": data["src"], + "tgt": data["tgt"], + "score": data["score"], + } + \ No newline at end of file