Create README.md

README.md

@@ -0,0 +1,47 @@
+---
+language: "en"
+tags:
+- distilroberta
+- sentiment
+- emotion
+- twitter
+- reddit
+
+widget:
+- text: "Oh wow. I didn't know that."
+- text: "This movie always makes me cry.."
+- text: "Oh Happy Day"
+
+---
+
+# Fine-tuned DistilRoBERTa-base for Emotion Classification 
+
+# Model Description 
+
+DistilRoBERTa-base is a transformers model, which is pre-trained on the Friends show to classify emotions from text. It predicts 6 Ekman emotions and a neutral class. These emotions include anger 🤬, disgust 🤢, fear 😨, joy 😀, neutral 😐, sadness 😭 and surprise 😲.
+
+The model is a fine-tuned checkpoint of [DistilRoBERTa-base](https://huggingface.co/j-hartmann/emotion-english-distilroberta-base).
+
+# How to Use 
+
+```python
+from transformers import pipeline
+classifier = pipeline("sentiment-analysis", model="michellejieli/emotion_text_classifier")
+classifier("I love this!")
+```
+
+```python
+Output:
+[{'label': 'joy', 'score': 0.9887555241584778}]
+```
+
+# Contact
+
+Please reach out to [michelle.li851@duke.edu](mailto:michelle.li851@duke.edu) if you have any questions or feedback.
+
+
+# Reference
+
+```
+Jochen Hartmann, "Emotion English DistilRoBERTa-base". https://huggingface.co/j-hartmann/emotion-english-distilroberta-base/, 2022.
+```