Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,117 @@
+
+---
+license: cc-by-sa-3.0
+language: 
+- ind
+- kod
+- ceb
+- hil
+- tgl
+pretty_name: Unimorph
+task_categories: 
+- morphological-inflection
+tags: 
+- morphological-inflection
+---
+
+The Universal Morphology (UniMorph) project is a collaborative effort providing
+broad-coverage instantiated normalized morphological inflection tables for
+undreds of diverse world languages. The project comprises two major thrusts: a
+language-independent feature schema for rich morphological annotation, and a
+type-level resource of annotated data in diverse languages realizing that
+schema. 5 Austronesian languages spoken in Southeast Asia, consisting 2
+Malayo-Polynesian languages and 3 Greater Central Philippine languages, become
+the part of UniMorph 4.0 release.
+
+
+## Languages
+
+ind, kod, ceb, hil, tgl
+
+## Supported Tasks
+
+Morphological Inflection
+    
+## Dataset Usage
+### Using `datasets` library
+```
+    from datasets import load_dataset
+    dset = datasets.load_dataset("SEACrowd/unimorph", trust_remote_code=True)
+```
+### Using `seacrowd` library
+```import seacrowd as sc
+# Load the dataset using the default config
+    dset = sc.load_dataset("unimorph", schema="seacrowd")
+# Check all available subsets (config names) of the dataset
+    print(sc.available_config_names("unimorph"))
+# 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://unimorph.github.io](https://unimorph.github.io)
+
+## Dataset Version
+
+Source: 4.0.0. SEACrowd: 2024.06.20.
+
+## Dataset License
+
+Creative Commons Attribution Share Alike 3.0 (cc-by-sa-3.0)
+
+## Citation
+
+If you are using the **Unimorph** dataloader in your work, please cite the following:
+```
+
+@misc{batsuren2022unimorph,
+      title={UniMorph 4.0: Universal Morphology},
+      author={
+        Khuyagbaatar Batsuren and Omer Goldman and Salam Khalifa and Nizar
+        Habash and Witold Kieraś and Gábor Bella and Brian Leonard and Garrett
+        Nicolai and Kyle Gorman and Yustinus Ghanggo Ate and Maria Ryskina and
+        Sabrina J. Mielke and Elena Budianskaya and Charbel El-Khaissi and Tiago
+        Pimentel and Michael Gasser and William Lane and Mohit Raj and Matt
+        Coler and Jaime Rafael Montoya Samame and Delio Siticonatzi Camaiteri
+        and Benoît Sagot and Esaú Zumaeta Rojas and Didier López Francis and
+        Arturo Oncevay and Juan López Bautista and Gema Celeste Silva Villegas
+        and Lucas Torroba Hennigen and Adam Ek and David Guriel and Peter Dirix
+        and Jean-Philippe Bernardy and Andrey Scherbakov and Aziyana Bayyr-ool
+        and Antonios Anastasopoulos and Roberto Zariquiey and Karina Sheifer and
+        Sofya Ganieva and Hilaria Cruz and Ritván Karahóǧa and Stella
+        Markantonatou and George Pavlidis and Matvey Plugaryov and Elena
+        Klyachko and Ali Salehi and Candy Angulo and Jatayu Baxi and Andrew
+        Krizhanovsky and Natalia Krizhanovskaya and Elizabeth Salesky and Clara
+        Vania and Sardana Ivanova and Jennifer White and Rowan Hall Maudslay and
+        Josef Valvoda and Ran Zmigrod and Paula Czarnowska and Irene Nikkarinen
+        and Aelita Salchak and Brijesh Bhatt and Christopher Straughn and Zoey
+        Liu and Jonathan North Washington and Yuval Pinter and Duygu Ataman and
+        Marcin Wolinski and Totok Suhardijanto and Anna Yablonskaya and Niklas
+        Stoehr and Hossep Dolatian and Zahroh Nuriah and Shyam Ratan and Francis
+        M. Tyers and Edoardo M. Ponti and Grant Aiton and Aryaman Arora and
+        Richard J. Hatcher and Ritesh Kumar and Jeremiah Young and Daria
+        Rodionova and Anastasia Yemelina and Taras Andrushko and Igor Marchenko
+        and Polina Mashkovtseva and Alexandra Serova and Emily Prud'hommeaux and
+        Maria Nepomniashchaya and Fausto Giunchiglia and Eleanor Chodroff and
+        Mans Hulden and Miikka Silfverberg and Arya D. McCarthy and David
+        Yarowsky and Ryan Cotterell and Reut Tsarfaty and Ekaterina Vylomova},
+      year={2022},
+      eprint={2205.03608},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+
+
+@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}
+}
+
+```