Upload README.md with huggingface_hub

README.md

@@ -1,8 +1,6 @@
+
 ---
-license: unknown
-tags:
-- machine-translation
-language:
+language: 
 - ind
 - jav
 - xdy
@@ -13,38 +11,68 @@ language:
 - bbc
 - msa
 - min
+pretty_name: Korpus Nusantara
+task_categories: 
+- machine-translation
+tags: 
+- machine-translation
 ---
 
-# korpus_nusantara
-
 This parallel corpus was collected from several studies, assignments, and thesis of 
-
 students of the Informatics Study Program, Tanjungpura University. Some of the corpus 
-
 are used in the translation machine from Indonesian to local languages http://nustor.untan.ac.id/cammane/. 
-
 This corpus can be used freely for research purposes by citing the paper 
-
 https://ijece.iaescore.com/index.php/IJECE/article/download/20046/13738.
 
-
-
 The dataset is a combination of multiple machine translation works from the author, 
-
 Herry Sujaini, covering Indonesian to 25 local dialects in Indonesia. Since not all 
-
 dialects have ISO639-3 standard coding, as agreed with Pak Herry , we decided to 
-
 group the dataset into the closest language family, i.e.: Javanese, Dayak, Buginese, 
-
 Sundanese, Madurese, Banjar, Batak Toba, Khek, Malay, Minangkabau, and Tiociu.
 
+
+## Languages
+
+ind, jav, xdy, bug, sun, mad, bjn, bbc, khek, msa, min, tiociu
+
+## Supported Tasks
+
+Machine Translation
+    
 ## Dataset Usage
+### Using `datasets` library
+```
+    from datasets import load_dataset
+    dset = datasets.load_dataset("SEACrowd/korpus_nusantara", trust_remote_code=True)
+```
+### Using `seacrowd` library
+```import seacrowd as sc
+# Load the dataset using the default config
+    dset = sc.load_dataset("korpus_nusantara", schema="seacrowd")
+# Check all available subsets (config names) of the dataset
+    print(sc.available_config_names("korpus_nusantara"))
+# Load the dataset using a specific config
+    dset = sc.load_dataset_by_config_name(config_name="<config_name>")
+```
+    
+    More details on how to load the `seacrowd` library can be found [here](https://github.com/SEACrowd/seacrowd-datahub?tab=readme-ov-file#how-to-use).
+    
+
+## Dataset Homepage
+
+[https://github.com/herrysujaini/korpusnusantara](https://github.com/herrysujaini/korpusnusantara)
+
+## Dataset Version
+
+Source: 1.0.0. SEACrowd: 2024.06.20.
 
-Run `pip install nusacrowd` before loading the dataset through HuggingFace's `load_dataset`.
+## Dataset License
+
+Unknown
 
 ## Citation
 
+If you are using the **Korpus Nusantara** dataloader in your work, please cite the following:
 ```
 @article{sujaini2020improving,
   title={Improving the role of language model in statistical machine translation (Indonesian-Javanese)},
@@ -56,16 +84,14 @@ Run `pip install nusacrowd` before loading the dataset through HuggingFace's `lo
   year={2020},
   publisher={IAES Institute of Advanced Engineering and Science}
 }
-```
 
-## License
-
-Unknown
 
-## Homepage
-
-[https://github.com/herrysujaini/korpusnusantara](https://github.com/herrysujaini/korpusnusantara)
-
-### NusaCatalogue
+@article{lovenia2024seacrowd,
+    title={SEACrowd: A Multilingual Multimodal Data Hub and Benchmark Suite for Southeast Asian Languages}, 
+    author={Holy Lovenia and Rahmad Mahendra and Salsabil Maulana Akbar and Lester James V. Miranda and Jennifer Santoso and Elyanah Aco and Akhdan Fadhilah and Jonibek Mansurov and Joseph Marvin Imperial and Onno P. Kampman and Joel Ruben Antony Moniz and Muhammad Ravi Shulthan Habibi and Frederikus Hudi and Railey Montalan and Ryan Ignatius and Joanito Agili Lopo and William Nixon and Börje F. Karlsson and James Jaya and Ryandito Diandaru and Yuze Gao and Patrick Amadeus and Bin Wang and Jan Christian Blaise Cruz and Chenxi Whitehouse and Ivan Halim Parmonangan and Maria Khelli and Wenyu Zhang and Lucky Susanto and Reynard Adha Ryanda and Sonny Lazuardi Hermawan and Dan John Velasco and Muhammad Dehan Al Kautsar and Willy Fitra Hendria and Yasmin Moslem and Noah Flynn and Muhammad Farid Adilazuarda and Haochen Li and Johanes Lee and R. Damanhuri and Shuo Sun and Muhammad Reza Qorib and Amirbek Djanibekov and Wei Qi Leong and Quyet V. Do and Niklas Muennighoff and Tanrada Pansuwan and Ilham Firdausi Putra and Yan Xu and Ngee Chia Tai and Ayu Purwarianti and Sebastian Ruder and William Tjhi and Peerat Limkonchotiwat and Alham Fikri Aji and Sedrick Keh and Genta Indra Winata and Ruochen Zhang and Fajri Koto and Zheng-Xin Yong and Samuel Cahyawijaya},
+    year={2024},
+    eprint={2406.10118},
+    journal={arXiv preprint arXiv: 2406.10118}
+}
 
-For easy indexing and metadata: [https://indonlp.github.io/nusa-catalogue](https://indonlp.github.io/nusa-catalogue)
+```