Update README.md

README.md

@@ -1,3 +1,14 @@
+---
+license: apache-2.0
+datasets:
+- agentlans/twitter-sentiment-meta-analysis
+language:
+- en
+base_model:
+- microsoft/deberta-v3-xsmall
+- microsoft/deberta-v3-base
+pipeline_tag: text-classification
+---
 # DeBERTa-v3 Twitter Sentiment Models
 
 This page contains one of two DeBERTa-v3 models (xsmall and base) fine-tuned for Twitter sentiment regression.
@@ -10,13 +21,13 @@ This page contains one of two DeBERTa-v3 models (xsmall and base) fine-tuned for
   - base (86M parameters)
 - **Task**: Sentiment regression
 - **Language**: English
-- **License**: [Model license]
+- **License**: Apache 2.0
 
 ## Intended Use
 
 These models are designed for fine-grained sentiment analysis of English tweets. They output a **continuous sentiment score** rather than discrete categories.
 - negative score means negative sentiment
-- 0 score means neutral sentiment
+- zero score means neutral sentiment
 - positive score means positive sentiment
 - the absolute value of the score represents how strong that sentiment is
 
@@ -61,7 +72,40 @@ text = [x.strip() for x in """
 """.strip().split("\n")]
 
 for x, s in zip(text, sentiment(text)):
-    print(f"Text: {x}\nSentiment: {s}\n")
+    print(f"Text: {x}\nSentiment: {round(s, 2)}\n")
+```
+
+Output:
+```text
+Text: I absolutely despise this product and regret ever purchasing it.
+Sentiment: -2.28
+
+Text: The service at that restaurant was terrible and ruined our entire evening.
+Sentiment: -2.38
+
+Text: I'm feeling a bit under the weather today, but it's not too bad.
+Sentiment: 0.25
+
+Text: The weather is quite average today, neither good nor bad.
+Sentiment: -0.14
+
+Text: The movie was okay, I didn't love it but I didn't hate it either.
+Sentiment: 0.06
+
+Text: I'm looking forward to the weekend, it should be nice to relax.
+Sentiment: 2.06
+
+Text: This new coffee shop has a really pleasant atmosphere and friendly staff.
+Sentiment: 2.48
+
+Text: I'm thrilled with my new job and the opportunities it presents!
+Sentiment: 2.66
+
+Text: The concert last night was absolutely incredible, easily the best I've ever seen.
+Sentiment: 2.68
+
+Text: I'm overjoyed and grateful for all the love and support from my friends and family.
+Sentiment: 2.65
 ```
 
 ## Performance
@@ -80,4 +124,4 @@ Evaluation set RMSE:
 ## Ethical Considerations
 
 - Potential biases in the training data related to the time period and Twitter user demographics
-- Risk of misuse for large-scale sentiment monitoring without consent
+- Risk of misuse for large-scale sentiment monitoring without consent