rwkv-tokenizer

Crates.iorwkv-tokenizer
lib.rsrwkv-tokenizer
version0.9.0
sourcesrc
created_at2024-06-15 21:16:53.672412
updated_at2024-08-16 10:53:39.039992
descriptionA fast RWKV Tokenizer
homepage
repository
max_upload_size
id1273117
size1,169,333
Cahya Wirawan (cahya-wirawan)

documentation

https://github.com/cahya-wirawan/rwkv-tokenizer

README

RWKV Tokenizer

GitHub Actions Status Crates.io Version Crates.io Downloads License: Apache 2.0

A fast RWKV Tokenizer written in Rust that supports the World Tokenizer used by the RWKV v5 and v6 models.

Installation

To use rwkv-tokenizer, add the following to your Cargo.toml file:

[dependencies]
rwkv-tokenizer = "0.8.5"

Usage

use rwkv_tokenizer::WorldTokenizer;

let text = "Today is a beautiful day. 今天是美好的一天。";
let tokenizer = WorldTokenizer::new(None).unwrap();
let tokens_ids = tokenizer.encode(text);
let decoding = tokenizer.decode(tokens_ids);
println!("tokens: {:?}", tokens_ids);
println!("text: {:?}", text);
println!("decoding: {:?}", decoding);

Performance and Validity Test

We compared the encoding results of the Rust RWKV Tokenizer and the original tokenizer using the English Wikipedia and Chinese poetries datasets. Both results are identical. The Rust RWKV Tokenizer also passes the original tokenizer's unit test. The following steps describe how to do the unit test:


We did a performance comparison on the simple English Wikipedia dataset 20220301.en among following tokenizer:

  • The original RWKV tokenizer (BlinkDL)
  • Huggingface implementaion of RWKV tokenizer
  • Huggingface LLama tokenizer
  • Huggingface Mistral tokenizer
  • Bert tokenizer
  • OpenAI Tiktoken
  • The Rust RWKV tokenizer

The comparison is done using this jupyter notebook in a M2 Mac mini. The Rust RWKV tokenizer is around 17x faster than the original tokenizer and 9.6x faster than OpenAI Tiktoken.

performance-comparison

Bugs

There are still bugs where some characters are not encoded correctly. The bug have been fixed in the version 0.3.0. This tokenizer is my very first Rust program, so it might still have many bugs and silly codes :-)

Commit count: 0

cargo fmt