[None][docs] fix dead example links in legacy speculative-decoding - #18955
[None][docs] fix dead example links in legacy speculative-decoding#18955imitater-dou wants to merge 2 commits into
Conversation
Retarget Draft/Target, NGram, Medusa, ReDrafter, EAGLE, and Lookahead how-to pointers away from deleted example trees (examples/draft_target_model, run_dtm_ngram.py, medusa, redrafter, eagle, lookahead) to docs/source/features/speculative-decoding.md. Telemetry decoding_type no longer lists Medusa/Lookahead. Signed-off-by: ADou <ikun3.1415927@gmail.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review. WalkthroughThe legacy speculative decoding guide now links to current documentation, identifies removed examples and decoding types, and documents EAGLE3 ChangesSpeculative decoding documentation
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to The legacy speculative-decoding guide redirects obsolete example links to current documentation and marks removed content without any identified merge-readiness risk. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
…gg-serving.md Signed-off-by: ADou <ikun3.1415927@gmail.com>
brnguyen2
left a comment
There was a problem hiding this comment.
Approving — the comments below are optional touch-ups, not blockers.
Content checks out: examples/{draft_target_model,medusa,redrafter,eagle,lookahead} and examples/ngram/run_dtm_ngram.py are gone, examples/ngram/README.md is present, and the Draft/Target, NGram, and EAGLE 3 sections you point at exist in docs/source/features/speculative-decoding.md (which has no Medusa/Lookahead sections).
One nit beyond the inline: these could be repo-relative Markdown links (e.g. ../../features/speculative-decoding.md) so they resolve within the built docs instead of bouncing readers to GitHub. The file already used absolute URLs, so not a blocker.
| ## Lookahead Decoding | ||
|
|
||
| Lookahead decoding algorithm operates through two parallel computation branches within the same model: a lookahead branch that generates n-grams using a fixed-sized 2D window, and a verification branch that validates promising n-gram candidates. This approach eliminates the necessity for additional model training or fine-tuning and can be enabled for any autoregressive model. Refer to the [Lookahead decoding README](https://github.com/NVIDIA/TensorRT-LLM/blob/main/examples/lookahead/README.md) for information about building and running the model. | ||
| Lookahead decoding algorithm operates through two parallel computation branches within the same model: a lookahead branch that generates n-grams using a fixed-sized 2D window, and a verification branch that validates promising n-gram candidates. This approach eliminates the necessity for additional model training or fine-tuning and can be enabled for any autoregressive model. The legacy `examples/lookahead` tree has been removed, and Lookahead is no longer available as a decoding type. This section is retained for historical context only. For current speculative decoding how-tos, see [Speculative Decoding](https://github.com/NVIDIA/TensorRT-LLM/blob/main/docs/source/features/speculative-decoding.md). No newline at end of file |
There was a problem hiding this comment.
The trailing newline at end of file was dropped (the base version had one). end-of-file-fixer in .pre-commit-config.yaml will rewrite this — run pre-commit run --files docs/source/legacy/advanced/speculative-decoding.md and re-commit so CI's pre-commit check passes.
Summary
docs/source/legacy/advanced/speculative-decoding.mdstill linked to deleted example trees:examples/draft_target_model/README.md,examples/ngram/run_dtm_ngram.py,examples/medusa/README.md,examples/redrafter/README.md,examples/eagle/README.md, andexamples/lookahead/README.md(all 404 on main).docs/source/features/speculative-decoding.md(and keep the liveexamples/ngram/README.mdpointer).speculative_config.decoding_typeisAUTO, DFlash, DSpark, Draft_Target, Eagle3, Eagle, MTP, NGram, PARD, SA, SaveState, User_Provided(no Medusa/Lookahead).Test plan
07a58bdexamples/ngram/README.mdstill existsSigned-off-by: ADou ikun3.1415927@gmail.com
Dev Engineer Review
examples/ngram/README.mdlink.disagg-serving.md.draft_vocab_sizedefault and warning.Per-File QA Perspective
docs/source/legacy/advanced/speculative-decoding.md: Verify that redirected links resolve, removed examples are clearly identified, the NGram README remains valid, and the EAGLE3 guidance is accurate. No executable behavior changes require regression testing.QA Engineer Review
No test changes.