updates

.gitattributes

@@ -0,0 +1,33 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text
+model.safetensors filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,152 @@
+---
+language: en
+tags:
+- text-classification
+- pytorch
+- roberta
+- emotions
+- multi-class-classification
+- multi-label-classification
+datasets:
+- go_emotions
+license: mit
+widget:
+- text: I am not having a great day.
+---
+
+#### Overview
+
+Model trained from [roberta-base](https://huggingface.co/roberta-base) on the [go_emotions](https://huggingface.co/datasets/go_emotions) dataset for multi-label classification.
+
+##### ONNX version also available
+
+A version of this model in ONNX format (including an INT8 quantized ONNX version) is now available at [https://huggingface.co/SamLowe/roberta-base-go_emotions-onnx](https://huggingface.co/SamLowe/roberta-base-go_emotions-onnx). These are faster for inference, esp for smaller batch sizes, massively reduce the size of the dependencies required for inference, make inference of the model more multi-platform, and in the case of the quantized version reduce the model file/download size by 75% whilst retaining almost all the accuracy if you only need inference.
+
+#### Dataset used for the model
+
+[go_emotions](https://huggingface.co/datasets/go_emotions) is based on Reddit data and has 28 labels. It is a multi-label dataset where one or multiple labels may apply for any given input text, hence this model is a multi-label classification model with 28 'probability' float outputs for any given input text. Typically a threshold of 0.5 is applied to the probabilities for the prediction for each label.
+
+#### How the model was created
+
+The model was trained using `AutoModelForSequenceClassification.from_pretrained` with `problem_type="multi_label_classification"` for 3 epochs with a learning rate of 2e-5 and weight decay of 0.01.
+
+#### Inference
+
+There are multiple ways to use this model in Huggingface Transformers. Possibly the simplest is using a pipeline:
+
+```python
+from transformers import pipeline
+
+classifier = pipeline(task="text-classification", model="SamLowe/roberta-base-go_emotions", top_k=None)
+
+sentences = ["I am not having a great day"]
+
+model_outputs = classifier(sentences)
+print(model_outputs[0])
+# produces a list of dicts for each of the labels
+```
+
+#### Evaluation / metrics
+
+Evaluation of the model is available at
+
+- https://github.com/samlowe/go_emotions-dataset/blob/main/eval-roberta-base-go_emotions.ipynb
+
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/samlowe/go_emotions-dataset/blob/main/eval-roberta-base-go_emotions.ipynb)
+
+##### Summary
+
+As provided in the above notebook, evaluation of the multi-label output (of the 28 dim output via a threshold of 0.5 to binarize each) using the dataset test split gives:
+
+- Accuracy: 0.474
+- Precision: 0.575
+- Recall: 0.396
+- F1: 0.450
+
+But the metrics are more meaningful when measured per label given the multi-label nature (each label is effectively an independent binary classification) and the fact that there is drastically different representations of the labels in the dataset.
+
+With a threshold of 0.5 applied to binarize the model outputs, as per the above notebook, the metrics per label are:
+
+|                | accuracy | precision | recall | f1    | mcc   | support | threshold |
+| -------------- | -------- | --------- | ------ | ----- | ----- | ------- | --------- |
+| admiration     | 0.946    | 0.725     | 0.675  | 0.699 | 0.670 | 504     | 0.5       |
+| amusement      | 0.982    | 0.790     | 0.871  | 0.829 | 0.821 | 264     | 0.5       |
+| anger          | 0.970    | 0.652     | 0.379  | 0.479 | 0.483 | 198     | 0.5       |
+| annoyance      | 0.940    | 0.472     | 0.159  | 0.238 | 0.250 | 320     | 0.5       |
+| approval       | 0.942    | 0.609     | 0.302  | 0.404 | 0.403 | 351     | 0.5       |
+| caring         | 0.973    | 0.448     | 0.319  | 0.372 | 0.364 | 135     | 0.5       |
+| confusion      | 0.972    | 0.500     | 0.431  | 0.463 | 0.450 | 153     | 0.5       |
+| curiosity      | 0.950    | 0.537     | 0.356  | 0.428 | 0.412 | 284     | 0.5       |
+| desire         | 0.987    | 0.630     | 0.410  | 0.496 | 0.502 | 83      | 0.5       |
+| disappointment | 0.974    | 0.625     | 0.199  | 0.302 | 0.343 | 151     | 0.5       |
+| disapproval    | 0.950    | 0.494     | 0.307  | 0.379 | 0.365 | 267     | 0.5       |
+| disgust        | 0.982    | 0.707     | 0.333  | 0.453 | 0.478 | 123     | 0.5       |
+| embarrassment  | 0.994    | 0.750     | 0.243  | 0.367 | 0.425 | 37      | 0.5       |
+| excitement     | 0.983    | 0.603     | 0.340  | 0.435 | 0.445 | 103     | 0.5       |
+| fear           | 0.992    | 0.758     | 0.603  | 0.671 | 0.672 | 78      | 0.5       |
+| gratitude      | 0.990    | 0.960     | 0.881  | 0.919 | 0.914 | 352     | 0.5       |
+| grief          | 0.999    | 0.000     | 0.000  | 0.000 | 0.000 | 6       | 0.5       |
+| joy            | 0.978    | 0.647     | 0.559  | 0.600 | 0.590 | 161     | 0.5       |
+| love           | 0.982    | 0.773     | 0.832  | 0.802 | 0.793 | 238     | 0.5       |
+| nervousness    | 0.996    | 0.600     | 0.130  | 0.214 | 0.278 | 23      | 0.5       |
+| optimism       | 0.972    | 0.667     | 0.376  | 0.481 | 0.488 | 186     | 0.5       |
+| pride          | 0.997    | 0.000     | 0.000  | 0.000 | 0.000 | 16      | 0.5       |
+| realization    | 0.974    | 0.541     | 0.138  | 0.220 | 0.264 | 145     | 0.5       |
+| relief         | 0.998    | 0.000     | 0.000  | 0.000 | 0.000 | 11      | 0.5       |
+| remorse        | 0.991    | 0.553     | 0.750  | 0.636 | 0.640 | 56      | 0.5       |
+| sadness        | 0.977    | 0.621     | 0.494  | 0.550 | 0.542 | 156     | 0.5       |
+| surprise       | 0.981    | 0.750     | 0.404  | 0.525 | 0.542 | 141     | 0.5       |
+| neutral        | 0.782    | 0.694     | 0.604  | 0.646 | 0.492 | 1787    | 0.5       |
+
+Optimizing the threshold per label for the one that gives the optimum F1 metrics gives slightly better metrics - sacrificing some precision for a greater gain in recall, hence to the benefit of F1 (how this was done is shown in the above notebook):
+
+|                | accuracy | precision | recall | f1    | mcc   | support | threshold |
+| -------------- | -------- | --------- | ------ | ----- | ----- | ------- | --------- |
+| admiration     | 0.940    | 0.651     | 0.776  | 0.708 | 0.678 | 504     | 0.25      |
+| amusement      | 0.982    | 0.781     | 0.890  | 0.832 | 0.825 | 264     | 0.45      |
+| anger          | 0.959    | 0.454     | 0.601  | 0.517 | 0.502 | 198     | 0.15      |
+| annoyance      | 0.864    | 0.243     | 0.619  | 0.349 | 0.328 | 320     | 0.10      |
+| approval       | 0.926    | 0.432     | 0.442  | 0.437 | 0.397 | 351     | 0.30      |
+| caring         | 0.972    | 0.426     | 0.385  | 0.405 | 0.391 | 135     | 0.40      |
+| confusion      | 0.974    | 0.548     | 0.412  | 0.470 | 0.462 | 153     | 0.55      |
+| curiosity      | 0.943    | 0.473     | 0.711  | 0.568 | 0.552 | 284     | 0.25      |
+| desire         | 0.985    | 0.518     | 0.530  | 0.524 | 0.516 | 83      | 0.25      |
+| disappointment | 0.974    | 0.562     | 0.298  | 0.390 | 0.398 | 151     | 0.40      |
+| disapproval    | 0.941    | 0.414     | 0.468  | 0.439 | 0.409 | 267     | 0.30      |
+| disgust        | 0.978    | 0.523     | 0.463  | 0.491 | 0.481 | 123     | 0.20      |
+| embarrassment  | 0.994    | 0.567     | 0.459  | 0.507 | 0.507 | 37      | 0.10      |
+| excitement     | 0.981    | 0.500     | 0.417  | 0.455 | 0.447 | 103     | 0.35      |
+| fear           | 0.991    | 0.712     | 0.667  | 0.689 | 0.685 | 78      | 0.40      |
+| gratitude      | 0.990    | 0.957     | 0.889  | 0.922 | 0.917 | 352     | 0.45      |
+| grief          | 0.999    | 0.333     | 0.333  | 0.333 | 0.333 | 6       | 0.05      |
+| joy            | 0.978    | 0.623     | 0.646  | 0.634 | 0.623 | 161     | 0.40      |
+| love           | 0.982    | 0.740     | 0.899  | 0.812 | 0.807 | 238     | 0.25      |
+| nervousness    | 0.996    | 0.571     | 0.348  | 0.432 | 0.444 | 23      | 0.25      |
+| optimism       | 0.971    | 0.580     | 0.565  | 0.572 | 0.557 | 186     | 0.20      |
+| pride          | 0.998    | 0.875     | 0.438  | 0.583 | 0.618 | 16      | 0.10      |
+| realization    | 0.961    | 0.270     | 0.262  | 0.266 | 0.246 | 145     | 0.15      |
+| relief         | 0.992    | 0.152     | 0.636  | 0.246 | 0.309 | 11      | 0.05      |
+| remorse        | 0.991    | 0.541     | 0.946  | 0.688 | 0.712 | 56      | 0.10      |
+| sadness        | 0.977    | 0.599     | 0.583  | 0.591 | 0.579 | 156     | 0.40      |
+| surprise       | 0.977    | 0.543     | 0.674  | 0.601 | 0.593 | 141     | 0.15      |
+| neutral        | 0.758    | 0.598     | 0.810  | 0.688 | 0.513 | 1787    | 0.25      |
+
+This improves the overall metrics:
+
+- Precision: 0.542
+- Recall: 0.577
+- F1: 0.541
+
+Or if calculated weighted by the relative size of the support of each label:
+
+- Precision: 0.572
+- Recall: 0.677
+- F1: 0.611
+
+#### Commentary on the dataset
+
+Some labels (E.g. gratitude) when considered independently perform very strongly with F1 exceeding 0.9, whilst others (E.g. relief) perform very poorly.
+
+This is a challenging dataset. Labels such as relief do have much fewer examples in the training data (less than 100 out of the 40k+, and only 11 in the test split).
+
+But there is also some ambiguity and/or labelling errors visible in the training data of go_emotions that is suspected to constrain the performance. Data cleaning on the dataset to reduce some of the mistakes, ambiguity, conflicts and duplication in the labelling would produce a higher performing model.

config.json

@@ -0,0 +1,88 @@
+{
+  "_name_or_path": "roberta-base",
+  "architectures": [
+    "RobertaForSequenceClassification"
+  ],
+  "attention_probs_dropout_prob": 0.1,
+  "bos_token_id": 0,
+  "classifier_dropout": null,
+  "eos_token_id": 2,
+  "hidden_act": "gelu",
+  "hidden_dropout_prob": 0.1,
+  "hidden_size": 768,
+  "id2label": {
+    "0": "admiration",
+    "1": "amusement",
+    "2": "anger",
+    "3": "annoyance",
+    "4": "approval",
+    "5": "caring",
+    "6": "confusion",
+    "7": "curiosity",
+    "8": "desire",
+    "9": "disappointment",
+    "10": "disapproval",
+    "11": "disgust",
+    "12": "embarrassment",
+    "13": "excitement",
+    "14": "fear",
+    "15": "gratitude",
+    "16": "grief",
+    "17": "joy",
+    "18": "love",
+    "19": "nervousness",
+    "20": "optimism",
+    "21": "pride",
+    "22": "realization",
+    "23": "relief",
+    "24": "remorse",
+    "25": "sadness",
+    "26": "surprise",
+    "27": "neutral"
+  },
+  "initializer_range": 0.02,
+  "intermediate_size": 3072,
+  "label2id": {
+    "admiration": 0,
+    "amusement": 1,
+    "anger": 2,
+    "annoyance": 3,
+    "approval": 4,
+    "caring": 5,
+    "confusion": 6,
+    "curiosity": 7,
+    "desire": 8,
+    "disappointment": 9,
+    "disapproval": 10,
+    "disgust": 11,
+    "embarrassment": 12,
+    "excitement": 13,
+    "fear": 14,
+    "gratitude": 15,
+    "grief": 16,
+    "joy": 17,
+    "love": 18,
+    "nervousness": 19,
+    "neutral": 27,
+    "optimism": 20,
+    "pride": 21,
+    "realization": 22,
+    "relief": 23,
+    "remorse": 24,
+    "sadness": 25,
+    "surprise": 26
+  },
+  "layer_norm_eps": 1e-05,
+  "max_position_embeddings": 514,
+  "model_type": "roberta",
+  "num_attention_heads": 12,
+  "num_hidden_layers": 12,
+  "pad_token_id": 1,
+  "position_embedding_type": "absolute",
+  "problem_type": "multi_label_classification",
+  "torch_dtype": "float32",
+  "transformers_version": "4.21.3",
+  "type_vocab_size": 1,
+  "use_cache": true,
+  "vocab_size": 50265
+}

model.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:84d6d338b4cf63f0ed3c990a0ce748d32d1d2965c072f4645accaa71af3888c0
+size 498697004

pytorch_model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4fd088956d38ce7ca956815b0203caf6f29b492b04c22c50d67542b3e02c449d
+size 498740269

special_tokens_map.json

@@ -0,0 +1,15 @@
+{
+  "bos_token": "<s>",
+  "cls_token": "<s>",
+  "eos_token": "</s>",
+  "mask_token": {
+    "content": "<mask>",
+    "lstrip": true,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "pad_token": "<pad>",
+  "sep_token": "</s>",
+  "unk_token": "<unk>"
+}

tokenizer_config.json

@@ -0,0 +1,16 @@
+{
+  "add_prefix_space": false,
+  "bos_token": "<s>",
+  "cls_token": "<s>",
+  "eos_token": "</s>",
+  "errors": "replace",
+  "mask_token": "<mask>",
+  "model_max_length": 512,
+  "name_or_path": "roberta-base",
+  "pad_token": "<pad>",
+  "sep_token": "</s>",
+  "special_tokens_map_file": null,
+  "tokenizer_class": "RobertaTokenizer",
+  "trim_offsets": true,
+  "unk_token": "<unk>"
+}

trainer_state.json

@@ -0,0 +1,241 @@
+{
+  "best_metric": 0.5862595419847328,
+  "best_model_checkpoint": "roberta-base-go_emotions/checkpoint-16281",
+  "epoch": 3.0,
+  "global_step": 16281,
+  "is_hyper_param_search": false,
+  "is_local_process_zero": true,
+  "is_world_process_zero": true,
+  "log_history": [
+    {
+      "epoch": 0.09,
+      "learning_rate": 1.9815736134144095e-05,
+      "loss": 0.1826,
+      "step": 500
+    },
+    {
+      "epoch": 0.18,
+      "learning_rate": 1.963147226828819e-05,
+      "loss": 0.1317,
+      "step": 1000
+    },
+    {
+      "epoch": 0.28,
+      "learning_rate": 1.9447208402432286e-05,
+      "loss": 0.1146,
+      "step": 1500
+    },
+    {
+      "epoch": 0.37,
+      "learning_rate": 1.9262944536576377e-05,
+      "loss": 0.1078,
+      "step": 2000
+    },
+    {
+      "epoch": 0.46,
+      "learning_rate": 1.9078680670720474e-05,
+      "loss": 0.1006,
+      "step": 2500
+    },
+    {
+      "epoch": 0.55,
+      "learning_rate": 1.8894416804864568e-05,
+      "loss": 0.0976,
+      "step": 3000
+    },
+    {
+      "epoch": 0.64,
+      "learning_rate": 1.871015293900866e-05,
+      "loss": 0.096,
+      "step": 3500
+    },
+    {
+      "epoch": 0.74,
+      "learning_rate": 1.8525889073152755e-05,
+      "loss": 0.0925,
+      "step": 4000
+    },
+    {
+      "epoch": 0.83,
+      "learning_rate": 1.8341625207296852e-05,
+      "loss": 0.0921,
+      "step": 4500
+    },
+    {
+      "epoch": 0.92,
+      "learning_rate": 1.8157361341440943e-05,
+      "loss": 0.0911,
+      "step": 5000
+    },
+    {
+      "epoch": 1.0,
+      "eval_accuracy": 0.40213785477331365,
+      "eval_f1": 0.5346146303196705,
+      "eval_loss": 0.08816272765398026,
+      "eval_roc_auc": 0.7098850238721621,
+      "eval_runtime": 11.8306,
+      "eval_samples_per_second": 458.641,
+      "eval_steps_per_second": 57.394,
+      "step": 5427
+    },
+    {
+      "epoch": 1.01,
+      "learning_rate": 1.797309747558504e-05,
+      "loss": 0.0897,
+      "step": 5500
+    },
+    {
+      "epoch": 1.11,
+      "learning_rate": 1.7788833609729134e-05,
+      "loss": 0.0856,
+      "step": 6000
+    },
+    {
+      "epoch": 1.2,
+      "learning_rate": 1.7604569743873227e-05,
+      "loss": 0.0816,
+      "step": 6500
+    },
+    {
+      "epoch": 1.29,
+      "learning_rate": 1.742030587801732e-05,
+      "loss": 0.0853,
+      "step": 7000
+    },
+    {
+      "epoch": 1.38,
+      "learning_rate": 1.7236042012161415e-05,
+      "loss": 0.0846,
+      "step": 7500
+    },
+    {
+      "epoch": 1.47,
+      "learning_rate": 1.7051778146305512e-05,
+      "loss": 0.0843,
+      "step": 8000
+    },
+    {
+      "epoch": 1.57,
+      "learning_rate": 1.6867514280449606e-05,
+      "loss": 0.0807,
+      "step": 8500
+    },
+    {
+      "epoch": 1.66,
+      "learning_rate": 1.66832504145937e-05,
+      "loss": 0.0796,
+      "step": 9000
+    },
+    {
+      "epoch": 1.75,
+      "learning_rate": 1.6498986548737793e-05,
+      "loss": 0.081,
+      "step": 9500
+    },
+    {
+      "epoch": 1.84,
+      "learning_rate": 1.6314722682881887e-05,
+      "loss": 0.0798,
+      "step": 10000
+    },
+    {
+      "epoch": 1.93,
+      "learning_rate": 1.613045881702598e-05,
+      "loss": 0.0821,
+      "step": 10500
+    },
+    {
+      "epoch": 2.0,
+      "eval_accuracy": 0.44010320678216,
+      "eval_f1": 0.5612426312342098,
+      "eval_loss": 0.08432479202747345,
+      "eval_roc_auc": 0.7305379849481191,
+      "eval_runtime": 11.8056,
+      "eval_samples_per_second": 459.613,
+      "eval_steps_per_second": 57.515,
+      "step": 10854
+    },
+    {
+      "epoch": 2.03,
+      "learning_rate": 1.5946194951170078e-05,
+      "loss": 0.0776,
+      "step": 11000
+    },
+    {
+      "epoch": 2.12,
+      "learning_rate": 1.5761931085314172e-05,
+      "loss": 0.0726,
+      "step": 11500
+    },
+    {
+      "epoch": 2.21,
+      "learning_rate": 1.5577667219458266e-05,
+      "loss": 0.0718,
+      "step": 12000
+    },
+    {
+      "epoch": 2.3,
+      "learning_rate": 1.539340335360236e-05,
+      "loss": 0.0735,
+      "step": 12500
+    },
+    {
+      "epoch": 2.4,
+      "learning_rate": 1.5209139487746453e-05,
+      "loss": 0.0735,
+      "step": 13000
+    },
+    {
+      "epoch": 2.49,
+      "learning_rate": 1.5024875621890549e-05,
+      "loss": 0.0721,
+      "step": 13500
+    },
+    {
+      "epoch": 2.58,
+      "learning_rate": 1.4840611756034643e-05,
+      "loss": 0.0722,
+      "step": 14000
+    },
+    {
+      "epoch": 2.67,
+      "learning_rate": 1.4656347890178736e-05,
+      "loss": 0.0751,
+      "step": 14500
+    },
+    {
+      "epoch": 2.76,
+      "learning_rate": 1.4472084024322832e-05,
+      "loss": 0.0727,
+      "step": 15000
+    },
+    {
+      "epoch": 2.86,
+      "learning_rate": 1.4287820158466926e-05,
+      "loss": 0.0735,
+      "step": 15500
+    },
+    {
+      "epoch": 2.95,
+      "learning_rate": 1.4103556292611021e-05,
+      "loss": 0.0714,
+      "step": 16000
+    },
+    {
+      "epoch": 3.0,
+      "eval_accuracy": 0.47475119793586434,
+      "eval_f1": 0.5862595419847328,
+      "eval_loss": 0.0838962271809578,
+      "eval_roc_auc": 0.7506773514396311,
+      "eval_runtime": 11.8261,
+      "eval_samples_per_second": 458.814,
+      "eval_steps_per_second": 57.415,
+      "step": 16281
+    }
+  ],
+  "max_steps": 54270,
+  "num_train_epochs": 10,
+  "total_flos": 8568237917583360.0,
+  "trial_name": null,
+  "trial_params": null
+}