add creds

README.md

@@ -11,13 +11,16 @@ library_name: sentence-transformers
 language:
 - en
 license: apache-2.0
+base_model: SamLowe/roberta-base-go_emotions
+datasets:
+- go_emotions
 ---
 
 # EmotionEncoder
 
-**EmotionEncoder** encodes the emotional content of text into a 128-dimensional vector space where **cosine similarity = emotional similarity**. Two sentences that feel the same emotionally will be close; two sentences at opposite emotional ends will be far apart.
+**EmotionEncoder** is a RoBERTa-base encoder fine-tuned with a multi-label supervised contrastive objective on GoEmotions. It maps English text into a 128-dimensional space where **cosine similarity = emotional similarity**: texts that share emotional content sit close together, texts that don't are pushed apart.
 
-This is not a classifier. There are no output labels, no softmax, no categories to pick from. You get a vector, and that vector's geometry is the model's understanding of emotion.
+It is not a classifier. There are no output labels, no softmax, no categories to pick from. You get a vector, and that vector's geometry is the model's understanding of emotion.
 
 ```python
 from sentence_transformers import SentenceTransformer
@@ -44,7 +47,7 @@ Existing approaches to emotion in text fall into two camps, and both have a geom
 
 **Classification models** (e.g. `roberta-base-go_emotions`) are trained with cross-entropy to separate emotion categories. They discriminate well — but cross-entropy optimises decision boundaries, not distances. The resulting embedding space isn't designed to answer "how emotionally similar are these two texts?"
 
-**VAD regression models** map text to valence–arousal–dominance coordinates. They're continuous by construction, but three scalars can't capture the full structure of emotion. Grief and anger share low valence and high arousal; they are not the same.
+**VAD regression models** map text to valence–arousal–dominance coordinates. They're continuous by construction, but three scalars cannot resolve categorical distinctions that share VAD coordinates. Fear and anger both sit in the high-arousal, negative-valence quadrant; they are not the same emotion, and downstream systems that need to tell them apart will not get that signal from a VAD scalar.
 
 EmotionEncoder is trained with a **multi-label supervised contrastive objective** that directly shapes the embedding geometry: texts that share emotional content are pulled together, texts that don't are pushed apart, and the strength of attraction is proportional to how much emotional overlap they have. The result is a space that is simultaneously discriminative and calibrated — something neither of the above achieves alone.
 
@@ -54,12 +57,12 @@ EmotionEncoder is trained with a **multi-label supervised contrastive objective*
 
 | | |
 |---|---|
-| **Base model** | `SamLowe/roberta-base-go_emotions` |
+| **Base model** | [`SamLowe/roberta-base-go_emotions`](https://huggingface.co/SamLowe/roberta-base-go_emotions) |
 | **Architecture** | RoBERTa-base + masked mean pooling + 2-layer MLP projection head |
 | **Output dimension** | 128 |
 | **Similarity function** | Cosine similarity |
 | **Max sequence length** | 100 tokens |
-| **Training data** | GoEmotions (~54k Reddit comments, 28 emotion labels, multi-label) |
+| **Training data** | [GoEmotions](https://huggingface.co/datasets/go_emotions) (~54k Reddit comments, 28 emotion labels, multi-label) |
 | **Training objective** | Multi-label SupCon with any-overlap pair weighting |
 | **Language** | English |
 
@@ -99,6 +102,14 @@ Evaluated on three datasets with varying label schemas against two baselines:
 
 EmotionEncoder exceeds the backbone on both out-of-domain datasets on every metric — the label schemas there (4–6 labels) are completely different from GoEmotions (28 labels), so this is genuine transfer, not overfitting to the training distribution. On Brier score it matches `all-mpnet-base-v2` in-domain (within 0.001) and beats it on tweet_eval, while reducing the backbone's Brier by 23% on GoEmotions.
 
+### What the OOD transfer does and does not show
+
+The OOD numbers support the claim that the learned geometry captures something more general than the GoEmotions label schema. The dair-ai/emotion (6 labels, Twitter) and tweet_eval/emotion (4 labels, Twitter) schemas were not seen during training, and the encoder's geometry recovers their structure better than either baseline.
+
+They do **not** show that the model has learned a domain-invariant or theory-grounded emotion representation. Both OOD datasets remain English social-media text, sharing register and surface conventions with the GoEmotions training distribution. Performance on emotionally-loaded text in a clinical interview, a legal document, a literary passage, or a non-English-translated source is not established by these probes.
+
+The intended interpretation is conservative: the encoder generalises across emotion label schemas of varying granularity within an English social-media-adjacent register, and should be validated on any domain that departs meaningfully from that.
+
 ---
 
 ## Usage
@@ -164,14 +175,44 @@ for a, b in pairs:
 
 ## Limitations
 
-**English Reddit** Register generalisation is not established and should be validated on your domain before deployment.
+**English Reddit register.** Training data is drawn from Reddit. Register generalisation beyond English social media is not established and should be validated on your domain before deployment.
 
 **GoEmotions label noise.** Inter-annotator agreement varies across emotion categories. Categories with low agreement or few examples yield less reliable geometry.
 
+**Calibration residual.** Boundary ECE on GoEmotions is 0.421 vs. 0.416 for the mpnet calibration reference. Post-hoc temperature or Platt scaling can close this if precise probability estimates matter.
+
+**No valence axis.** The model encodes full emotional profiles, not sentiment polarity. It is not optimised as a sentiment analyser.
 
 ---
 
+## Citation
+
+If you use this model, please cite the GoEmotions corpus and the SupCon objective on which it is based:
+
+```bibtex
+@inproceedings{demszky-etal-2020-goemotions,
+  title     = {{GoEmotions}: A Dataset of Fine-Grained Emotions},
+  author    = {Demszky, Dorottya and Movshovitz-Attias, Dana and Ko, Jeongwoo and Cowen, Alan and Nemade, Gaurav and Ravi, Sujith},
+  booktitle = {Proceedings of the 58th Annual Meeting of the Association for Computational Linguistics},
+  year      = {2020},
+  publisher = {Association for Computational Linguistics},
+  pages     = {4040--4054},
+  doi       = {10.18653/v1/2020.acl-main.372},
+  url       = {https://aclanthology.org/2020.acl-main.372/}
+}
+
+@inproceedings{khosla-etal-2020-supcon,
+  title     = {Supervised Contrastive Learning},
+  author    = {Khosla, Prannay and Teterwak, Piotr and Wang, Chen and Sarna, Aaron and Tian, Yonglong and Isola, Phillip and Maschinot, Aaron and Liu, Ce and Krishnan, Dilip},
+  booktitle = {Advances in Neural Information Processing Systems},
+  volume    = {33},
+  year      = {2020},
+  pages     = {18661--18673},
+  url       = {https://proceedings.neurips.cc/paper/2020/hash/d89a66c7c80a29b1bdbab0f2a1a94af8-Abstract.html}
+}
+```
 
+---
 
 ## Framework versions