diff --git a/README.md b/README.md index 995056b..bc3bb07 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ widget: --- -## Description +## Description ℹ With this model, you can classify emotions in English text data. The model was trained on 6 diverse datasets (see Appendix) and predicts Ekman's 6 basic emotions, plus a neutral class: @@ -28,7 +28,7 @@ With this model, you can classify emotions in English text data. The model was t The model is a fine-tuned checkpoint of DistilRoBERTa-base. -## Application +## Application 🚀 a) Run emotion model with 3 lines of code on single text example using Hugging Face's pipeline command on Google Colab: @@ -38,13 +38,13 @@ b) Run emotion model on multiple examples and full datasets (e.g., .csv files) o [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/j-hartmann/emotion-english-distilroberta-base/blob/main/emotion_prediction_example.ipynb) -## Contact +## Contact 💻 Please reach out to jochen.hartmann@uni-hamburg.de if you have any questions or feedback. Thanks to Samuel Domdey and chrsiebert for their support in making this model available. -## Appendix +## Appendix 📚 Please find an overview of the datasets used for training below. All datasets contain English text. The table summarizes which emotions are available in each of the datasets.