Upload README.md with huggingface_hub

README.md

@@ -1,24 +1,62 @@
+
 ---
-tags:
-- named-entity-recognition
-language:
+language: 
 - ind
+pretty_name: Singgalang
+task_categories: 
+- named-entity-recognition
+tags: 
+- named-entity-recognition
 ---
 
-# singgalang
-
 Rule-based annotation Indonesian NER Dataset of 48,957 sentences or 1,478,286 tokens.
-
 Annotation conforms the Stanford-NER format (https://stanfordnlp.github.io/CoreNLP/ner.html) for 3 NER tags of Person, Organisation, and Place.
-
 This dataset consists of 41,297, 14,770, and 82,179 tokens of entity (respectively) from over 14, 6, and 5 rules.
 
+
+## Languages
+
+ind
+
+## Supported Tasks
+
+Named Entity Recognition
+    
 ## Dataset Usage
+### Using `datasets` library
+```
+    from datasets import load_dataset
+    dset = datasets.load_dataset("SEACrowd/singgalang", trust_remote_code=True)
+```
+### Using `seacrowd` library
+```import seacrowd as sc
+# Load the dataset using the default config
+    dset = sc.load_dataset("singgalang", schema="seacrowd")
+# Check all available subsets (config names) of the dataset
+    print(sc.available_config_names("singgalang"))
+# 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).
+    
 
-Run `pip install nusacrowd` before loading the dataset through HuggingFace's `load_dataset`.
+## Dataset Homepage
+
+[https://github.com/ir-nlp-csui/singgalang](https://github.com/ir-nlp-csui/singgalang)
+
+## Dataset Version
+
+Source: 1.0.0. SEACrowd: 2024.06.20.
+
+## Dataset License
+
+You can use this dataset for free. You don't need our permission to use it. Please cite our paper if your work uses our data in your publication.
+Please note that you are not allowed to create a copy of this dataset and share it publicly in your own repository without our permission.
 
 ## Citation
 
+If you are using the **Singgalang** dataloader in your work, please cite the following:
 ```
 @INPROCEEDINGS{8355036,
   author={Alfina, Ika and Savitri, Septiviana and Fanany, Mohamad Ivan},
@@ -36,17 +74,14 @@ Run `pip install nusacrowd` before loading the dataset through HuggingFace's `lo
   year={2016},
   pages={335-340},
   doi={10.1109/ICACSIS.2016.7872784}}
-```
-
-## License
 
-You can use this dataset for free. You don't need our permission to use it. Please cite our paper if your work uses our data in your publication.
-Please note that you are not allowed to create a copy of this dataset and share it publicly in your own repository without our permission.
-
-## Homepage
-
-[https://github.com/ir-nlp-csui/singgalang](https://github.com/ir-nlp-csui/singgalang)
 
-### 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)
+```