Update README.md

README.md

@@ -1,13 +1,14 @@
 ---
 library_name: transformers
-tags: []
+language:
+- en
 ---
 
 # Model Card for Model ID
 
 <!-- Provide a quick summary of what the model is/does. -->
 
-
+This model is intended to predict emotions (valence, arousal) in written stories. For all details see [the paper (TODO)](#) and [the accompanying github repo (TODO)](#).
 
 ## Model Details
 
@@ -15,23 +16,27 @@ tags: []
 
 <!-- Provide a longer summary of what this model is. -->
 
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
+As described in [the paper (TODO)](#), this model is finetuned from [DeBERTaV3-large](https://huggingface.co/microsoft/deberta-v3-large) and predicts sentence-wise valence/arousal values between 0 and 1. 
+
+This particular checkpoint was trained with a window size of $4$. 
+
+All available checkpoints and their performance:
+
+
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+Technically, this model is predicting token-wise values. Sentences are concatenated via the ``<s>`` token, where the valence/arousal predictions for an ``<s>`` token
+are meant to be the predictions for the sentence preceding it. All other tokens' predictions should be ignored. For reference, see the figure in the paper:
 
-### Model Sources [optional]
+
+The [accompanying repo](TODO) provides a convenient script to use the model for prediction.
+
+### Model Sources
 
 <!-- Provide the basic links for the model. -->
 
 - **Repository:** [More Information Needed]
 - **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- 
 
 ## Uses
 
@@ -196,6 +201,4 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 ## Model Card Contact
 
-[More Information Needed]
-
-
+[More Information Needed]