DataWizardd commited on
Commit
d578662
·
verified ·
1 Parent(s): 90f46f1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +61 -185
README.md CHANGED
@@ -1,199 +1,75 @@
1
  ---
2
- library_name: transformers
3
- tags: []
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
 
9
 
 
10
 
 
 
 
 
11
 
12
- ## Model Details
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
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
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
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
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
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
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
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Contact
198
-
199
- [More Information Needed]
 
1
  ---
2
+ language: ko
3
+ datasets:
4
+ - investing_comments_krw
5
+ metrics:
6
+ - accuracy
7
+ - precision
8
+ - recall
9
+ - f1
10
+ tags:
11
+ - sentiment-analysis
12
+ - finance
13
+ - krw
14
+ - binary-classification
15
+ - emotion
16
+ model-index:
17
+ - name: FinBERT-Sentiment-KRW-Comment (v3)
18
+ results:
19
+ - task:
20
+ type: text-classification
21
+ name: Sentiment Analysis (Fear vs. Greed)
22
+ metrics:
23
+ - type: accuracy
24
+ value: 0.94
25
+ - type: precision
26
+ value: 0.94
27
+ - type: recall
28
+ value: 0.94
29
+ - type: f1
30
+ value: 0.94
31
  ---
32
 
33
+ # FinBERT-Sentiment-KRW-Comment (v3)
34
 
35
+ 모델은 [`snunlp/KR-FinBERT-SC`](https://huggingface.co/snunlp/KR-FinBERT-SC)를 기반으로 파인튜닝한 한국어 금융 감정 분석 모델입니다.
36
+ 특히 **환율(FX) 관련 댓글**에서 나타나는 감정을 **공포(0)** 또는 **욕심(1)** 이진 분류하는 데 목적이 있습니다.
37
 
38
+ ## 🧾 라벨 정의
39
 
40
+ | 라벨 | 설명 |
41
+ |------|------------|
42
+ | 0 | 공포 (Fear) |
43
+ | 1 | 욕심 (Greed) |
44
 
45
+ ## 🏋️‍♂️ 학습 정보
46
 
47
+ - **Base model**: `snunlp/KR-FinBERT-SC`
48
+ - **Task**: 감정 이진 분류 (공포 vs 욕심)
49
+ - **Input**: 한국어 댓글 (`content`)
50
+ - **Output**: 0 또는 1
51
+ - **Training epochs**: 4
52
+ - **Train size**: 약 `X` 개
53
+ - **Eval size**: 약 `X` 개
54
+ - **Evaluation metric**: Accuracy, Precision, Recall, F1
55
 
56
+ ### 📊 평가 결과 (Test Set 기준)
57
 
58
+ | Metric | Score |
59
+ |------------|-------|
60
+ | Accuracy | 0.94 |
61
+ | Precision | 0.94 |
62
+ | Recall | 0.94 |
63
+ | F1-score | 0.94 |
64
 
65
+ > 공포(0): precision=0.95, recall=0.91, f1=0.93
66
+ > 욕심(1): precision=0.93, recall=0.96, f1=0.94
 
 
 
 
 
67
 
68
+ ## 🧪 사용 예시
69
 
70
+ ```python
71
+ from transformers import pipeline
72
 
73
+ pipe = pipeline("text-classification", model="DataWizardd/finbert-sentiment-krw-comment-v3")
74
+ pipe("심상치 않네요 중동전쟁 발발하고 1월8일에 김정은이 미사일 실험하고 그러면 1170은 기본이고 1190원도 순식간일듯.")
75
+ # [{'label': '1', 'score': 0.98}]