uvegesistvan commited on
Commit
f94c3fc
·
verified ·
1 Parent(s): 9042fa3

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +101 -195
README.md CHANGED
@@ -1,199 +1,105 @@
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: en
3
+ license: mit
4
+ tags:
5
+ - emotion-classification
6
+ - text-analysis
7
+ metrics:
8
+ - precision
9
+ - recall
10
+ - f1-score
11
+ - accuracy
12
  ---
13
 
14
+ # Model Card for uvegesistvan/wildmann_german_proposal_2a
15
+
16
+ ## Model Overview
17
+ This model is a multi-class emotion classifier trained to identify nine distinct emotional states in text. The classes and their corresponding labels are as follows:
18
+
19
+ - **Anger (0)**
20
+ - **Fear (1)**
21
+ - **Disgust (2)**
22
+ - **Sadness (3)**
23
+ - **Joy (4)**
24
+ - **Enthusiasm (5)**
25
+ - **Hope (6)**
26
+ - **Pride (7)**
27
+ - **No emotion (8)**
28
+
29
+ ### Dataset and Preprocessing
30
+ The dataset combines original and synthetic data to improve class balance and performance. Synthetic data augmentation was applied to classes with lower representation in the original dataset, specifically "Fear," "Disgust," "Sadness," "Joy," and "Pride." The following table summarizes the distribution of original and synthetic data across training, testing, and validation sets:
31
+
32
+ #### Training Data:
33
+ | Label | Original Count | Original (%) | Synthetic Count | Synthetic (%) |
34
+ |-------------|----------------|--------------|------------------|----------------|
35
+ | Anger | 6210 | 100.00 | 0 | 0.00 |
36
+ | Fear | 2534 | 40.81 | 3676 | 59.19 |
37
+ | Disgust | 845 | 13.60 | 5366 | 86.40 |
38
+ | Sadness | 2670 | 42.99 | 3541 | 57.01 |
39
+ | Joy | 3420 | 55.07 | 2790 | 44.93 |
40
+ | Enthusiasm | 4347 | 70.00 | 1863 | 30.00 |
41
+ | Hope | 6210 | 100.00 | 0 | 0.00 |
42
+ | Pride | 2834 | 45.63 | 3377 | 54.37 |
43
+ | No emotion | 6210 | 100.00 | 0 | 0.00 |
44
+
45
+ #### Testing Data:
46
+ | Label | Original Count | Original (%) | Synthetic Count | Synthetic (%) |
47
+ |-------------|----------------|--------------|------------------|----------------|
48
+ | Anger | 777 | 100.00 | 0 | 0.00 |
49
+ | Fear | 317 | 40.85 | 459 | 59.15 |
50
+ | Disgust | 106 | 13.66 | 670 | 86.34 |
51
+ | Sadness | 333 | 42.97 | 442 | 57.03 |
52
+ | Joy | 428 | 55.08 | 349 | 44.92 |
53
+ | Enthusiasm | 543 | 69.97 | 233 | 30.03 |
54
+ | Hope | 777 | 100.00 | 0 | 0.00 |
55
+ | Pride | 354 | 45.62 | 422 | 54.38 |
56
+ | No emotion | 777 | 100.00 | 0 | 0.00 |
57
+
58
+ #### Validation Data:
59
+ | Label | Original Count | Original (%) | Synthetic Count | Synthetic (%) |
60
+ |-------------|----------------|--------------|------------------|----------------|
61
+ | Anger | 776 | 100.00 | 0 | 0.00 |
62
+ | Fear | 317 | 40.80 | 460 | 59.20 |
63
+ | Disgust | 105 | 13.53 | 671 | 86.47 |
64
+ | Sadness | 334 | 42.99 | 443 | 57.01 |
65
+ | Joy | 427 | 55.03 | 349 | 44.97 |
66
+ | Enthusiasm | 544 | 70.01 | 233 | 29.99 |
67
+ | Hope | 776 | 100.00 | 0 | 0.00 |
68
+ | Pride | 354 | 45.62 | 422 | 54.38 |
69
+ | No emotion | 776 | 100.00 | 0 | 0.00 |
70
+
71
+ ### Evaluation Metrics
72
+ The model was evaluated using precision, recall, F1-score, and support for each class. Below are the detailed metrics:
73
+
74
+ | Class | Precision | Recall | F1-Score | Support |
75
+ |------------|-----------|--------|----------|---------|
76
+ | Anger (0) | 0.57 | 0.64 | 0.61 | 777 |
77
+ | Fear (1) | 0.84 | 0.77 | 0.80 | 776 |
78
+ | Disgust (2)| 0.91 | 0.95 | 0.93 | 776 |
79
+ | Sadness (3)| 0.84 | 0.85 | 0.85 | 775 |
80
+ | Joy (4) | 0.78 | 0.85 | 0.81 | 777 |
81
+ | Enthusiasm (5)| 0.63 | 0.63 | 0.63 | 777 |
82
+ | Hope (6) | 0.51 | 0.55 | 0.53 | 777 |
83
+ | Pride (7) | 0.77 | 0.77 | 0.77 | 776 |
84
+ | No emotion (8) | 0.47 | 0.34 | 0.39 | 777 |
85
+
86
+ ### Overall Metrics
87
+ - **Accuracy**: 0.71
88
+ - **Macro Average**: Precision = 0.70, Recall = 0.71, F1-Score = 0.70
89
+ - **Weighted Average**: Precision = 0.70, Recall = 0.71, F1-Score = 0.70
90
+
91
+ ### Performance Insights
92
+ The model achieves strong performance across most classes, particularly for "Disgust" and "Sadness." However, the "No emotion" class shows lower recall, which could indicate challenges in distinguishing neutral text from emotional expressions. Additional fine-tuning or data augmentation may help address this limitation.
93
+
94
+ ## Model Usage
95
+ ### Applications
96
+ - Emotion classification in text-based datasets.
97
+ - Analyzing emotional tone in social media, reviews, or other text corpora.
98
+
99
+ ### Limitations
100
+ - Performance varies across classes, with some (e.g., "Hope" and "No emotion") showing lower recall.
101
+ - The model may not generalize well to domains outside the training data.
102
+
103
+ ### Ethical Considerations
104
+ The model's predictions might not always align with human interpretations of emotions, particularly in ambiguous or context-dependent cases. Misclassification could lead to inappropriate conclusions if used in sensitive applications (e.g., mental health monitoring).
105