Update README.md

README.md

@@ -4,4 +4,51 @@ datasets:
 - dair-ai/emotion
 language:
 - en
----
+pipeline_tag: text-classification
+---
+## Sentiment Classifier: Emotion Detection with Sentence Transformer
+
+This model classifies sentiments using the Sentence Transformer, specifically the `all-MiniLM-L6-v2` architecture. It's trained on the `dair-ai/emotion` dataset to identify six basic emotions:
+
+* Sadness
+* Joy
+* Love
+* Anger
+* Fear
+* Surprise
+
+**Developed by:** shhossain: [https://github.com/shhossain](https://github.com/shhossain)
+
+**Model type:** Custom ([https://huggingface.co/shhossain/all-MiniLM-L6-v2-sentiment-classifier/blob/main/model.py](https://huggingface.co/shhossain/all-MiniLM-L6-v2-sentiment-classifier/blob/main/model.py))
+
+**Language(s):** English
+
+**License:** Same as all-MiniLM-L6-v2
+
+**Finetuned from:** all-MiniLM-L6-v2 ([https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2))
+
+## Usage Example
+
+```python
+from transformers import pipeline
+
+pipe = pipeline("text-classification", model="shhossain/all-MiniLM-L6-v2-sentiment-classifier", trust_remote_code=True)
+
+result = pipe("This product is excellent!")
+result
+```
+
+**Output:**
+
+```json
+[
+  {"label": "joy", "score": 0.8},
+  {"label": "love", "score": 0.1},
+  {"label": "anger", "score": 0.05},
+  {"label": "sadness", "score": 0.03},
+  {"label": "surprise", "score": 0.02},
+  {"label": "fear", "score": 0.01}
+]
+```
+
+