fast-split-tests / tests /ATOM_COVERAGE_REPORT.md
ArthurZ's picture
ArthurZ HF Staff
add fast_split test harnesses + tokenizer caches
ad01ed3 verified
|
Raw
History Blame Contribute Delete
10.1 kB
╔══════════════════════════════════════════════════════════════════════════════╗
β•‘ FAST_SPLIT ATOM VALIDATION HARNESS - FINAL SUMMARY β•‘
β•šβ•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•
GENERATED ARTIFACTS:
πŸ“ tokenizers/fast_split/tests/
β”œβ”€β”€ atom_validation_harness.py # Full Python harness (fetches from HF)
β”œβ”€β”€ harness_generated.py # Test vector generator
β”œβ”€β”€ test_gen_atom_parity.rs # 30 Rust unit tests (auto-generated)
└── ATOM_COVERAGE_REPORT.md # This report
═══════════════════════════════════════════════════════════════════════════════
UNIQUE PATTERNS TO SUPPORT: 8 TOTAL
═══════════════════════════════════════════════════════════════════════════════
Implemented (βœ“) vs TODO (β—‹):
β”Œβ”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ A1 β”‚ fsm_split<DELIM, BEHAVIOR> ── Split delimiter variants β”‚
β”‚ β”‚ βœ“ WhitespaceSplit (Split<WS, Removed>) β”‚
β”‚ β”‚ βœ“ Punctuation (Split<PUNCT, Isolated>) β”‚
β”‚ β”‚ βœ“ Digits (Split<NUMERIC, Contiguous>) β”‚
β”‚ β”‚ βœ“ Metaspace (Split<Space→▁, MergedWithNext>) β”‚
β”‚ β”‚ β—‹ CharDelimiterSplit (byte compare, no tag) β”‚
β”‚ β”‚ βœ— Split(Regex) ── ESCAPE HATCH (not in atoms) β”‚
β”œβ”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€
β”‚ A2 β”‚ fsm_class_runs<DROP, ISOLATE, SPLIT> ── Class-change boundary β”‚
β”‚ β”‚ βœ“ Whitespace (drop WS, keep Word+Symbol) β”‚
β”‚ β”‚ βœ“ BertPreTokenizer (drop WS, isolate PUNCT) β”‚
β”œβ”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€
β”‚ A3 β”‚ fsm_cl100k ── OpenAI cl100k/o200k 7-rule pretokenizer β”‚
β”‚ β”‚ βœ“ Rule 1: 's/'t/'re/'ve/'m/'ll/'d contractions β”‚
β”‚ β”‚ βœ“ Rule 2: [^\r\n\p{L}\p{N}]?\p{L}+ β”‚
β”‚ β”‚ βœ“ Rule 3: \p{N}{1,3} (digit cap) β”‚
β”‚ β”‚ βœ“ Rule 4: [^\s\p{L}\p{N}]+[\r\n]* β”‚
β”‚ β”‚ βœ“ Rules 5-7: whitespace handling β”‚
β”œβ”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€
β”‚ A4 β”‚ fsm_deepseek ── DeepSeek-V3 Sequence pretokenizer β”‚
β”‚ β”‚ βœ“ Split-1: \p{N}{1,3} β”‚
β”‚ β”‚ βœ“ Split-2: [δΈ€-ιΎ₯぀-γ‚Ÿγ‚ -γƒΏ]+ (CJK isolation) β”‚
β”‚ β”‚ βœ“ Split-3: big regex (5 alts) β”‚
β”‚ β”‚ βœ“ ByteLevel final pass β”‚
β”œβ”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€
β”‚ A5 β”‚ fsm_byte_level ── GPT-2 / Llama 3 / Mistral / Qwen style β”‚
β”‚ β”‚ βœ“ GPT-2 regex (use_regex=true) β”‚
β”‚ β”‚ βœ“ Simple ByteLevel (use_regex=false, for postprocessing) β”‚
β”œβ”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€
β”‚ A6 β”‚ fsm_script_run ── UnicodeScripts (TODO stub in PR) β”‚
β”‚ β”‚ β—‹ Script change boundary β”‚
β”‚ β”‚ β—‹ Transparent set {Common, Inherited, Any} β”‚
β”œβ”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€
β”‚null β”‚ SentencePiece ── External (T5, Llama 1/2, etc.) β”‚
β”‚ β”‚ N/A ── handled by SPM, not in tokenizer.json pre_tokenizer β”‚
β””β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
═══════════════════════════════════════════════════════════════════════════════
TEST VECTOR COVERAGE (30 canonical cases)
═══════════════════════════════════════════════════════════════════════════════
Generated test vectors cover:
β€’ Contractions ('t/'re/'s/'ve/'m/'ll/'d) ── 3 cases
β€’ CJK/Unicode boundary isolation ── 4 cases
β€’ Number caps ({1,3} vs unbounded) ── 2 cases
β€’ Whitespace edge cases ── 4 cases
β€’ Punctuation isolation ── 3 cases
β€’ Multiscript boundaries ── 3 cases
β€’ Symbol/word run boundaries ── 2 cases
β€’ Null pre_tokenizer (SPM) ── 1 case
β–Ί Total: 30 byte-exact parity tests
═══════════════════════════════════════════════════════════════════════════════
WHAT YOU NEED TO HAND-UNROLL: 0 (ZERO!)
═══════════════════════════════════════════════════════════════════════════════
All 8 canonical patterns already map to your atoms:
A1 Split family β†’ WhitespaceSplit, Punctuation, Digits, Metaspace
A2 ClassRuns family β†’ Whitespace, BertPreTokenizer
A3 cl100k β†’ GPT-4/Claude/OpenAI
A4 deepseek β†’ DeepSeek-V3/R1
A5 byte_level β†’ Llama 3/Qwen/Mistral/GPT-2
A6 script_run β†’ UnicodeScripts (stub exists)
null β†’ SentencePiece (external)
The ONLY escape hatch needed:
βœ— Split(Regex) with arbitrary patterns β†’ Feature-gated fallback to onig
═══════════════════════════════════════════════════════════════════════════════
NEXT STEPS TO COMPLETE
═══════════════════════════════════════════════════════════════════════════════
1. FINISH A6 (UnicodeScripts):
β†’ Implement SCRIPT_RANGES lookup tables (like ATOM_TABLES)
β†’ Hook up to fsm_script_run()
2. ADD escape_hatch Split(Regex):
β†’ Feature-gated, for DeBERTa/FairSeq edge cases only
β†’ Path: onig for rare cases, fast atoms for 99%
3. RUN THE HARNESS:
$ cd tokenizers/fast_split/tests
$ python atom_validation_harness.py --test-local
4. VERIFY span-exact parity:
β†’ Every test case must match HF reference byte-for-byte
β†’ This is the "byte-exactness gate" from your spec Β§8
═══════════════════════════════════════════════════════════════════════════════
FILES LOCATION
═══════════════════════════════════════════════════════════════════════════════
/Users/arthurzucker/Work/tokenizers/tokenizers/fast_split/tests/
β”œβ”€β”€ atom_validation_harness.py ← Run this for full testing
β”œβ”€β”€ harness_generated.py ← Test vector generator
└── test_gen_atom_parity.rs ← 30 Rust tests (check into repo)
To use:
python3 tests/atom_validation_harness.py --report # Show registry
python3 tests/harness_generated.py # Generate Rust tests