Upload README.md with huggingface_hub

README.md

@@ -1,52 +1,90 @@
+
 ---
-tags:
-- named-entity-recognition
-language:
+license: apache-2.0
+language: 
 - ind
-- eng
 - jav
 - min
 - sun
 - ace
-- mly
+- zlm
+- mya
+- tgl
+- tha
+- vie
+- khm
+pretty_name: Wikiann
+task_categories: 
+- named-entity-recognition
+tags: 
+- named-entity-recognition
 ---
 
-# wikiann
-
 The wikiann dataset contains NER tags with labels from O (0), B-PER (1), I-PER (2), B-ORG (3), I-ORG (4), B-LOC (5), I-LOC (6). The Indonesian subset is used.
-
 WikiANN (sometimes called PAN-X) is a multilingual named entity recognition dataset consisting of Wikipedia articles
-
  annotated with LOC (location), PER (person), and ORG (organisation)
-
  tags in the IOB2 format. This version corresponds to the balanced train, dev, and test splits of
-
   Rahimi et al. (2019), and uses the following subsets from the original WikiANN corpus
 
-
-
 Language	WikiAnn	ISO 639-3
-
 Indonesian	id	ind
-
 Javanese	jv	jav
-
 Minangkabau	min	min
-
 Sundanese	su	sun
-
 Acehnese	ace	ace
+Malay	ms	zlm
+Banyumasan	map-bms	map-bms
+Myanmar my mya
+Tagalog tl tgl
+Thailand th tha
+Vietnam vi vie
+Khmer km khm
+
 
-Malay	ms	mly
 
-Banyumasan	map-bms	map-bms
 
+## Languages
+
+ind, jav, min, sun, ace, zlm, map-bms, mya, tgl, tha, vie, khm
+
+## Supported Tasks
+
+Named Entity Recognition
+    
 ## Dataset Usage
+### Using `datasets` library
+```
+    from datasets import load_dataset
+    dset = datasets.load_dataset("SEACrowd/wikiann", trust_remote_code=True)
+```
+### Using `seacrowd` library
+```import seacrowd as sc
+# Load the dataset using the default config
+    dset = sc.load_dataset("wikiann", schema="seacrowd")
+# Check all available subsets (config names) of the dataset
+    print(sc.available_config_names("wikiann"))
+# 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/afshinrahimi/mmner](https://github.com/afshinrahimi/mmner)
 
-Run `pip install nusacrowd` before loading the dataset through HuggingFace's `load_dataset`.
+## Dataset Version
+
+Source: 1.1.0. SEACrowd: 2024.06.20.
+
+## Dataset License
+
+Apache license 2.0 (apache-2.0)
 
 ## Citation
 
+If you are using the **Wikiann** dataloader in your work, please cite the following:
 ```
 @inproceedings{pan-etal-2017-cross,
     title = "Cross-lingual Name Tagging and Linking for 282 Languages",
@@ -88,16 +126,14 @@ Run `pip install nusacrowd` before loading the dataset through HuggingFace's `lo
     url = "https://www.aclweb.org/anthology/P19-1015",
     pages = "151--164",
 }
-```
-
-## License
 
-Apache-2.0 license
 
-## Homepage
-
-[https://github.com/afshinrahimi/mmner](https://github.com/afshinrahimi/mmner)
-
-### 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)
+```