Update README.md
Browse files
README.md
CHANGED
|
@@ -107,158 +107,31 @@ emotion_dict = {e: 0 for e in ["surprised","excited","angry","proud","sad","anno
|
|
| 107 |
|
| 108 |
This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
|
| 109 |
|
| 110 |
-
- **Developed by:**
|
| 111 |
-
- **
|
| 112 |
-
- **
|
| 113 |
-
- **Model type:** [More Information Needed]
|
| 114 |
-
- **Language(s) (NLP):** [More Information Needed]
|
| 115 |
-
- **License:** [More Information Needed]
|
| 116 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
| 117 |
|
| 118 |
-
### Model Sources [optional]
|
| 119 |
-
|
| 120 |
-
<!-- Provide the basic links for the model. -->
|
| 121 |
-
|
| 122 |
-
- **Repository:** [More Information Needed]
|
| 123 |
-
- **Paper [optional]:** [More Information Needed]
|
| 124 |
-
- **Demo [optional]:** [More Information Needed]
|
| 125 |
-
|
| 126 |
-
## Uses
|
| 127 |
-
|
| 128 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 129 |
|
| 130 |
### Direct Use
|
| 131 |
|
| 132 |
-
|
| 133 |
-
|
| 134 |
-
[More Information Needed]
|
| 135 |
|
| 136 |
-
### Downstream Use
|
| 137 |
|
| 138 |
-
|
| 139 |
-
|
| 140 |
-
[More Information Needed]
|
| 141 |
|
| 142 |
### Out-of-Scope Use
|
| 143 |
|
| 144 |
-
|
| 145 |
-
|
| 146 |
-
[More Information Needed]
|
| 147 |
|
| 148 |
## Bias, Risks, and Limitations
|
| 149 |
|
| 150 |
-
|
| 151 |
-
|
| 152 |
-
[More Information Needed]
|
| 153 |
-
|
| 154 |
-
### Recommendations
|
| 155 |
-
|
| 156 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
| 157 |
-
|
| 158 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
| 159 |
-
|
| 160 |
-
## How to Get Started with the Model
|
| 161 |
-
|
| 162 |
-
Use the code below to get started with the model.
|
| 163 |
-
|
| 164 |
-
[More Information Needed]
|
| 165 |
-
|
| 166 |
-
## Training Details
|
| 167 |
-
|
| 168 |
-
### Training Data
|
| 169 |
-
|
| 170 |
-
<!-- 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. -->
|
| 171 |
-
|
| 172 |
-
[More Information Needed]
|
| 173 |
-
|
| 174 |
-
### Training Procedure
|
| 175 |
-
|
| 176 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
| 177 |
-
|
| 178 |
-
#### Preprocessing [optional]
|
| 179 |
-
|
| 180 |
-
[More Information Needed]
|
| 181 |
-
|
| 182 |
-
|
| 183 |
-
#### Training Hyperparameters
|
| 184 |
-
|
| 185 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 186 |
-
|
| 187 |
-
#### Speeds, Sizes, Times [optional]
|
| 188 |
-
|
| 189 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
| 190 |
-
|
| 191 |
-
[More Information Needed]
|
| 192 |
-
|
| 193 |
-
## Evaluation
|
| 194 |
-
|
| 195 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
| 196 |
-
|
| 197 |
-
### Testing Data, Factors & Metrics
|
| 198 |
-
|
| 199 |
-
#### Testing Data
|
| 200 |
-
|
| 201 |
-
<!-- This should link to a Dataset Card if possible. -->
|
| 202 |
-
|
| 203 |
-
[More Information Needed]
|
| 204 |
-
|
| 205 |
-
#### Factors
|
| 206 |
-
|
| 207 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
| 208 |
|
| 209 |
-
[More Information Needed]
|
| 210 |
|
| 211 |
-
#### Metrics
|
| 212 |
|
| 213 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
| 214 |
|
| 215 |
-
|
| 216 |
-
|
| 217 |
-
### Results
|
| 218 |
-
|
| 219 |
-
[More Information Needed]
|
| 220 |
-
|
| 221 |
-
#### Summary
|
| 222 |
-
|
| 223 |
-
|
| 224 |
-
|
| 225 |
-
## Model Examination [optional]
|
| 226 |
-
|
| 227 |
-
<!-- Relevant interpretability work for the model goes here -->
|
| 228 |
-
|
| 229 |
-
[More Information Needed]
|
| 230 |
-
|
| 231 |
-
## Environmental Impact
|
| 232 |
-
|
| 233 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
| 234 |
-
|
| 235 |
-
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).
|
| 236 |
-
|
| 237 |
-
- **Hardware Type:** [More Information Needed]
|
| 238 |
-
- **Hours used:** [More Information Needed]
|
| 239 |
-
- **Cloud Provider:** [More Information Needed]
|
| 240 |
-
- **Compute Region:** [More Information Needed]
|
| 241 |
-
- **Carbon Emitted:** [More Information Needed]
|
| 242 |
-
|
| 243 |
-
## Technical Specifications [optional]
|
| 244 |
-
|
| 245 |
-
### Model Architecture and Objective
|
| 246 |
-
|
| 247 |
-
[More Information Needed]
|
| 248 |
-
|
| 249 |
-
### Compute Infrastructure
|
| 250 |
-
|
| 251 |
-
[More Information Needed]
|
| 252 |
-
|
| 253 |
-
#### Hardware
|
| 254 |
-
|
| 255 |
-
[More Information Needed]
|
| 256 |
-
|
| 257 |
-
#### Software
|
| 258 |
-
|
| 259 |
-
[More Information Needed]
|
| 260 |
-
|
| 261 |
-
## Citation [optional]
|
| 262 |
|
| 263 |
|
| 264 |
```
|
|
@@ -272,31 +145,3 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
|
|
| 272 |
```
|
| 273 |
|
| 274 |
|
| 275 |
-
|
| 276 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
| 277 |
-
|
| 278 |
-
**BibTeX:**
|
| 279 |
-
|
| 280 |
-
[More Information Needed]
|
| 281 |
-
|
| 282 |
-
**APA:**
|
| 283 |
-
|
| 284 |
-
[More Information Needed]
|
| 285 |
-
|
| 286 |
-
## Glossary [optional]
|
| 287 |
-
|
| 288 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
| 289 |
-
|
| 290 |
-
[More Information Needed]
|
| 291 |
-
|
| 292 |
-
## More Information [optional]
|
| 293 |
-
|
| 294 |
-
[More Information Needed]
|
| 295 |
-
|
| 296 |
-
## Model Card Authors [optional]
|
| 297 |
-
|
| 298 |
-
[More Information Needed]
|
| 299 |
-
|
| 300 |
-
## Model Card Contact
|
| 301 |
-
|
| 302 |
-
[More Information Needed]
|
|
|
|
| 107 |
|
| 108 |
This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
|
| 109 |
|
| 110 |
+
- **Developed by:** DeGRa
|
| 111 |
+
- **Model type:** Fine-Tuned Mistral-7B
|
| 112 |
+
- **Language(s) (NLP):** English
|
|
|
|
|
|
|
|
|
|
|
|
|
| 113 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 114 |
|
| 115 |
### Direct Use
|
| 116 |
|
| 117 |
+
This model is primarily designed for use as an **empathetic chatbot** that understands and responds to users' emotional states in a conversational setting. It progressively builds an emotional profile of the user over multiple turns, enabling more personalized and compassionate interactions. The model leverages generative next-token prediction to infer emotions and produce empathetic responses in real-time, creating a natural and emotionally aware dialogue experience.
|
|
|
|
|
|
|
| 118 |
|
| 119 |
+
### Downstream Use
|
| 120 |
|
| 121 |
+
Beyond chatbot applications, this model can be utilized for **emotion classification** tasks. By extracting emotion embeddings from text inputs, it can serve as a foundational tool for emotion detection and analysis in various downstream applications such as sentiment analysis, mental health screening, social media monitoring, and other affective computing domains. Its interpretable emotional profiles enable explainable insights for psychological and clinical tasks.
|
|
|
|
|
|
|
| 122 |
|
| 123 |
### Out-of-Scope Use
|
| 124 |
|
| 125 |
+
This model is **not intended** for direct clinical diagnosis or as a standalone mental health intervention tool. It should not be used in applications requiring professional medical judgment. The model may not perform well in domains with language or emotional expressions significantly different from those encountered during fine-tuning. Additionally, it should not be deployed where accurate identification of serious mental health crises without human oversight is required.
|
|
|
|
|
|
|
| 126 |
|
| 127 |
## Bias, Risks, and Limitations
|
| 128 |
|
| 129 |
+
The model inherits biases from the **finetuning data**, which consists of publicly available Reddit posts and empathetic dialogue datasets that may contain demographic, cultural, or social biases. These biases can affect emotion recognition accuracy and response generation, potentially amplifying stereotypes or missing subtle emotional nuances in under-represented populations. Careful evaluation and continuous monitoring are necessary when deploying the model, especially in sensitive mental health contexts. Users should be informed of these limitations and encouraged to complement model outputs with expert human evaluation.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 130 |
|
|
|
|
| 131 |
|
|
|
|
| 132 |
|
|
|
|
| 133 |
|
| 134 |
+
## Citation
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 135 |
|
| 136 |
|
| 137 |
```
|
|
|
|
| 145 |
```
|
| 146 |
|
| 147 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|