[None][docs] add required --model_dir and --spec_decode_algo to ngram README - #18566
[None][docs] add required --model_dir and --spec_decode_algo to ngram README#18566imitater-dou wants to merge 1 commit into
Conversation
… README 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)
Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review. WalkthroughThe NGram README command now includes explicit ChangesNGram example documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to This documentation-only change makes the NGram example command runnable and ensures it selects the intended algorithm; no actionable merge-blocking risk remains. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Description checkExplanation The description clearly explains the issue, the affected command, the exact documentation change, and the test plan. It does not reproduce the template headings or checklist, but it provides the required context and is sufficiently complete for this documentation-only change. Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.) ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Summary
The NGram example README Usage command for
examples/llm-api/quickstart_advanced.pywas missing required--model_dirand did not set--spec_decode_algo NGRAM, so copy-pasting the snippet fails argparse and never enables NGram (algo defaults toNone).Repro
main, openexamples/ngram/README.mdUsage bash block: it only passes--spec_decode_max_draft_len,--max_matching_ngram_size, and two disable flags.examples/llm-api/quickstart_advanced.py,--model_dirisrequired=True.--spec_decode_algodefaults toNone; NGram is only configured whenspec_decode_algo == "NGRAM".--model_dir, and even with a model path would not select NGram.Change
Update the Usage command to include
--model_dir <MODEL_DIR>and--spec_decode_algo NGRAM.Test plan
NGRAMbranch inquickstart_advanced.pybuildsNGramDecodingConfigDev Engineer Review
examples/ngram/README.mdwith required--model_dir <MODEL_DIR>.--spec_decode_algo NGRAMexplicitly.QA Engineer Review
No test changes.