Update README.md
Browse files
README.md
CHANGED
|
@@ -1,199 +1,149 @@
|
|
| 1 |
---
|
| 2 |
library_name: transformers
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 4 |
---
|
| 5 |
|
| 6 |
-
#
|
| 7 |
|
| 8 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 9 |
|
|
|
|
| 10 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 11 |
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
### Model Description
|
| 15 |
-
|
| 16 |
-
<!-- Provide a longer summary of what this model is. -->
|
| 17 |
-
|
| 18 |
-
This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
|
| 19 |
-
|
| 20 |
-
- **Developed by:** [More Information Needed]
|
| 21 |
-
- **Funded by [optional]:** [More Information Needed]
|
| 22 |
-
- **Shared by [optional]:** [More Information Needed]
|
| 23 |
-
- **Model type:** [More Information Needed]
|
| 24 |
-
- **Language(s) (NLP):** [More Information Needed]
|
| 25 |
-
- **License:** [More Information Needed]
|
| 26 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
| 27 |
-
|
| 28 |
-
### Model Sources [optional]
|
| 29 |
-
|
| 30 |
-
<!-- Provide the basic links for the model. -->
|
| 31 |
-
|
| 32 |
-
- **Repository:** [More Information Needed]
|
| 33 |
-
- **Paper [optional]:** [More Information Needed]
|
| 34 |
-
- **Demo [optional]:** [More Information Needed]
|
| 35 |
-
|
| 36 |
-
## Uses
|
| 37 |
-
|
| 38 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 39 |
-
|
| 40 |
-
### Direct Use
|
| 41 |
-
|
| 42 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 43 |
-
|
| 44 |
-
[More Information Needed]
|
| 45 |
-
|
| 46 |
-
### Downstream Use [optional]
|
| 47 |
-
|
| 48 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
| 49 |
-
|
| 50 |
-
[More Information Needed]
|
| 51 |
-
|
| 52 |
-
### Out-of-Scope Use
|
| 53 |
-
|
| 54 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
| 55 |
-
|
| 56 |
-
[More Information Needed]
|
| 57 |
-
|
| 58 |
-
## Bias, Risks, and Limitations
|
| 59 |
-
|
| 60 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
| 61 |
-
|
| 62 |
-
[More Information Needed]
|
| 63 |
-
|
| 64 |
-
### Recommendations
|
| 65 |
-
|
| 66 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
| 67 |
-
|
| 68 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
| 69 |
-
|
| 70 |
-
## How to Get Started with the Model
|
| 71 |
|
| 72 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 73 |
|
| 74 |
-
|
| 75 |
|
| 76 |
## Training Details
|
| 77 |
|
| 78 |
### Training Data
|
| 79 |
-
|
| 80 |
-
|
| 81 |
-
|
| 82 |
-
[More Information Needed]
|
| 83 |
|
| 84 |
### Training Procedure
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 85 |
|
| 86 |
-
|
| 87 |
-
|
| 88 |
-
#### Preprocessing [optional]
|
| 89 |
-
|
| 90 |
-
[More Information Needed]
|
| 91 |
-
|
| 92 |
-
|
| 93 |
-
#### Training Hyperparameters
|
| 94 |
-
|
| 95 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 96 |
-
|
| 97 |
-
#### Speeds, Sizes, Times [optional]
|
| 98 |
-
|
| 99 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
| 100 |
-
|
| 101 |
-
[More Information Needed]
|
| 102 |
|
| 103 |
## Evaluation
|
| 104 |
|
| 105 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
| 106 |
-
|
| 107 |
### Testing Data, Factors & Metrics
|
| 108 |
|
| 109 |
#### Testing Data
|
| 110 |
-
|
| 111 |
-
|
| 112 |
-
|
| 113 |
-
[More Information Needed]
|
| 114 |
|
| 115 |
#### Factors
|
| 116 |
-
|
| 117 |
-
|
| 118 |
-
|
| 119 |
-
[More Information Needed]
|
| 120 |
|
| 121 |
#### Metrics
|
| 122 |
-
|
| 123 |
-
|
| 124 |
-
|
| 125 |
-
[More Information Needed]
|
| 126 |
|
| 127 |
### Results
|
| 128 |
|
| 129 |
-
|
| 130 |
-
|
| 131 |
-
|
| 132 |
-
|
| 133 |
-
|
| 134 |
-
|
| 135 |
-
|
| 136 |
-
|
| 137 |
-
|
| 138 |
-
|
| 139 |
-
[More Information Needed]
|
| 140 |
-
|
| 141 |
-
## Environmental Impact
|
| 142 |
-
|
| 143 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
| 144 |
|
| 145 |
-
|
| 146 |
-
|
| 147 |
-
- **Hardware Type:** [More Information Needed]
|
| 148 |
-
- **Hours used:** [More Information Needed]
|
| 149 |
-
- **Cloud Provider:** [More Information Needed]
|
| 150 |
-
- **Compute Region:** [More Information Needed]
|
| 151 |
-
- **Carbon Emitted:** [More Information Needed]
|
| 152 |
-
|
| 153 |
-
## Technical Specifications [optional]
|
| 154 |
-
|
| 155 |
-
### Model Architecture and Objective
|
| 156 |
-
|
| 157 |
-
[More Information Needed]
|
| 158 |
-
|
| 159 |
-
### Compute Infrastructure
|
| 160 |
-
|
| 161 |
-
[More Information Needed]
|
| 162 |
-
|
| 163 |
-
#### Hardware
|
| 164 |
-
|
| 165 |
-
[More Information Needed]
|
| 166 |
-
|
| 167 |
-
#### Software
|
| 168 |
-
|
| 169 |
-
[More Information Needed]
|
| 170 |
-
|
| 171 |
-
## Citation [optional]
|
| 172 |
-
|
| 173 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
| 174 |
-
|
| 175 |
-
**BibTeX:**
|
| 176 |
|
| 177 |
-
|
| 178 |
|
| 179 |
-
|
|
|
|
|
|
|
| 180 |
|
| 181 |
-
|
|
|
|
|
|
|
| 182 |
|
| 183 |
-
##
|
|
|
|
|
|
|
| 184 |
|
| 185 |
-
|
| 186 |
|
| 187 |
-
|
|
|
|
|
|
|
|
|
|
| 188 |
|
| 189 |
-
|
| 190 |
|
| 191 |
-
|
| 192 |
|
| 193 |
-
##
|
| 194 |
|
| 195 |
-
|
|
|
|
| 196 |
|
| 197 |
-
|
|
|
|
|
|
|
|
|
|
| 198 |
|
| 199 |
-
|
|
|
|
|
|
| 1 |
---
|
| 2 |
library_name: transformers
|
| 3 |
+
pipeline_tag: text-classification
|
| 4 |
+
language:
|
| 5 |
+
- zh
|
| 6 |
+
tags:
|
| 7 |
+
- sentiment-analysis
|
| 8 |
+
- mario
|
| 9 |
+
- forum
|
| 10 |
+
- off-topic-detection
|
| 11 |
+
license: apache-2.0
|
| 12 |
+
model-index:
|
| 13 |
+
- name: pannnnnnn/4_labels
|
| 14 |
+
results:
|
| 15 |
+
- task:
|
| 16 |
+
type: text-classification
|
| 17 |
+
name: 4-way Sentiment + OT
|
| 18 |
+
metrics:
|
| 19 |
+
- type: accuracy
|
| 20 |
+
value: 0.854
|
| 21 |
+
- type: f1
|
| 22 |
+
name: macro_f1
|
| 23 |
+
value: 0.852
|
| 24 |
+
- type: f1
|
| 25 |
+
name: negative_f1
|
| 26 |
+
value: 0.939
|
| 27 |
+
- type: f1
|
| 28 |
+
name: neutral_f1
|
| 29 |
+
value: 0.774
|
| 30 |
+
- type: f1
|
| 31 |
+
name: positive_f1
|
| 32 |
+
value: 0.804
|
| 33 |
+
- type: f1
|
| 34 |
+
name: ot_f1
|
| 35 |
+
value: 0.891
|
| 36 |
---
|
| 37 |
|
| 38 |
+
# pannnnnnn/4_labels
|
| 39 |
|
| 40 |
+
## Model Summary
|
| 41 |
+
這是一個 **中文論壇評論四分類模型**,輸入遊戲討論文字後,輸出以下四類標籤之一:
|
| 42 |
+
- **0 = 負面**
|
| 43 |
+
- **1 = 中立**
|
| 44 |
+
- **2 = 正面**
|
| 45 |
+
- **3 = OT (Off-topic, 離題)**
|
| 46 |
|
| 47 |
+
模型專門應用於 **任天堂馬力歐系列遊戲**的社群評論(如 Dcard、Mobile01、PTT、巴哈姆特),研究目的是分析論壇情緒與股價走勢的關聯。
|
| 48 |
|
| 49 |
+
特色:
|
| 50 |
+
- **關鍵字白名單規則**:若文字(或任一分段)包含「奧德賽 / 3D世界 / 狂怒 / 創作家 / 馬創」,則強制視為非 OT。
|
| 51 |
+
- **長文本切段**:對超過 512 token 的文字自動分段推論,最後取平均機率。
|
| 52 |
+
- **一體化模型**:一次輸出四類,不需 Stage1 / Stage2。
|
| 53 |
|
| 54 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 55 |
|
| 56 |
+
## Model Details
|
| 57 |
+
- **Developed by:** pannnnnnn
|
| 58 |
+
- **Language(s):** zh-TW, zh-CN(主要為繁體中文)
|
| 59 |
+
- **Model type:** Transformer (RoBERTa-zh base finetuned)
|
| 60 |
+
- **License:** Research use (non-commercial)
|
| 61 |
+
- **Finetuned from:** `hfl/chinese-roberta-wwm-ext`
|
| 62 |
|
| 63 |
+
---
|
| 64 |
|
| 65 |
## Training Details
|
| 66 |
|
| 67 |
### Training Data
|
| 68 |
+
- 來源:台灣遊戲論壇(Dcard、Mobile01、PTT、巴哈姆特),自建爬蟲收集。
|
| 69 |
+
- 清理:去掉網址、簽名檔、重複貼文;正規化全半形字;保留 emoji。
|
| 70 |
+
- 人工標註:四類(負面、中立、正面、OT)。
|
|
|
|
| 71 |
|
| 72 |
### Training Procedure
|
| 73 |
+
- Optimizer: AdamW
|
| 74 |
+
- Loss: CrossEntropy (focal loss variant)
|
| 75 |
+
- Batch size: 32
|
| 76 |
+
- Epochs: 3
|
| 77 |
+
- Mixed precision: fp16
|
| 78 |
|
| 79 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 80 |
|
| 81 |
## Evaluation
|
| 82 |
|
|
|
|
|
|
|
| 83 |
### Testing Data, Factors & Metrics
|
| 84 |
|
| 85 |
#### Testing Data
|
| 86 |
+
- **切分方式**:依 `timestamp` 欄位排序後,以時間先後劃分資料集。
|
| 87 |
+
- **分配比例**:最後 10% 的資料作為 **Test Set**;倒數前 15% 作為 **Validation Set**;其餘為 **Training Set**。
|
| 88 |
+
- **目的**:模擬「訓練只能使用過去資料,測試用未來資料」,避免資訊洩漏 (data leakage)。
|
|
|
|
| 89 |
|
| 90 |
#### Factors
|
| 91 |
+
- 不同子遊戲(如《奧德賽》《3D世界+狂怒世界》《創作家》)在情緒分布上的差異。
|
| 92 |
+
- 貼文長度(短文 vs 長文)對分類效果的影響。
|
|
|
|
|
|
|
| 93 |
|
| 94 |
#### Metrics
|
| 95 |
+
- Accuracy
|
| 96 |
+
- Macro-F1
|
| 97 |
+
- Per-class F1
|
|
|
|
| 98 |
|
| 99 |
### Results
|
| 100 |
|
| 101 |
+
| Label | Precision | Recall | F1 | Support |
|
| 102 |
+
|-------|-----------|--------|------|---------|
|
| 103 |
+
| neg | 0.964 | 0.915 | 0.939| 59 |
|
| 104 |
+
| neu | 0.789 | 0.759 | 0.774| 54 |
|
| 105 |
+
| pos | 0.738 | 0.882 | 0.804| 51 |
|
| 106 |
+
| ot | 0.930 | 0.855 | 0.891| 62 |
|
| 107 |
+
| **Accuracy** | – | – | **0.854** | 226 |
|
| 108 |
+
| **Macro avg** | 0.855 | 0.853 | 0.852 | – |
|
| 109 |
+
| **Weighted avg** | 0.862 | 0.854 | 0.856 | – |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 110 |
|
| 111 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 112 |
|
| 113 |
+
## Uses
|
| 114 |
|
| 115 |
+
### Direct Use
|
| 116 |
+
- 輸入論壇貼文 / 留言,判斷其情緒或是否離題。
|
| 117 |
+
- 適合研究用途(例如:情緒與股價關聯分析、論壇口碑追蹤)。
|
| 118 |
|
| 119 |
+
### Downstream Use
|
| 120 |
+
- 可再微調到其他領域的四類情緒分類。
|
| 121 |
+
- 可改成三類情緒(合併 OT 與中立)或二類情緒。
|
| 122 |
|
| 123 |
+
### Out-of-Scope Use
|
| 124 |
+
- 不適用於醫療、法律、金融決策。
|
| 125 |
+
- 不適合處理極短、缺乏上下文的片段。
|
| 126 |
|
| 127 |
+
---
|
| 128 |
|
| 129 |
+
## Bias, Risks, Limitations
|
| 130 |
+
- **資料來源偏差**:主要來自遊戲論壇,不能泛用到所有中文語境。
|
| 131 |
+
- **諷刺/雙關困難**:模型可能誤判反諷、梗文。
|
| 132 |
+
- **跨遊戲混淆**:若評論同時提及其他遊戲,判斷可能不準。
|
| 133 |
|
| 134 |
+
**建議**:搭配人工檢視與統計,避免單一模型輸出直接做高風險決策。
|
| 135 |
|
| 136 |
+
---
|
| 137 |
|
| 138 |
+
## How to Use
|
| 139 |
|
| 140 |
+
```python
|
| 141 |
+
from transformers import pipeline
|
| 142 |
|
| 143 |
+
pipe = pipeline("text-classification",
|
| 144 |
+
model="pannnnnnn/4_labels",
|
| 145 |
+
truncation=True,
|
| 146 |
+
top_k=None)
|
| 147 |
|
| 148 |
+
print(pipe("這代真的比奧德賽更好玩!"))
|
| 149 |
+
# [{'label': 'positive', 'score': 0.92}]
|