Fast BPE tokenizer/trainer with a Rust core and Python bindings
Project description
unitoken
unitoken is a fast BPE tokenizer/trainer with a Rust core and optional Python bindings.
Install
Rust:
cargo add unitoken
Python (wheels via PyPI):
pip install uni-tokenizer
Quickstart (Python)
from uni_tokenizer import BpeTrainer, BpeEncoder
trainer = BpeTrainer(["<|endoftext|>"]) # first token is treated as EOT
trainer.add_words({"hello": 10, "world": 7})
trainer.train(vocab_size=256)
trainer.save("demo")
enc = BpeEncoder.load("demo")
ids = enc.encode_word("hello")
Tiktoken-compatible API
unitoken also exposes a tiktoken-shaped Python API:
from uni_tokenizer import Encoding
enc = Encoding.from_files(
"demo",
vocab_file="vocab.demo[u8].json",
merges_file="merges.demo[u8].txt",
special_tokens={"<|endoftext|>": 0},
)
ids = enc.encode("hello world")
text = enc.decode(ids)
The package also includes a uni_tokenizer.tiktoken namespace with Encoding,
get_encoding, encoding_for_model, encoding_name_for_model, and
list_encoding_names. Built-in registry names are limited to local unitoken
fixture models for now; use Encoding.from_files(...) for trained models.
Benchmark against tiktoken
Install the dev dependency and run:
uv pip install "tiktoken>=0.12.0"
python benchmarks/compare_tiktoken.py
The benchmark reports unitoken encode/decode timings and, when upstream
tiktoken is importable, matching upstream timings.
Benchmark training against Hugging Face
Install the dev dependency and run:
uv pip install "tokenizers>=0.22.1"
python benchmarks/compare_hf_training.py
The benchmark trains unitoken and Hugging Face tokenizers on the same
word-frequency fixture, checks that the learned byte-level BPE vocabularies
match, and reports median training speed.
For an end-to-end raw text comparison:
python benchmarks/compare_hf_training.py --text out/fineweb2_1GiB.txt --chunk-size 1048576 --boundary line --repeats 1
Raw text mode reports unitoken pretokenization and BPE training phases
separately, then compares the total against Hugging Face raw training. By
default, Hugging Face receives the same chunk boundaries as unitoken so vocab
parity is not affected by iterator boundary differences. Pass
--hf-chunk-bytes to force fixed byte chunks for Hugging Face.
Chunking supports explicit boundary modes:
auto: split on the EOT token when present, otherwise line boundaries, then UTF-8 byte boundaries as a last resort.eot: split only on the EOT token.line: split on newline boundaries.utf8: split near byte boundaries while preserving valid UTF-8.
Use --chunk-size BYTES when you want target chunk size instead of a fixed
chunk count.
Prepare benchmark data
To create a larger raw UTF-8 text sample from local FineWeb2 Parquet shards:
python benchmarks/create_fineweb2_sample.py --input-dir /path/to/fineweb2/10BT
This is a data-preparation step. Use the generated text with the CLI or a separate benchmark that measures pretokenization/training on raw input.
Building from source
This project uses maturin for the Python extension module.
maturin develop
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file uni_tokenizer-0.1.3.tar.gz.
File metadata
- Download URL: uni_tokenizer-0.1.3.tar.gz
- Upload date:
- Size: 81.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8dc043c3353801da6a1d3e5df4300917b1500afc403860ce363e3bfcba98280a
|
|
| MD5 |
f06474442009419c86910dd526089d31
|
|
| BLAKE2b-256 |
492a9e4c3901548e2fb8e9b0993ac4e32c578c06629db61e42f4c556a96bea4d
|
File details
Details for the file uni_tokenizer-0.1.3-cp38-abi3-win_amd64.whl.
File metadata
- Download URL: uni_tokenizer-0.1.3-cp38-abi3-win_amd64.whl
- Upload date:
- Size: 1.4 MB
- Tags: CPython 3.8+, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2a0143677b95a7d30dd7708b07cd4137c1021739f801d5940ebe903734617c90
|
|
| MD5 |
1746d9880fb1bf1ca720861b3f4ab934
|
|
| BLAKE2b-256 |
3edf4bf8454ca6cdb9f4b0b3957295fce9a9a70ff1aac592d6ffaaf62f9684a6
|
File details
Details for the file uni_tokenizer-0.1.3-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.
File metadata
- Download URL: uni_tokenizer-0.1.3-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
- Upload date:
- Size: 1.5 MB
- Tags: CPython 3.8+, manylinux: glibc 2.17+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7d0bbe24d371a99f46e373acd3722d87029dbce2ba9dfc4b4529bd814176a6fb
|
|
| MD5 |
2ede5ecd3c94ca56290f4eb0ef91f4da
|
|
| BLAKE2b-256 |
ac9c15f433ec72a0d5ecc8c6de836581d8b91d9c4f7a94364f2f73176f91b856
|
File details
Details for the file uni_tokenizer-0.1.3-cp38-abi3-macosx_11_0_arm64.whl.
File metadata
- Download URL: uni_tokenizer-0.1.3-cp38-abi3-macosx_11_0_arm64.whl
- Upload date:
- Size: 1.3 MB
- Tags: CPython 3.8+, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
edd554ae56c50f6bcb316c33aca12435cb11dd08546029c59e6c60b39547a5e4
|
|
| MD5 |
99cd421fb03a6361fa76e2080acda2cd
|
|
| BLAKE2b-256 |
f2530125f1c8b6a0ce2811c15d8bde4e7f0055d7e9f28e5d3b24f33c6c25942a
|