├── .gitignore
├── GoEmotions.gif
├── LICENSE
├── README.md
├── TrainEmotions.ipynb
├── TrainGoEmotions.ipynb
├── package-lock.json
├── package.json
├── public
├── index.html
├── manifest.json
├── static
│ ├── js
│ │ ├── ort-wasm-simd-threaded.wasm
│ │ ├── ort-wasm-simd.wasm
│ │ ├── ort-wasm-threaded.wasm
│ │ └── ort-wasm.wasm
│ └── vocab.json
├── xtremedistil-int8.onnx
└── xtremedistill-go-emotion-int8.onnx
└── src
├── App.css
├── App.js
├── App.test.js
├── bert_tokenizer.ts
├── index.css
├── index.js
├── inference.js
├── reportWebVitals.js
└── setupProxy.js
/.gitignore:
--------------------------------------------------------------------------------
1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2 |
3 | # dependencies
4 | /node_modules
5 | /.pnp
6 | .pnp.js
7 |
8 | # testing
9 | /coverage
10 |
11 | # production
12 | /build
13 |
14 | # misc
15 | .DS_Store
16 | .env.local
17 | .env.development.local
18 | .env.test.local
19 | .env.production.local
20 |
21 | npm-debug.log*
22 | yarn-debug.log*
23 | yarn-error.log*
24 |
--------------------------------------------------------------------------------
/GoEmotions.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jobergum/browser-ml-inference/fed077a999ddfffd6d2358753d5b010dd91ac566/GoEmotions.gif
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [2022] [Jo Kristian Bergum]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Text Emotion Prediction in Browser
2 |
3 | This React App demonstrates ML Inference in the Browser using
4 |
5 | - [Cloudflare Pages](https://pages.cloudflare.com/) to deliver the React app and model via worldwide Content Delivery Network (CDN)
6 | - [ONNX Runtime Web](https://onnxruntime.ai/) for model inference in the Browser
7 | - [Huggingface](https://huggingface.co/bergum/xtremedistil-l6-h384-go-emotion) for NLP model hosting and training API (Transformer library)
8 | - [Google Colab](https://colab.research.google.com/) for model training using GPU instances
9 |
10 | Live demo at [https://aiserv.cloud/](https://aiserv.cloud/).
11 |
12 |
13 |
14 |
15 |
16 | See also my blog post [Moving ML Inference from the Cloud to the Edge](https://bergum.medium.com/moving-ml-inference-from-the-cloud-to-the-edge-d6f98dbdb2e3?source=friends_link&sk=e8183a3a8c10077110952b213ba5bef4) and [Deploy Transformer Models in the Browser with #ONNXRuntime on YouTube](https://www.youtube.com/watch?v=W_lUGPMW_Eg).
17 |
18 | The emotion prediction model is a fine-tuned version of the pre-trained language model
19 | [microsoft/xtremedistil-l6-h384-uncased](https://huggingface.co/microsoft/xtremedistil-l6-h384-uncased).
20 | The model has been fine-tuned on the
21 | [GoEmotions dataset](https://ai.googleblog.com/2021/10/goemotions-dataset-for-fine-grained.html) which is a multi-label
22 | text categorization problem.
23 |
24 |
25 | >GoEmotions, a human-annotated dataset of 58k Reddit comments extracted from popular English-language subreddits and labeled with 27 emotion categories . As the largest fully annotated English language fine-grained emotion dataset to date. In contrast to the basic six emotions, which include only one positive emotion (joy), the taxonomy includes 12 positive, 11 negative, 4 ambiguous emotion categories and 1 “neutral”, making it widely suitable for conversation understanding tasks that require a subtle differentiation between emotion expressions.
26 |
27 | Paper [GoEmotions: A Dataset of Fine-Grained Emotions](https://arxiv.org/pdf/2005.00547.pdf)
28 |
29 | - The fine-tuned model is hosted on [Huggingface:bergum/xtremedistil-l6-h384-go-emotion](https://huggingface.co/bergum/xtremedistil-l6-h384-go-emotion).
30 | - The `go_emotions` dataset is available on [Huggingface dataset hub](https://huggingface.co/datasets/go_emotions).
31 |
32 | See [TrainGoEmotions.ipynb](TrainGoEmotions.ipynb ) for how to train a model on the dataset and export the fine-tuned model to ONNX.
33 | [](https://colab.research.google.com/github/jobergum/emotion/blob/main/TrainGoEmotions.ipynb)
34 |
35 | ## ONNX-Runtime-web
36 | The model is quantized to `int8` weights and has 22M trainable parameters.
37 |
38 | Inference is multi-threaded. To use
39 | multiple inference threads, specific http headers must be presented by the CDN, see
40 | [Making your website "cross-origin isolated" using COOP and COEP](https://web.dev/coop-coep/).
41 |
42 | Three threads are used for inference. Due to this [bug](https://github.com/microsoft/onnxruntime/issues/11679)
43 | multi-threading and COOP headers had to be disabled as the model would silently fail to initialize on IOS devices.
44 |
45 | For development, the [src/setupProxy.js](src/setupProxy.js) adds the required headers.
46 | See [react issue 10210](https://github.com/facebook/create-react-app/issues/10210)
47 |
48 | ## Code Navigation
49 | - The App frontend logic is in [src/App.js](src/App.js)
50 | - The model inference logic is in [src/inference.js](src/inference.js)
51 | - The tokenizer is in [src/bert_tokenizer.js](src/bert_tokenizer.ts) which is a copy of [Google TFJS](https://raw.githubusercontent.com/tensorflow/tfjs-models/master/qna/src/bert_tokenizer.ts) (Apache 2.0)
52 | - Cloudflare header override for cross-origin coop policy to enable multi threaded inference [public/_header](public/_headers).
53 |
54 | ## Model and Language Biases
55 | The pre-trained language model was trained on text with biases,
56 | see [On the Dangers of Stochastic Parrots: Can Language Models Be Too Big?](https://dl.acm.org/doi/10.1145/3442188.3445922)
57 | for a study on the dangers of pre-trained language models and transfer learning.
58 |
59 | From dataset paper [GoEmotions: A Dataset of Fine-Grained Emotions](https://arxiv.org/pdf/2005.00547.pdf):
60 | >Data Disclaimer: We are aware that the dataset
61 | contains biases and is not representative of global
62 | diversity. We are aware that the dataset contains
63 | potentially problematic content. Potential biases in
64 | the data include: Inherent biases in Reddit and user
65 | base biases, the offensive/vulgar word lists used
66 | for data filtering, inherent or unconscious bias in
67 | assessment of offensive identity labels, annotators
68 | were all native English speakers from India. All
69 | these likely affect labeling, precision, and recall
70 | for a trained model. The emotion pilot model used
71 | for sentiment labeling, was trained on examples
72 | reviewed by the research team. Anyone using this
73 | dataset should be aware of these limitations of the
74 | dataset.
75 |
76 | ## Running this app
77 | Install Node.js/npm, see [Installing Node.js](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
78 |
79 | In the project directory, you can run:
80 |
81 | ### `npm start`
82 |
83 | Runs the app in the development mode.\
84 | Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
85 |
86 | The page will reload when you make changes.\
87 | You may also see any lint errors in the console.
88 |
89 | ### `npm run build`
90 |
91 | Builds the app for production to the `build` folder.\
92 | It correctly bundles React in production mode and optimizes the build for the best performance.
93 |
94 | ### Deploying app
95 | Clone this repo and use [Cloudflare Pages](https://pages.cloudflare.com/).
96 |
97 | ## TODO
98 | - Fix build to copy wasm files from node_modules to build to avoid having wasm files under source control.
99 | - PR and feedback welcome - create an issue to get in contact.
100 |
101 |
--------------------------------------------------------------------------------
/TrainEmotions.ipynb:
--------------------------------------------------------------------------------
1 | {
2 | "nbformat": 4,
3 | "nbformat_minor": 0,
4 | "metadata": {
5 | "colab": {
6 | "name": "TrainEmotions.ipynb",
7 | "provenance": []
8 | },
9 | "kernelspec": {
10 | "name": "python3",
11 | "display_name": "Python 3"
12 | },
13 | "language_info": {
14 | "name": "python"
15 | },
16 | "accelerator": "GPU"
17 | },
18 | "cells": [
19 | {
20 | "cell_type": "code",
21 | "execution_count": null,
22 | "metadata": {
23 | "id": "itanOMBN5EWg"
24 | },
25 | "outputs": [],
26 | "source": [
27 | "%pip install datasets transformers onnx onnxruntime "
28 | ]
29 | },
30 | {
31 | "cell_type": "markdown",
32 | "source": [
33 | "We use the small distilled BERT model from Microsoft as our pre-trained model which we fine-tune on the emotion classification task. \n",
34 | "See https://huggingface.co/microsoft/xtremedistil-l6-h256-uncased for details. "
35 | ],
36 | "metadata": {
37 | "id": "HqlT_xzmz2gt"
38 | }
39 | },
40 | {
41 | "cell_type": "code",
42 | "source": [
43 | "model_name = 'microsoft/xtremedistil-l6-h256-uncased'"
44 | ],
45 | "metadata": {
46 | "id": "kg76LB_ey0Zi"
47 | },
48 | "execution_count": 2,
49 | "outputs": []
50 | },
51 | {
52 | "cell_type": "code",
53 | "source": [
54 | "from datasets import load_dataset\n",
55 | "dataset = load_dataset(\"emotion\")\n",
56 | "from transformers import AutoTokenizer\n",
57 | "tokenizer = AutoTokenizer.from_pretrained(model_name)\n",
58 | "def tokenize_function(examples):\n",
59 | " return tokenizer(examples[\"text\"], padding=\"max_length\", truncation=True, max_length=128)\n",
60 | "tokenized_datasets = dataset.map(tokenize_function, batched=True)"
61 | ],
62 | "metadata": {
63 | "id": "olHJ-ItY5R6t"
64 | },
65 | "execution_count": null,
66 | "outputs": []
67 | },
68 | {
69 | "cell_type": "code",
70 | "source": [
71 | "full_train_dataset = tokenized_datasets[\"train\"]\n",
72 | "full_eval_dataset = tokenized_datasets[\"test\"]"
73 | ],
74 | "metadata": {
75 | "id": "LpBYSTs15h27"
76 | },
77 | "execution_count": 4,
78 | "outputs": []
79 | },
80 | {
81 | "cell_type": "code",
82 | "source": [
83 | "import torch\n",
84 | "device = \"cuda:0\" if torch.cuda.is_available() else \"cpu\"\n",
85 | "print(device)"
86 | ],
87 | "metadata": {
88 | "colab": {
89 | "base_uri": "https://localhost:8080/"
90 | },
91 | "id": "XbT3wxcL6qen",
92 | "outputId": "6f8797ee-e883-4be9-e726-3ad38a62f96a"
93 | },
94 | "execution_count": 7,
95 | "outputs": [
96 | {
97 | "output_type": "stream",
98 | "name": "stdout",
99 | "text": [
100 | "cuda:0\n"
101 | ]
102 | }
103 | ]
104 | },
105 | {
106 | "cell_type": "code",
107 | "source": [
108 | "from transformers import AutoModelForSequenceClassification\n",
109 | "model = AutoModelForSequenceClassification.from_pretrained(model_name, num_labels=6)\n",
110 | "model = model.to(device)"
111 | ],
112 | "metadata": {
113 | "id": "k1pOQHBh5l6l"
114 | },
115 | "execution_count": null,
116 | "outputs": []
117 | },
118 | {
119 | "cell_type": "code",
120 | "source": [
121 | "import numpy as np\n",
122 | "from datasets import load_metric\n",
123 | "\n",
124 | "metric = load_metric(\"accuracy\")\n",
125 | "def compute_metrics(eval_pred):\n",
126 | " logits, labels = eval_pred\n",
127 | " predictions = np.argmax(logits, axis=-1)\n",
128 | " return metric.compute(predictions=predictions, references=labels)"
129 | ],
130 | "metadata": {
131 | "id": "tBCo1LY17sYS"
132 | },
133 | "execution_count": 20,
134 | "outputs": []
135 | },
136 | {
137 | "cell_type": "code",
138 | "source": [
139 | "from transformers import TrainingArguments\n",
140 | "training_args = TrainingArguments(\"test_trainer\",\n",
141 | " per_device_train_batch_size=128, \n",
142 | " num_train_epochs=24,learning_rate=3e-05,\n",
143 | " evaluation_strategy=\"epoch\")\n",
144 | "from transformers import Trainer\n",
145 | "trainer = Trainer(\n",
146 | " model=model,\n",
147 | " args=training_args,\n",
148 | " train_dataset=full_train_dataset,\n",
149 | " eval_dataset=full_eval_dataset,\n",
150 | " compute_metrics=compute_metrics,\n",
151 | ")"
152 | ],
153 | "metadata": {
154 | "id": "S8AryVRy6xb5",
155 | "colab": {
156 | "base_uri": "https://localhost:8080/"
157 | },
158 | "outputId": "8b38f9db-ced7-42e0-9002-dc12205815de"
159 | },
160 | "execution_count": 21,
161 | "outputs": [
162 | {
163 | "output_type": "stream",
164 | "name": "stderr",
165 | "text": [
166 | "PyTorch: setting up devices\n",
167 | "The default value for the training argument `--report_to` will change in v5 (from all installed integrations to none). In v5, you will need to use `--report_to all` to get the same behavior as now. You should start updating your code and make this info disappear :-).\n"
168 | ]
169 | }
170 | ]
171 | },
172 | {
173 | "cell_type": "code",
174 | "source": [
175 | "trainer.train()"
176 | ],
177 | "metadata": {
178 | "id": "uXHzn8CH53Hh"
179 | },
180 | "execution_count": null,
181 | "outputs": []
182 | },
183 | {
184 | "cell_type": "code",
185 | "source": [
186 | "trainer.evaluate()"
187 | ],
188 | "metadata": {
189 | "colab": {
190 | "base_uri": "https://localhost:8080/",
191 | "height": 210
192 | },
193 | "id": "VC_x9_-p8LmO",
194 | "outputId": "ce714416-66f3-4408-9d02-f43eb7513e67"
195 | },
196 | "execution_count": 23,
197 | "outputs": [
198 | {
199 | "output_type": "stream",
200 | "name": "stderr",
201 | "text": [
202 | "The following columns in the evaluation set don't have a corresponding argument in `BertForSequenceClassification.forward` and have been ignored: text.\n",
203 | "***** Running Evaluation *****\n",
204 | " Num examples = 2000\n",
205 | " Batch size = 8\n"
206 | ]
207 | },
208 | {
209 | "output_type": "display_data",
210 | "data": {
211 | "text/html": [
212 | "\n",
213 | "