docs(bench): speculative_bench module docs contradict its own code in three places
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 92/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- rust
- Domain
- documentation
Research direction
Start in src/bin/speculative_bench.rs by comparing the module docs and long_about with REACHABLE_PAIRINGS and the MTP, DFlash, and batch-sweep descriptions. Update the three contradictory passages so they match the code and pairing table; no run is required.
Written by the indexing model from the issue text.
Description
Summary
Correct three passages in speculative_bench's module docs and long_about that contradict the code in the same file: a stale target count, a batch-sweep claim the code disowns, and a "deferred" claim about a path that already records real numbers.
Background
The doc comments were written against an earlier version of the file and drifted as the pairing table and the MTP path grew. A reader trusting the header comes away with the wrong set of reachable targets, the wrong batch behavior, and the wrong idea that MTP is not yet measured.
Proposed Solution
Edit the three passages so the module docs, long_about, and the pairing table describe what the code does. No run required.
Implementation Notes
src/bin/speculative_bench.rs:21claims the two reachable targetsmodels/qwen3.5-4b-4bitandmodels/gemma-4-31b-it-4bit;REACHABLE_PAIRINGSactually lists four targets, addinggemma-4-12b-it-4bit(:279) andqwen3.8-27b-4bit(:297).:61says "Full sweep across pairings (B = 1, 2, 4)", but the sweep logs benching at B=1 and--batch's own doc notes the baseline path always runs B=1 today.:118-121long_aboutsays speculative paths are "scaffolded but deferred to follow-up", which contradicts the module body: MTP records real decode tok/s; only DFlash is deferred.- Distinct from #1667, the
--promptpanic in the same binary.
Acceptance Criteria
- Module docs,
long_about, and the pairing table tell one consistent story matching the code.
Original Suggestion
Title: docs(bench): speculative_bench module docs contradict its own code in three places
speculative_bench's module docs and long_about contradict the code in the same file in three places — stale target counts, a batch-sweep claim the code disowns, and a "deferred" claim about a path that ships.
Evidence
src/bin/speculative_bench.rs:21— claims "the two reachable target models (models/qwen3.5-4b-4bit,models/gemma-4-31b-it-4bit)";REACHABLE_PAIRINGS(:243-308) lists four targets, addinggemma-4-12b-it-4bit(:281) andqwen3.8-27b-4bit(:298):61— "Full sweep across pairings (B = 1, 2, 4)"; the sweep logs "benching {} pairings at B=1" (:948-950) and--batch's own doc says "The baseline path always runs B=1 today" (:139-141):118-121—long_aboutsays "Speculative paths are scaffolded but deferred to follow-up", contradicting:26-33and:94-99(MTP records real decode tok/s; only DFlash at:100-103is deferred)
Suggested fix
Update the three passages against the code in the same file. No run required.
(Distinct from #1667, the --prompt panic in this binary.)
Acceptance criteria
- Module docs,
long_about, and the pairing table tell one consistent story
- Dominant language
- Rust
- Stars
- 470
- Forks
- 54
- Avg merge
- 4h 45m
- Merged PRs (30d)
- 305
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from lablup/mlxcel
-
area:core priority:low status:ready type:chore
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
priority:low status:ready type:docs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
docs(webpage): add a webpage/site README covering the pnpm/uv/zensical build and deploy contract Openpriority:low status:ready type:docs
Difficulty 1/5 1-3 hours Newbie friendliness 86/100
-
docs: CONTRIBUTING says clippy is not gated at PR time, but ci.yml runs -D warnings clippy on PRs Openpriority:medium status:ready type:docs
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
priority:low status:ready type:docs
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
gitbutlerapp/gitbutler#15998 · 1 comment ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100