Update README.md

README.md

@@ -1,28 +1,52 @@
 ---
 license: apache-2.0
 datasets:
-  - google-research-datasets/go_emotions
+- google-research-datasets/go_emotions
+base_model: intfloat/multilingual-e5-large
 language:
-  - de
+- de
 metrics:
-  - accuracy value: 0.27
-  - f1 value: 0.382
-  - roc_auc value: 0.658
+- roc_auc value: 0.658
+- f1: 0.382
+- accuracy: 0.27
 pipeline_tag: text-classification
 tags:
-  - medical
+- medical
+model_description: >-
+  This is basically the German translation of arpanghoshal/EmoRoBERTa. We used
+  the go_emotions dataset, translated it into German and fine-tuned the
+  intfloat/multilingual-e5-large model. So this model allows the classification
+  of 28 emotions in German Transcripts ('admiration', 'amusement', 'anger',
+  'annoyance', 'approval', 'caring', 'confusion', 'curiosity', 'desire',
+  'disappointment', 'disapproval', 'disgust', 'embarrassment', 'excitement',
+  'fear', 'gratitude', 'grief', 'joy', 'love', 'nervousness', 'optimism',
+  'pride', 'realization', 'relief', 'remorse', 'sadness', 'surprise',
+  'neutral'). A paper will be published soonish...
 ---
-This is basically the German translation of arpanghoshal/EmoRoBERTa. We used the go_emotions dataset, translated it into German and fine-tuned the intfloat/multilingual-e5-large model. 
+# Model Card for G-E5-rman-Emotions
 
-**Hyperparameters**
-- Epochs: 10
-- learning_rate: 1e-5
-- weight_decay: 0.01
+This is basically the German translation of arpanghoshal/EmoRoBERTa. We used the go_emotions dataset, translated it into German and fine-tuned the intfloat/multilingual-e5-large model. So this model allows the classification of 28 emotions in German Transcripts ('admiration', 'amusement', 'anger', 'annoyance', 'approval', 'caring', 'confusion', 'curiosity', 'desire', 'disappointment', 'disapproval', 'disgust', 'embarrassment', 'excitement', 'fear', 'gratitude', 'grief', 'joy', 'love', 'nervousness', 'optimism', 'pride', 'realization', 'relief', 'remorse', 'sadness', 'surprise', 'neutral'). A paper will be published soonish...
 
-**Model Performance**
-  - accuracy: 0.27
-  - f1: 0.382
-  - roc_auc: 0.658
 
+## Model Details
 
 
+- **Model type:** text-classification
+- **Language(s) (NLP):** German
+- **License:** apache-2.0
+- **Finetuned from model:** intfloat/multilingual-e5-large
+- **Hyperparameters:**
+    - Epochs: 10
+    - learning_rate: 1e-5
+    - weight_decay: 0.01
+- **Metrics:**
+    - accuracy: 0.27
+    - f1: 0.382
+    - roc_auc: 0.658
+---
+
+
+## How to Get Started with the Model
+
+Use the code below to get started with the model.
+