SCRIPT: Script/Category Representation In (Pre-)Tokenization

This repository provides tools for tokenization, focused on SCRIPT encoding, but also supporting UTF-8. It contains implementations for BPE, Unigram, MinGram, PathPiece, and ConvexTok tokenization algorithms.

For details of the methods, see the papers:

• BPE Stays on SCRIPT: Structured Encoding for Robust Multilingual Pretokenization
• Which Pieces Does Unigram Tokenization Really Need?
• MinGram: A Minimalist Unigram Tokenizer with High Compression and Competitive Morphological Alignment

Overview

This repository provides tools for SCRIPT encoding-based pre-tokenization with BPE and Unigram, as well as regular byte-based tokenization.

Core Modules (script_bpe/)

• pretokenize/: Pre-tokenizers that handle both chunking and encoding to 'atomic' or 'base' tokens (bytes or script/index pairs)

  • bytes_gpt4/bytes_gpt4o: Classic regex + UTF-8 based tokenizer
  • bytes_gpt4o_cb: With character boundaries enforcement
  • scriptenc_cb: SCRIPT encoding with character boundaries (proposed BPE algorithm)
  • scriptenc_cbi: SCRIPT encoding with inherited script enforcement
  • scriptenc_gpt4o_cb: Hybrid (regex chunking + script encoding)

• tokenizers/: Tokenization algorithms

  • bpe/: Byte Pair Encoding implementation with multi-worker training
  • unigram/: Unigram language model with EM training, Trie, and Lattice-based Viterbi decoding
  • mingram/: MinGram hard-EM tokenizer and MinGram-PP via MI pruning
  • pathpiece/: PathPiece-style minimum-token inference baseline
  • convextok/: ConvexTok vocabulary-selection baseline

• corpus/: Pretokenized corpus management

  • PretokenizedCorpus: Partitioned storage for efficient parallel training

• analysis/: Evaluation utilities

  • Compression metrics, morphological scoring, experiment tracking

Usage

Installation

Ensure you have uv, it should take care of the rest.

For MorphAlign evaluations, you need to initialize the submodule with:

git submodule update --init eval/morph-tok-eval

Training

To explore the available options for training, run:

uv run train --help

To train a BPE tokenizer:

uv run train --corpus kor_hang_300mb -n 64000 --pretokenizer scriptenc_cb --model bpe

To train a Unigram tokenizer:

uv run train --corpus kor_hang_300mb -n 64000 --pretokenizer scriptenc_cb --model unigram

Reproducing Paper Results

The paper_utils/ directory contains scripts to reproduce paper results from scratch:

• paper_utils/script_bpe/: BPE paper reproduction

  • Paper: BPE Stays on SCRIPT
  • train_monolingual.sh / train_multilingual.sh: Training scripts
  • monolingual_compression.ipynb / multilingual_compression.ipynb: Analysis notebooks

• paper_utils/unigram/: Unigram Pieces paper reproduction

  • Paper: Which Pieces Does Unigram Tokenization Really Need?
  • run_all_experiments.sh: Run all experiments
  • generate_main_tables.py / generate_appendix_tables.py: Generate paper tables
  • train_hyperparameters.py: Hyperparameter tuning experiments

• paper_utils/hybrid/: MinGram tokenizer paper reproduction

  • Paper: MinGram: A Minimalist Unigram Tokenizer with High Compression and Competitive Morphological Alignment
  • run_all_experiments.sh: Train the active tokenizer set and regenerate paper tables/figures.
  • build_token_usage_counts.py: Rebuild the rare-token count parquet used by downstream tables.

Sources

• An interesting explanation of UTF-8 is given by Computerphile
• For more information on Unicode character properties, refer to the Wikipedia article.