Upload README.md with huggingface_hub

README.md

@@ -1,32 +1,65 @@
+
 ---
-tags:
-- keyword-extraction
-language:
+language: 
 - ind
+pretty_name: Keps
+task_categories: 
+- keyword-extraction
+tags: 
+- keyword-extraction
 ---
 
-# keps
-
 The KEPS dataset (Mahfuzh, Soleman and Purwarianti, 2019) consists of text from Twitter
-
 discussing banking products and services and is written in the Indonesian language. A phrase
-
 containing important information is considered a keyphrase. Text may contain one or more
-
 keyphrases since important phrases can be located at different positions.
-
 - tokens: a list of string features.
-
 - seq_label: a list of classification labels, with possible values including O, B, I.
-
 The labels use Inside-Outside-Beginning (IOB) tagging.
 
+
+## Languages
+
+ind
+
+## Supported Tasks
+
+Keyword Extraction
+    
 ## Dataset Usage
+### Using `datasets` library
+```
+    from datasets import load_dataset
+    dset = datasets.load_dataset("SEACrowd/keps", trust_remote_code=True)
+```
+### Using `seacrowd` library
+```import seacrowd as sc
+# Load the dataset using the default config
+    dset = sc.load_dataset("keps", schema="seacrowd")
+# Check all available subsets (config names) of the dataset
+    print(sc.available_config_names("keps"))
+# 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/IndoNLP/indonlu](https://github.com/IndoNLP/indonlu)
+
+## Dataset Version
+
+Source: 1.0.0. SEACrowd: 2024.06.20.
+
+## Dataset License
 
-Run `pip install nusacrowd` before loading the dataset through HuggingFace's `load_dataset`.
+Creative Common Attribution Share-Alike 4.0 International
 
 ## Citation
 
+If you are using the **Keps** dataloader in your work, please cite the following:
 ```
 @inproceedings{mahfuzh2019improving,
   title={Improving Joint Layer RNN based Keyphrase Extraction by Using Syntactical Features},
@@ -36,16 +69,14 @@ Run `pip install nusacrowd` before loading the dataset through HuggingFace's `lo
   year={2019},
   organization={IEEE}
 }
-```
-
-## License
-
-Creative Common Attribution Share-Alike 4.0 International
-
-## Homepage
 
-[https://github.com/IndoNLP/indonlu](https://github.com/IndoNLP/indonlu)
 
-### 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)
+```