Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,101 @@
+
+---
+license: lgpl
+language: 
+- bik
+- ceb
+- hil
+- ilo
+- tgl
+- pam
+- pag
+- war
+pretty_name: Palito
+task_categories: 
+- self-supervised-pretraining
+tags: 
+- self-supervised-pretraining
+---
+
+This paper aims at describing the building of the online corpora on Philippine
+languages as part of the online repository system called Palito. There are five components
+of the corpora: the top four major Philippine languages which are Tagalog, Cebuano,
+Ilocano and Hiligaynon and the Filipino Sign Language (FSL). The four languages are
+composed of 250,000-word written texts each, whereas the FSL is composed of seven
+thousand signs in video format. Categories of the written texts include creative writing (such
+as novels and stories) and religious texts (such as the Bible). Automated tools are provided
+for language analysis such as word count, collocates, and others. This is part of a bigger
+corpora building project for Philippine languages that would consider text, speech and
+video forms, and the corresponding development of automated tools for language analysis
+of these various forms.
+
+
+## Languages
+
+bik, ceb, hil, ilo, tgl, pam, pag, war
+
+## Supported Tasks
+
+Self Supervised Pretraining
+    
+## Dataset Usage
+### Using `datasets` library
+```
+    from datasets import load_dataset
+    dset = datasets.load_dataset("SEACrowd/palito", trust_remote_code=True)
+```
+### Using `seacrowd` library
+```import seacrowd as sc
+# Load the dataset using the default config
+    dset = sc.load_dataset("palito", schema="seacrowd")
+# Check all available subsets (config names) of the dataset
+    print(sc.available_config_names("palito"))
+# 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/imperialite/Philippine-Languages-Online-Corpora/tree/master/PALITO%20Corpus](https://github.com/imperialite/Philippine-Languages-Online-Corpora/tree/master/PALITO%20Corpus)
+
+## Dataset Version
+
+Source: 1.0.0. SEACrowd: 2024.06.20.
+
+## Dataset License
+
+GNU Lesser General Public License family (lgpl)
+
+## Citation
+
+If you are using the **Palito** dataloader in your work, please cite the following:
+```
+
+@inproceedings{dita-etal-2009-building,
+    title = "Building Online Corpora of {P}hilippine Languages",
+    author = "Dita, Shirley N.  and
+      Roxas, Rachel Edita O.  and
+      Inventado, Paul",
+    editor = "Kwong, Olivia",
+    booktitle = "Proceedings of the 23rd Pacific Asia Conference on Language, Information and Computation, Volume 2",
+    month = dec,
+    year = "2009",
+    address = "Hong Kong",
+    publisher = "City University of Hong Kong",
+    url = "https://aclanthology.org/Y09-2024",
+    pages = "646--653",
+}
+
+
+@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}
+}
+
+```