Upload README.md with huggingface_hub

README.md

@@ -1,30 +1,64 @@
+
 ---
-tags:
-- sentiment-analysis
-language:
+language: 
 - ind
+pretty_name: Id Clickbait
+task_categories: 
+- sentiment-analysis
+tags: 
+- sentiment-analysis
 ---
 
-# id_clickbait
-
 The CLICK-ID dataset is a collection of Indonesian news headlines that was collected from 12 local online news
-
 publishers; detikNews, Fimela, Kapanlagi, Kompas, Liputan6, Okezone, Posmetro-Medan, Republika, Sindonews, Tempo,
-
 Tribunnews, and Wowkeren. This dataset is comprised of mainly two parts; (i) 46,119 raw article data, and (ii)
-
 15,000 clickbait annotated sample headlines. Annotation was conducted with 3 annotator examining each headline.
-
 Judgment were based only on the headline. The majority then is considered as the ground truth. In the annotated
-
 sample, our annotation shows 6,290 clickbait and 8,710 non-clickbait.
 
+
+## Languages
+
+ind
+
+## Supported Tasks
+
+Sentiment Analysis
+    
 ## Dataset Usage
+### Using `datasets` library
+```
+    from datasets import load_dataset
+    dset = datasets.load_dataset("SEACrowd/id_clickbait", trust_remote_code=True)
+```
+### Using `seacrowd` library
+```import seacrowd as sc
+# Load the dataset using the default config
+    dset = sc.load_dataset("id_clickbait", schema="seacrowd")
+# Check all available subsets (config names) of the dataset
+    print(sc.available_config_names("id_clickbait"))
+# 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://www.sciencedirect.com/science/article/pii/S2352340920311252#!](https://www.sciencedirect.com/science/article/pii/S2352340920311252#!)
 
-Run `pip install nusacrowd` before loading the dataset through HuggingFace's `load_dataset`.
+## Dataset Version
+
+Source: 1.0.0. SEACrowd: 2024.06.20.
+
+## Dataset License
+
+Creative Commons Attribution 4.0 International
 
 ## Citation
 
+If you are using the **Id Clickbait** dataloader in your work, please cite the following:
 ```
 @article{WILLIAM2020106231,
 title = "CLICK-ID: A novel dataset for Indonesian clickbait headlines",
@@ -39,16 +73,14 @@ author = "Andika William and Yunita Sari",
 keywords = "Indonesian, Natural Language Processing, News articles, Clickbait, Text-classification",
 abstract = "News analysis is a popular task in Natural Language Processing (NLP). In particular, the problem of clickbait in news analysis has gained attention in recent years [1, 2]. However, the majority of the tasks has been focused on English news, in which there is already a rich representative resource. For other languages, such as Indonesian, there is still a lack of resource for clickbait tasks. Therefore, we introduce the CLICK-ID dataset of Indonesian news headlines extracted from 12 Indonesian online news publishers. It is comprised of 15,000 annotated headlines with clickbait and non-clickbait labels. Using the CLICK-ID dataset, we then developed an Indonesian clickbait classification model achieving favourable performance. We believe that this corpus will be useful for replicable experiments in clickbait detection or other experiments in NLP areas."
 }
-```
-
-## License
-
-Creative Commons Attribution 4.0 International
 
-## Homepage
 
-[https://www.sciencedirect.com/science/article/pii/S2352340920311252#!](https://www.sciencedirect.com/science/article/pii/S2352340920311252#!)
-
-### 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)
+```