Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,84 @@
+
+---
+license: cc-by-nc-sa-4.0
+language: 
+- mya
+pretty_name: Burmese Romanize
+task_categories: 
+- transliteration
+tags: 
+- transliteration
+---
+
+This dataset consists of 2,335 Burmese names from real university students and faculty,
+public figures, and minorities from Myanmar. Each entry includes the original name in
+Burmese script, its corresponding Romanization, and the aligned Burmese and Latin
+graphemes.
+
+
+## Languages
+
+mya
+
+## Supported Tasks
+
+Transliteration
+    
+## Dataset Usage
+### Using `datasets` library
+```
+    from datasets import load_dataset
+    dset = datasets.load_dataset("SEACrowd/burmese_romanize", trust_remote_code=True)
+```
+### Using `seacrowd` library
+```import seacrowd as sc
+# Load the dataset using the default config
+    dset = sc.load_dataset("burmese_romanize", schema="seacrowd")
+# Check all available subsets (config names) of the dataset
+    print(sc.available_config_names("burmese_romanize"))
+# 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
+
+[http://www.nlpresearch-ucsy.edu.mm/NLP_UCSY/name-db.html](http://www.nlpresearch-ucsy.edu.mm/NLP_UCSY/name-db.html)
+
+## Dataset Version
+
+Source: 1.0.0. SEACrowd: 2024.06.20.
+
+## Dataset License
+
+Creative Commons Attribution Non Commercial Share Alike 4.0 (cc-by-nc-sa-4.0)
+
+## Citation
+
+If you are using the **Burmese Romanize** dataloader in your work, please cite the following:
+```
+@inproceedings{chenchen2017statistical,
+    author    = {Ding Chenchen and
+                Chea Vichet and
+                Pa Win Pa and
+                Utiyama Masao and
+                Sumita Eiichiro},
+    title     = {Statistical Romanization for Abugida Scripts: Data and Experiment on Khmer and Burmese},
+    booktitle = {Proceedings of the 23rd Annual Conference of the Association for Natural Language Processing,
+                {NLP2017}, Tsukuba, Japan, 13-17 March 2017},
+    year      = {2017},
+    url       = {https://www.anlp.jp/proceedings/annual_meeting/2017/pdf_dir/P5-7.pdf},
+}
+
+
+@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}
+}
+
+```