docs: rewrite the README for the crate split - #2385
Open
ArthurZucker wants to merge 1 commit into
Open
Conversation
Replaces the pre-split README. Adds the subcrate map (each with why it is its own crate), the tokbench numbers including the gigatoken head-to-head, the bindings matrix, and the per-op hardware table. Perf figures are the `pipeline #2279 + #2296` tokbench snapshot and are labelled as such; bitsplit, the thread pool and the load-time fold have landed since without a re-run.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README still described the pre-split library. This rewrites it.
What's in it
<details>blocks, each answering why is this its own crate rather than just what it contains.<details>table lists the four hardware-adapted ops and their fallbacks.make slim-size.Two figures hotlink from tokbench (
figs/03-headtohead.png,figs/01-overall.png).Caveats, deliberately on the page
Perf figures are the
pipeline #2279 + #2296snapshot and are labelled as such in a<sub>under the table.bitsplit, the thread pool and the load-time fold have all landed since, so these numbers understate the branch — re-running the matrix is follow-up work, not a blocker for replacing a README that describes a library we no longer ship.Three things found while writing, not fixed here
bitsplit'sCargo.tomldescription advertises Whitespace and Bert grammars that have no modules inmodels/mod.rs. The README says six (gpt2, cl100k, o200k, tekken, deepseek, kimi); the crate metadata still says eight.huggingface.github.io/tokbench/dashboard.htmllink 404s. This README links the repo instead. Enabling Pages would be worth it — that dashboard is the best artifact there.The branch name mentions a size badge for that reason; the badge automation is not in this PR.