kwoncho commited on
Commit
3241ea3
ยท
verified ยท
1 Parent(s): 82cd484

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +29 -186
README.md CHANGED
@@ -9,6 +9,34 @@
9
  <!-- Provide a quick summary of what the model is/does. -->
10
  2024.4.4 Update
11
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
  ์ด ๋ชจํ˜•์€ ๊ธฐ์—…๊ด€๋ จ ๋‰ด์Šค์— ํฌํ•จ๋œ ๋ฌธ์žฅ์˜ ๊ธ์ •/์ค‘๋ฆฝ/๋ถ€์ •์„ ํŒ๋‹จํ•˜๊ธฐ ์œ„ํ•œ ๊ฐ์„ฑ๋ถ„์„ ๋ชจํ˜•์ž…๋‹ˆ๋‹ค.
13
 
14
  ํ•œ๊ตญ์–ด ๊ธฐ๋ฐ˜ ๊ธˆ์œต/๊ฒฝ์˜/ํšŒ๊ณ„ ๋ถ„์•ผ ๊ฐ์„ฑ๋ถ„์„ ๋ชจํ˜•์œผ๋กœ ์‚ฌ์šฉํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.
@@ -49,189 +77,4 @@ https://colab.research.google.com/drive/1ORzKUr94cPyc5jaRCAngbclm4Qb4DtdG
49
 
50
  ### Model Description
51
 
52
- <!-- Provide a longer summary of what this model is. -->
53
-
54
-
55
-
56
- - **Developed by:** [More Information Needed]
57
- - **Funded by [optional]:** [More Information Needed]
58
- - **Shared by [optional]:** [More Information Needed]
59
- - **Model type:** [More Information Needed]
60
- - **Language(s) (NLP):** [More Information Needed]
61
- - **License:** [More Information Needed]
62
- - **Finetuned from model [optional]:** [More Information Needed]
63
-
64
- ### Model Sources [optional]
65
-
66
- <!-- Provide the basic links for the model. -->
67
-
68
- - **Repository:** [More Information Needed]
69
- - **Paper [optional]:** [More Information Needed]
70
- - **Demo [optional]:** [More Information Needed]
71
-
72
- ## Uses
73
-
74
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
75
-
76
- ### Direct Use
77
-
78
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
79
-
80
- [More Information Needed]
81
-
82
- ### Downstream Use [optional]
83
-
84
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
85
-
86
- [More Information Needed]
87
-
88
- ### Out-of-Scope Use
89
-
90
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
91
-
92
- [More Information Needed]
93
-
94
- ## Bias, Risks, and Limitations
95
-
96
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
97
-
98
- [More Information Needed]
99
-
100
- ### Recommendations
101
-
102
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
103
-
104
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
105
-
106
- ## How to Get Started with the Model
107
-
108
- Use the code below to get started with the model.
109
-
110
- [More Information Needed]
111
-
112
- ## Training Details
113
-
114
- ### Training Data
115
-
116
- <!-- 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. -->
117
-
118
- [More Information Needed]
119
-
120
- ### Training Procedure
121
-
122
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
123
-
124
- #### Preprocessing [optional]
125
-
126
- [More Information Needed]
127
-
128
-
129
- #### Training Hyperparameters
130
-
131
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
132
-
133
- #### Speeds, Sizes, Times [optional]
134
-
135
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
136
-
137
- [More Information Needed]
138
-
139
- ## Evaluation
140
-
141
- <!-- This section describes the evaluation protocols and provides the results. -->
142
-
143
- ### Testing Data, Factors & Metrics
144
-
145
- #### Testing Data
146
-
147
- <!-- This should link to a Dataset Card if possible. -->
148
-
149
- [More Information Needed]
150
-
151
- #### Factors
152
-
153
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
154
-
155
- [More Information Needed]
156
-
157
- #### Metrics
158
-
159
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
160
-
161
- [More Information Needed]
162
-
163
- ### Results
164
-
165
- [More Information Needed]
166
-
167
- #### Summary
168
-
169
-
170
-
171
- ## Model Examination [optional]
172
-
173
- <!-- Relevant interpretability work for the model goes here -->
174
-
175
- [More Information Needed]
176
-
177
- ## Environmental Impact
178
-
179
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
180
-
181
- 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).
182
-
183
- - **Hardware Type:** [More Information Needed]
184
- - **Hours used:** [More Information Needed]
185
- - **Cloud Provider:** [More Information Needed]
186
- - **Compute Region:** [More Information Needed]
187
- - **Carbon Emitted:** [More Information Needed]
188
-
189
- ## Technical Specifications [optional]
190
-
191
- ### Model Architecture and Objective
192
-
193
- [More Information Needed]
194
-
195
- ### Compute Infrastructure
196
-
197
- [More Information Needed]
198
-
199
- #### Hardware
200
-
201
- [More Information Needed]
202
-
203
- #### Software
204
-
205
- [More Information Needed]
206
-
207
- ## Citation [optional]
208
-
209
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
210
-
211
- **BibTeX:**
212
-
213
- [More Information Needed]
214
-
215
- **APA:**
216
-
217
- [More Information Needed]
218
-
219
- ## Glossary [optional]
220
-
221
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
222
-
223
- [More Information Needed]
224
-
225
- ## More Information [optional]
226
-
227
- [More Information Needed]
228
-
229
- ## Model Card Authors [optional]
230
-
231
- [More Information Needed]
232
-
233
- ## Model Card Contact
234
-
235
- [More Information Needed]
236
-
237
-
 
9
  <!-- Provide a quick summary of what the model is/does. -->
10
  2024.4.4 Update
11
 
12
+ This model is a sentiment analysis model designed to determine the positive/neutral/negative sentiment of sentences included in corporate-related news.
13
+
14
+ It can be used as a Korean-based sentiment analysis model for the finance/management/accounting fields.
15
+
16
+ Example>
17
+
18
+ "Samsung's debt is increasing." --> Neutral. The mere increase in debt is not necessarily negative.
19
+
20
+ "Due to the failure of management strategy, Samsung's debt is increasing." --> Negative. Debt increase due to failure is considered negative.
21
+
22
+ Hyun Ji-won, Lee Jun-il, and Cho Hyun-kwon. "A Study on Sentiment Classification of Corporate-related News Articles Using KoBERT." Accounting Research 47.4 (2022): 33-54.
23
+
24
+ We have further developed the model proposed in the above paper and made it available through Huggingface. If you use it for research purposes, please cite the above paper.
25
+
26
+ This model was fine-tuned using https://huggingface.co/jhgan/ko-sroberta-multitask.
27
+
28
+ For the usage code, refer to the link below:
29
+
30
+ Google Colab: https://colab.research.google.com/drive/1ORzKUr94cPyc5jaRCAngbclm4Qb4DtdG
31
+
32
+ The current evaluation results of the model are as follows:
33
+
34
+ {'eval_loss': 0.7330707907676697, 'eval_f1': 0.8689251403360293, 'eval_runtime': 0.464, 'eval_samples_per_second': 2047.32, 'eval_steps_per_second': 17.241, 'epoch': 33.33}
35
+
36
+ While the accuracy has increased compared to the paper's 85.7%, the improvement is not significant.
37
+
38
+ 2024.4.4 Update
39
+
40
  ์ด ๋ชจํ˜•์€ ๊ธฐ์—…๊ด€๋ จ ๋‰ด์Šค์— ํฌํ•จ๋œ ๋ฌธ์žฅ์˜ ๊ธ์ •/์ค‘๋ฆฝ/๋ถ€์ •์„ ํŒ๋‹จํ•˜๊ธฐ ์œ„ํ•œ ๊ฐ์„ฑ๋ถ„์„ ๋ชจํ˜•์ž…๋‹ˆ๋‹ค.
41
 
42
  ํ•œ๊ตญ์–ด ๊ธฐ๋ฐ˜ ๊ธˆ์œต/๊ฒฝ์˜/ํšŒ๊ณ„ ๋ถ„์•ผ ๊ฐ์„ฑ๋ถ„์„ ๋ชจํ˜•์œผ๋กœ ์‚ฌ์šฉํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.
 
77
 
78
  ### Model Description
79
 
80
+ <!-- Provide a longer summary of what this model is. -->