tinynext / README.md
cfahlgren1's picture
cfahlgren1 HF Staff
license under mit
c74bb5d verified
|
Raw History Blame Contribute Delete
14.9 kB
---
license: mit
library_name: onnx
pipeline_tag: text-generation
datasets:
- corbt/enron-emails
- HuggingFaceFW/fineweb-edu
- HuggingFaceTB/smoltalk
language:
- en
tags:
- autocomplete
- gru
- transformer
- fill-in-the-middle
- onnxruntime-web
- in-browser
- offline-page
model-index:
- name: tinynext-v2
results:
- task:
type: text-generation
name: Autocomplete (typing saved at a 50% cutoff)
dataset:
type: wikimedia/wikipedia
name: Wikipedia articles (held out)
metrics:
- type: typing_saved
name: Typing saved (%)
value: 3.9
- type: suggestion_precision
name: Suggestions that were right (%)
value: 78
- task:
type: text-generation
name: Autocomplete (typing saved at a 50% cutoff)
dataset:
type: OpenAssistant/oasst1
name: OpenAssistant messages, validation split
metrics:
- type: typing_saved
name: Typing saved (%)
value: 8.8
- type: suggestion_precision
name: Suggestions that were right (%)
value: 75
- task:
type: text-generation
name: Autocomplete (typing saved at a 50% cutoff)
dataset:
type: corbt/enron-emails
name: Enron emails from held-out senders
metrics:
- type: typing_saved
name: Typing saved (%)
value: 4.0
- type: suggestion_precision
name: Suggestions that were right (%)
value: 78
---
<p align="center">
<img src="banner.png" alt="tinynext: suggests the next few words, Tab to take them" width="880">
</p>
<p align="center">
<img style="display: inline-block; vertical-align: middle; margin: 2px;" alt="params: 12.5M" src="https://img.shields.io/badge/params-12.5M-6e6e73?style=flat-square&labelColor=1d1d1f"> <img style="display: inline-block; vertical-align: middle; margin: 2px;" alt="size: 13.3 MB" src="https://img.shields.io/badge/size-13.3%20MB-6e6e73?style=flat-square&labelColor=1d1d1f"> <img style="display: inline-block; vertical-align: middle; margin: 2px;" alt="speed: ~5 ms" src="https://img.shields.io/badge/speed-~5%20ms-6e6e73?style=flat-square&labelColor=1d1d1f"> <img style="display: inline-block; vertical-align: middle; margin: 2px;" alt="runs: in browser" src="https://img.shields.io/badge/runs-in%20browser-6e6e73?style=flat-square&labelColor=1d1d1f"> <img style="display: inline-block; vertical-align: middle; margin: 2px;" alt="data sent: none" src="https://img.shields.io/badge/data%20sent-none-6e6e73?style=flat-square&labelColor=1d1d1f">
</p>
<h3 align="center">Gray text that finishes your sentence.<br>A 13 MB model that runs in a browser tab.</h3>
<p align="center">
<a href="https://offlinepage.app"><b>Write with it in offlinepage.app&nbsp;→</b></a>
</p>
<br>
tinynext is the autocomplete in [offlinepage.app](https://offlinepage.app). It reads the text around the cursor and, when it's sure enough, shows the next few words in gray. Press <kbd>Tab</kbd> to take them. It runs in a Web Worker with [ONNX Runtime Web](https://onnxruntime.ai/docs/tutorials/web/), so nothing you type is sent anywhere.
The model the app uses is in [`v2/`](https://huggingface.co/paperweight/tinynext/tree/main/v2). The files at the root of this repo are v1, an earlier and much smaller character model, described [at the end](#v1-the-original-character-model).
## What it does
<p align="center">
<img src="what-it-does.png" alt="You type: Please accept my resignation. I will be o. You get: the same text with “ut of the office” offered in gray, and Tab to take it." width="880">
</p>
| You type | It suggests |
|---|---|
| Please accept my resignation. I will be o | **ut of the office** |
| See you on the ground. I look f | **orward to** |
It stays quiet most of the time. A suggestion only appears when the model is at least 40% sure of the whole phrase, and it has to be four characters or longer.
## How well it works
Every model here is scored the same way by [`v2/eval.py`](v2/eval.py): type held-out text character by character, pause every 12 characters, and count a suggestion only if the text really continues that way. These numbers use a 50% cutoff; the app now uses 40%, so it suggests a little more often and is right a little less often.
**How much typing it saves:**
| Writing | v1 | **v2** | SmolLM2-135M (about 100 MB) |
|---|---|---|---|
| Articles (Wikipedia) | 1.5% | **3.9%** | 8.1% |
| Messages (OpenAssistant) | 2.0% | **8.8%** | 16.8% |
| Email (Enron, unseen senders) | 3.0% | **4.0%** | 5.7% |
**How often it speaks up, and how often it's right:**
| Writing | Suggests at | Right | 2+ words suggested at | 2+ words right |
|---|---|---|---|---|
| Articles (Wikipedia) | 10% | 78% | 4% | 71% |
| Messages (OpenAssistant) | 19% | 75% | 9% | 70% |
| Email (Enron, unseen senders) | 11% | 78% | 4% | 51% |
“Suggests at” is the share of pauses where it offered anything. “Right” means the suggestion exactly matched what the person typed next.
### Limits
- offlinepage.app only suggests at the end of a paragraph. Mid-line suggestions, where reading the text after the cursor should help most, aren't built yet.
- It still leans toward office email, and it only sees keyboard characters.
- English only.
## In the browser
| Setting | Value |
|---|---|
| Download | **13.3 MB**: 8-bit weights with one scale per 64 values, expanded to float32 when the page loads |
| Matches full precision | Same next word 96% of the time, same 5-word path 90% |
| Speed | **5 ms** per suggestion (13 ms at the slow end) in a Web Worker, Chrome on an M3 Max |
The browser computes in float32 on purpose. ONNX Runtime Web's 8-bit kernels were 8 to 11 times slower than its float kernels for this model, and 8-bit activations changed the top word too often. Only the download is compressed.
## How it was trained
**The task.** Predict the next word piece. Half of the training examples are fill-in-the-middle: the model also sees the text after a gap, so it can suggest in the middle of a paragraph as well as at the end.
**The data.** 3 billion tokens of writing like what people type: 60% [FineWeb-Edu](https://huggingface.co/datasets/HuggingFaceFW/fineweb-edu) articles, 30% [SmolTalk](https://huggingface.co/datasets/HuggingFaceTB/smoltalk) conversations and 10% [Enron email](https://huggingface.co/datasets/corbt/enron-emails), with the emails split by sender so the test senders are never seen.
**The model.** A small transformer that reads up to about 1,500 characters before the cursor.
| Setting | Value |
|---|---|
| Parameters | 12.5 million |
| Layers / width / heads | 8 / 320 / 5 |
| Tokenizer | 8,192 byte-level BPE pieces, so one step can be a whole word |
| Context | 512 tokens |
| Training | One pass over 3 billion tokens, batch 512, learning rate 0.003 |
| Time | 56 minutes on one A100 at 920,000 tokens a second, with [Hugging Face Jobs](https://huggingface.co/docs/huggingface_hub/guides/jobs) |
| Validation loss | 2.89 |
The data is tokenized once on a CPU job, and the GPU job trains from the prepared files. [Training curves are on Trackio](https://huggingface.co/spaces/cfahlgren1/tinynext-trackio).
**What the runs showed.** Three runs of the same model, scored as typing saved on articles / messages / email. *Editing* is the same test with text after the cursor.
| Run | Training tokens | Fill-in-the-middle | Typing | Editing | Val loss |
|---|---|---|---|---|---|
| **v2 (this one)** | **3B** | half the examples | **3.9 / 8.8 / 4.0** | **3.1 / 7.6 / 4.2** | **2.89** |
| First v2 | 1.5B | half the examples | 4.0 / 7.3 / 4.3 | 2.8 / 6.3 / 3.6 | 2.99 |
| [No fill-in-the-middle](https://huggingface.co/paperweight/tinynext/tree/main/v2/experiments/tinynext-v2-nofim) | 1.5B | none | 3.9 / 8.8 / 4.2 | 3.0 / 6.9 / 4.1 | 2.94 |
At 1.5 billion tokens, fill-in-the-middle cost more than it gave: half the training went to a task the model rarely uses. With twice the tokens it stops costing anything on typing and helps when editing.
<details>
<summary><b>Would a bigger model help?</b></summary>
[Pythia](https://huggingface.co/EleutherAI/pythia-160m) models are trained the same way at every size, so they show what size alone buys. Typing saved, 300 pauses per kind of writing (tinynext: 1,000):
| Model | Parameters | Articles | Messages | Email |
|---|---|---|---|---|
| Pythia | 14M | 3.6% | 6.1% | 2.4% |
| Pythia | 31M | 4.0% | 6.6% | 4.0% |
| Pythia | 70M | 7.0% | 8.0% | 4.9% |
| Pythia | 160M | 7.3% | 10.5% | 7.9% |
| SmolLM2 | 135M | 8.1% | 16.8% | 5.7% |
| **tinynext v2** | **12.5M** | **3.9%** | **8.8%** | **4.0%** |
tinynext matches Pythia models two to three times its size because it trained on writing like what people type. Size starts to pay off between 30M and 70M parameters, and better data (SmolLM2) matters as much as size.
</details>
<details>
<summary><b>Train it yourself</b></summary>
```bash
# Prepare data once on a CPU job, then train on a GPU from the prepared files.
hf jobs uv run --flavor cpu-xl --secrets HF_TOKEN train.py --stage prepare --tokens 3e9 --fineweb-files 4
hf jobs uv run --flavor a100-large --secrets HF_TOKEN train.py --stage train --tokens 3e9 --fineweb-files 4
```
</details>
<details>
<summary><b>v2 files</b></summary>
| File | What it is |
|---|---|
| `v2/web/graph.onnx`, `weights.q8`, `weights.json` | The browser model: graph, int8 weights and how to expand them |
| `v2/web/tokenizer.json`, `config.json` | 8K byte-level BPE tokenizer and model shape |
| `v2/model.safetensors` | Float32 weights |
| `v2/train.py` | Data prep, training, eval, export and upload in one script |
| `v2/eval.py`, `v2/eval_set.json` | The eval harness and the fixed text it scores |
| `v2/export.py`, `v2/compress.py` | Re-export to ONNX, and the int8 download format |
| `v2/metrics/*.json` | Eval results for v1, v2, the browser format, SmolLM2-135M and Pythia 14M–160M |
| `v2/experiments/` | The no-FIM run, for comparison |
| `v2/report.json` | Training settings, loss history and export checks |
</details>
## v1: the original character model
The files at the root of this repo. v1 guesses one letter at a time, so its suggestions are short word endings. It has 944,000 parameters, is 0.98 MB, and learned only from Enron's emails. It is the same model as [`cfahlgren1/enron-autocomplete`](https://huggingface.co/cfahlgren1/enron-autocomplete), and it has [its own demo](https://huggingface.co/spaces/cfahlgren1/enron-autocomplete).
<details>
<summary><b>Everything about v1</b></summary>
**What it does**
It finishes the word or short phrase you're typing. Press <kbd>Tab</kbd> to take the suggestion.
| You type | It suggests |
|---|---|
| Please accept my resig | **nation** |
| Please accept my resignation. I will be o | **ut of the office** |
| The books are fine. Please call me i | **f you have any** |
| Enron N | **orth America Corp.** |
**How sure it has to be**
The model knows how sure it is of each guess. You pick a cutoff, and it only suggests when it's at least that sure. A higher cutoff means fewer suggestions, and more of them right.
<table>
<tr>
<td align="center" width="33%"><h2>80%</h2>of suggestions are right<br><sub>at a 50% cutoff</sub></td>
<td align="center" width="33%"><h2>11%</h2>of the time it suggests<br><sub>at a 50% cutoff</sub></td>
<td align="center" width="33%"><h2>~6</h2>characters per right suggestion</td>
</tr>
</table>
| Cutoff | How often it suggests | How often it's right |
|---|---|---|
| 20% | 30% of the time | 48% |
| 35% | 18% of the time | 66% |
| **50%** | **11% of the time** | **80%** |
| 70% | 7% of the time | 90% |
The demo uses 40%.
These numbers come from 5,000 places in emails from people the model never saw in training. “Right” means the suggestion exactly matched what the person typed next.
**Limits**
- It only knows office email from 2001. Outside that it has little to say.
- With no cutoff it rambles. “Dear Santa,” becomes “I am attaching a copy of the agreement to the Enron Corp.”
- It learned real names and sign-offs from the emails, so keep suggestions short.
- English only.
**Use it**
The model takes one character and its memory of the text so far. It returns its guess for the next character and an updated memory. So each key press is one small step.
<details>
<summary><b>JavaScript example</b></summary>
```js
import * as ort from "onnxruntime-web";
const session = await ort.InferenceSession.create("model_quint8.onnx", {
executionProviders: ["wasm"],
});
let state = new ort.Tensor("float32", new Float32Array(512), [1, 512]);
async function step(id) {
const input_id = new ort.Tensor("int64", BigInt64Array.of(BigInt(id)), [1]);
const { logits, next_state } = await session.run({ input_id, state });
state = next_state;
return logits.data;
}
let logits = await step(1); // 1 starts a new email
for (const char of "Let me kn") logits = await step(char.charCodeAt(0) - 29);
```
A character's id is its character code minus 29. A new line is 2 and the end of an email is 1. Only English keyboard characters are supported.
To build a suggestion, keep taking the most likely next character and multiply the probabilities together as you go. Stop at a new line, or when that running product drops below your cutoff. Show the text up to the last finished word.
</details>
<details>
<summary><b>Files</b></summary>
| File | What it is |
|---|---|
| `model_quint8.onnx` | The model to use. 0.98 MB. |
| `model.onnx` | The same model before shrinking. 3.8 MB. |
| `best.pt` | The PyTorch checkpoint. |
| `vocab.json` | The character ids. |
| `report.json` | The full training and test results. |
| `train.py` | The training script. |
I also tried a bigger version with 3.46M parameters and 3.5 MB. It wasn't better. When both models suggest equally often, 9% of the time, the small one is right about 85% of the time and the big one 82%. The big one got the same training settings and may need different ones to do well.
</details>
**Training**
It read 40 million characters from 119,859 emails sent from enron.com addresses, 30 times over. Typos were added to what it read, so it keeps predicting when you make one. The run took 14 minutes on one A10G with Hugging Face Jobs and cost 35 cents.
[`train.py`](train.py) is the whole thing: it downloads the emails, trains, tests and exports the model. To train your own:
```bash
hf jobs uv run --flavor a10g-large --secrets HF_TOKEN train.py --repo your-name/your-model
```
</details>
<br>
<p align="center">
<sub>tinynext is one of two tiny models behind <a href="https://offlinepage.app">offlinepage.app</a>, a writing app that works in airplane mode.<br>Its partner, <a href="https://huggingface.co/paperweight/tinyfix">tinyfix</a>, fixes typos from context.<br>Both are made by <a href="https://huggingface.co/paperweight">paperweight</a>, purpose-built small models.</sub>
</p>