Skip to content

Drop orphan draft references from the external-draft learning-rate note - #2978

Merged
phicksy merged 1 commit into
mainfrom
ext-draft/lr-note-orphans
Oct 23, 2026
Merged

phicksy merged 1 commit into
mainfrom
ext-draft/lr-note-orphans

Conversation

@phicksy

@phicksy phicksy commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

What changed

The learning-rate note in doc/external_draft.md's Reference Configuration cited 1.0e-5 (4B) and 2.0e-6 (0.8B). Those were the only mention of either draft anywhere in the doc, so a reader meets two rates for two models the page never introduces and cannot tell which, if either, applies to them.

The Reference Configuration documents one pair: Llama-3.2-1B drafting for Qwen3.8-27B at 2.0e-5.

Why not just delete the note

It carries the only "sweep for your own pair" guidance in the doc. L181 says a swapped draft wants a higher rate than a matched one, but never says to sweep. So the note keeps the part that generalises and attaches it to the rate this section actually documents.

> **Note on the learning rate:** 2.0e-5 was selected by sweeping against held-out
> acceptance, and it is specific to this draft, target and dump. The ordering between
> candidate rates does not transfer, so sweep for your own pair rather than carrying this
> value over.

Testing

Documentation only, one file, no code. pre-commit passes including markdownlint-cli2. Verified no 4B, 0.8B, 1.0e-5 or 2.0e-6 reference remains in the doc.

Follow-up to #2688.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the learning-rate guidance to recommend evaluating settings against held-out acceptance using your own draft and target.

@phicksy
phicksy requested a review from a team as a code owner October 23, 2026 18:41
@coderabbitai

coderabbitai Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
📥 Commits

Reviewing files that changed from the base of the PR and between b3491e0 and c7ab779.

📒 Files selected for processing: 1
  • examples/speculative_decoding/doc/external_draft.md
🚧 Files skipped from review as they are similar to previous changes: 1
  • examples/speculative_decoding/doc/external_draft.md

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 10 remain after this review.

📝 Walkthrough

The external draft documentation replaces specific learning-rate examples and prior sweep caveats with a recommendation to sweep against held-out acceptance for the user’s draft and target.

Changes: Learning-rate guidance

Layer / File(s) Summary
Update reference learning-rate note
examples/speculative_decoding/doc/external_draft.md
The note removes specific learning-rate examples and sweep caveats. It recommends sweeping against held-out acceptance for the user’s draft and target.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Possibly related PRs

Merge Risk: ⚪ Minimal · up to c7ab7

The guidance remains consistent with the reference configuration and is ready to merge after normal checks.

Pre-merge checks: Passed 6
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title names the main change: removing orphan draft references (the 1.0e-5 (4B) and 2.0e-6 (0.8B) rates) from the external-draft learning-rate note. The raw summary and PR objectives both describe …
Docstring Coverage Passed 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…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Security Anti-Patterns Passed PASS. The pull request changes only examples/speculative_decoding/doc/external_draft.md. It adds no Python code, security-sensitive calls, # nosec comments, or dependency changes.
Full details: Title check

Explanation

The title names the main change: removing orphan draft references (the 1.0e-5 (4B) and 2.0e-6 (0.8B) rates) from the external-draft learning-rate note. The raw summary and PR objectives both describe this same edit to doc/external_draft.md. The title is specific and matches the changeset, so the check passes.

Full details: Docstring Coverage

Explanation

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)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

The note cited 1.0e-5 (4B) and 2.0e-6 (0.8B), the only mention of either
draft in the doc, so a reader met two rates for two models the page never
introduces.

The Configuration table above already states the rate this section used.
All the note needs to add is the recommendation to sweep.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: Peter Hicks <phicks@nvidia.com>
@phicksy
phicksy force-pushed the ext-draft/lr-note-orphans branch from b3491e0 to c7ab779 Compare October 23, 2026 18:44
@codecov

codecov Bot commented Oct 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.49%. Comparing base (414268f) to head (c7ab779).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2978   +/-   ##
=======================================
  Coverage   79.49%   79.49%           
=======================================
  Files         660      660           
  Lines       74752    74752           
=======================================
  Hits        59421    59421           
  Misses      15331    15331           
Flag Coverage Δ
unit 61.04% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@phicksy
phicksy merged commit 55003cc into main Oct 23, 2026
35 checks passed
@phicksy
phicksy deleted the ext-draft/lr-note-orphans branch October 23, 2026 18:59
@github-actions

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-10-23 18:59 UTC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants