Merge branch 'main' of https://huggingface.co/tupleblog/salim-classifier into main

README.md

@@ -3,6 +3,8 @@ widget:
 - text: "รัฐรับผิดชอบทุกชีวิตไม่ได้หรอกคนให้บริการต้องจัดการเองถ้าจะเปิดผับบาร์"
 ---
 
+![Salim Word Cloud](https://raw.githubusercontent.com/tupleblog/salim-classifier/main/images/wordcloud.jpg)
+
 # Salim-Classifier
 
 **วัตถุประสงค์:** ทุกวันนี้หาเพื่อนที่รักชาติ ศาสนา พระมหากษัตริย์ รัฐบาลยากเหลือเกิน มีแต่พวกสามกีบ ควายแดงคอยจ้องจะทำร้าย
@@ -13,13 +15,17 @@ widget:
 สามารถลง `transfomers` จาก Huggingface และใช้งานโมเดลได้ดังต่อไปนี้
 
 ``` py
-from transformers import AutoTokenizer, AutoModelForSequenceClassification, pipeline
+from transformers import (
+    AutoTokenizer,
+    AutoModelForSequenceClassification,
+    pipeline
+)
 
-# download model
+# download model from hub
 tokenizer = AutoTokenizer.from_pretrained("tupleblog/salim-classifier")
 model = AutoModelForSequenceClassification.from_pretrained("tupleblog/salim-classifier")
 
-# using pipeline
+# using pipeline to classify an input text
 classifier = pipeline("sentiment-analysis", model=model, tokenizer=tokenizer)
 text = "จิตไม่ปกติ วันๆคอยแต่ให้คนเสี้ยมทะเลาะกันด่ากัน คอยจ้องแต่จะเล่นงานรัฐบาล ความคดด้านลบ"
 classifier(text)
@@ -28,8 +34,8 @@ classifier(text)
 
 ## การเก็บข้อมูล
 
-เก็บข้อมูลจากเพจ Facebook ที่มีชาวสลิ่มเข้าไปคอมเม้น คัดเลือกชุดประโยคที่มีความยาวมากกว่า 50 ตัวอักษร
-และทำการ Annotate จากนั้นนำข้อมูลมาเทรนโมเดลด้วย WangchanBERTa (ข้อมูลอาจมีความ bias เนื่องจากทางทีมงานเป็นผู้เก็บข้อมูลเอง)
+สร้างข้อมูลตัวอย่างและทำการ Annotate จากนั้นนำข้อมูลมาเทรนโมเดลด้วย WangchanBERTa
+โดยข้อมูลอาจมีความ bias เนื่องจากทางทีมงานเป็นผู้เก็บข้อมูลเอง
 
 ## ทดลองใช้งานผ่าน HuggingFace
 
@@ -43,6 +49,12 @@ classifier(text)
 - ถ้าไม่ชอบประชาธิปไตย จะไปใช้วิธีการปกครองแบบไหนหรอครับ แล้วแบบไหนถึงดีหรอ ผมไม่เข้าใจครับอดีตผ่านไปแล้ว ทำไมไม่มองที่อนาคตกันหละครับ
 - อีพวกสามกีบ`<pad>`
 
-สำหรับข้อความที่สั้นกว่า 50 ตัวอักษรแนะนำให้เติม `<pad>` ตามหลังข้อความ
+สำหรับข้อความที่สั้นกว่า 50 ตัวอักษรแนะนำให้เติม `<pad>` ตามหลังข้อความเพื่อความแม่นยำที่สูงขึ้น
+
+## Performance
+
+We report performance on 20% evaluation set (accuracy, precision, recall, F1-score macro) as follows:
 
-ทางทีมงานกำลังเขียนแอพพลิเคชั่นเพื่อให้สามารถนำไปใช้งานได้ง่ายยิ่งขึ้น
+| Accuracy | Precision | Recall |   F1   |
+| -------- | --------- | ------ | ------ |
+| 75.54%   | 75.13%    | 74.78%  | 74.92%  |