[None][feat] Add environment variable to force spec-dec number of accepted tokens
Summary by CodeRabbit
- New Features
- Introduced environment-driven configuration for speculative decoding token acceptance, allowing operators to override and control the number of accepted tokens for optimization and testing purposes.
โ๏ธ Tip: You can customize this high-level summary in your review settings.
Description
Add environment variable to force EAGLE3 number of accepted tokens
Test Coverage
Just local testing
PR Checklist
Please review the following before submitting your PR:
-
PR description clearly explains what and why. If using CodeRabbit's summary, please make sure it makes sense.
-
PR Follows TRT-LLM CODING GUIDELINES to the best of your knowledge.
-
Test cases are provided for new code paths (see test instructions)
-
Any new dependencies have been scanned for license and vulnerabilities
-
CODEOWNERS updated if ownership changes
-
Documentation updated as needed
-
Update tava architecture diagram if there is a significant design change in PR.
-
The reviewers assigned automatically/manually are appropriate for the PR.
-
[x] Please check this after reviewing the above items as appropriate for this PR.
GitHub Bot Help
/bot [-h] ['run', 'kill', 'skip', 'reuse-pipeline'] ...
Provide a user friendly way for developers to interact with a Jenkins server.
Run /bot [-h|--help] to print this help message.
See details below for each supported subcommand.
run [--reuse-test (optional)pipeline-id --disable-fail-fast --skip-test --stage-list "A10-PyTorch-1, xxx" --gpu-type "A30, H100_PCIe" --test-backend "pytorch, cpp" --add-multi-gpu-test --only-multi-gpu-test --disable-multi-gpu-test --post-merge --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx" --detailed-log --debug(experimental)]
Launch build/test pipelines. All previously running jobs will be killed.
--reuse-test (optional)pipeline-id (OPTIONAL) : Allow the new pipeline to reuse build artifacts and skip successful test stages from a specified pipeline or the last pipeline if no pipeline-id is indicated. If the Git commit ID has changed, this option will be always ignored. The DEFAULT behavior of the bot is to reuse build artifacts and successful test results from the last pipeline.
--disable-reuse-test (OPTIONAL) : Explicitly prevent the pipeline from reusing build artifacts and skipping successful test stages from a previous pipeline. Ensure that all builds and tests are run regardless of previous successes.
--disable-fail-fast (OPTIONAL) : Disable fail fast on build/tests/infra failures.
--skip-test (OPTIONAL) : Skip all test stages, but still run build stages, package stages and sanity check stages. Note: Does NOT update GitHub check status.
--stage-list "A10-PyTorch-1, xxx" (OPTIONAL) : Only run the specified test stages. Examples: "A10-PyTorch-1, xxx". Note: Does NOT update GitHub check status.
--gpu-type "A30, H100_PCIe" (OPTIONAL) : Only run the test stages on the specified GPU types. Examples: "A30, H100_PCIe". Note: Does NOT update GitHub check status.
--test-backend "pytorch, cpp" (OPTIONAL) : Skip test stages which don't match the specified backends. Only support [pytorch, cpp, tensorrt, triton]. Examples: "pytorch, cpp" (does not run test stages with tensorrt or triton backend). Note: Does NOT update GitHub pipeline status.
--only-multi-gpu-test (OPTIONAL) : Only run the multi-GPU tests. Note: Does NOT update GitHub check status.
--disable-multi-gpu-test (OPTIONAL) : Disable the multi-GPU tests. Note: Does NOT update GitHub check status.
--add-multi-gpu-test (OPTIONAL) : Force run the multi-GPU tests in addition to running L0 pre-merge pipeline.
--post-merge (OPTIONAL) : Run the L0 post-merge pipeline instead of the ordinary L0 pre-merge pipeline.
--extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx" (OPTIONAL) : Run the ordinary L0 pre-merge pipeline and specified test stages. Examples: --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx".
--detailed-log (OPTIONAL) : Enable flushing out all logs to the Jenkins console. This will significantly increase the log volume and may slow down the job.
--debug (OPTIONAL) : Experimental feature. Enable access to the CI container for debugging purpose. Note: Specify exactly one stage in the stage-list parameter to access the appropriate container environment. Note: Does NOT update GitHub check status.
For guidance on mapping tests to stage names, see docs/source/reference/ci-overview.md
and the scripts/test_to_stage_mapping.py helper.
kill
kill
Kill all running builds associated with pull request.
skip
skip --comment COMMENT
Skip testing for latest commit on pull request. --comment "Reason for skipping build/test" is required. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.
reuse-pipeline
reuse-pipeline
Reuse a previous pipeline to validate current commit. This action will also kill all currently running builds associated with the pull request. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.
๐ Walkthrough
Walkthrough
An environment variable override TLLM_EAGLE3_FORCE_NUM_ACCEPTED_TOKENS was added to Eagle3OneModelWorker. During initialization, the variable is read, parsed, and stored. When set to a non-zero value, the number of accepted tokens per context is forcefully fixed to that value during sampling.
Changes
| Cohort / File(s) | Summary |
|---|---|
Eagle3 speculative decoding configuration tensorrt_llm/_torch/speculative/eagle3.py |
Added environment-driven override support for forcing accepted token counts. Imported os and logger; added force_num_accepted_tokens attribute to Eagle3OneModelWorker; implemented override logic in sample_and_accept_draft_tokens method to forcefully set per-context accepted token counts when the TLLM_EAGLE3_FORCE_NUM_ACCEPTED_TOKENS environment variable is non-zero. Includes error handling with logging for invalid values; defaults to no override when not set. |
Estimated code review effort
๐ฏ 2 (Simple) | โฑ๏ธ ~15 minutes
- Verify environment variable parsing and error handling logic are correct
- Confirm the override is applied at the correct point in the sampling flow
- Check that default behavior (no override) is preserved when the variable is unset or invalid
Pre-merge checks and finishing touches
โ Failed checks (2 warnings)
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Docstring Coverage | โ ๏ธ Warning | Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%. | You can run @coderabbitai generate docstrings to improve docstring coverage. |
| Description check | โ ๏ธ Warning | The description is minimal and lacks important details about the changes, rationale, and incomplete test coverage documentation. | Expand the description to explain why this override is needed, what the TLLM_EAGLE3_FORCE_NUM_ACCEPTED_TOKENS variable does, and provide more detail on testing beyond 'local testing'. |
โ Passed checks (1 passed)
| Check name | Status | Explanation |
|---|---|---|
| Title check | โ Passed | The title clearly summarizes the main change: adding an environment variable to control EAGLE3's accepted token count. |
โจ Finishing touches
- [ ] ๐ Generate docstrings
๐งช Generate unit tests (beta)
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
[!TIP]
๐ Customizable high-level summaries are now available in beta!
You can now customize how CodeRabbit generates the high-level summary in your pull requests โ including its content, structure, tone, and formatting.
- Provide your own instructions using the
high_level_summary_instructionssetting.- Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
- Use
high_level_summary_in_walkthroughto move the summary from the description to the walkthrough section.Example instruction:
"Divide the high-level summary into five sections:
- ๐ Description โ Summarize the main change in 50โ60 words, explaining what was done.
- ๐ References โ List relevant issues, discussions, documentation, or related PRs.
- ๐ฆ Dependencies & Requirements โ Mention any new/updated dependencies, environment variable changes, or configuration updates.
- ๐ Contributor Summary โ Include a Markdown table showing contributions:
| Contributor | Lines Added | Lines Removed | Files Changed |- โ๏ธ Additional Notes โ Add any extra reviewer context. Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands and usage tips.
/bot run
PR_Github #25402 [ run ] triggered by Bot. Commit: d6a4b99
PR_Github #25402 [ run ] completed with state SUCCESS. Commit: d6a4b99
/LLM/main/L0_MergeRequest_PR pipeline #19219 completed with status: 'SUCCESS'
Pipeline passed with automatic retried tests. Check the rerun report for details.
/bot run
PR_Github #25656 [ run ] triggered by Bot. Commit: 9514ac8
PR_Github #25656 [ run ] completed with state FAILURE. Commit: 9514ac8
LLM/main/L0_MergeRequest_PR #19442 (Blue Ocean) completed with status: ABORTED
/bot run
PR_Github #25756 [ run ] triggered by Bot. Commit: 9514ac8
PR_Github #25756 [ run ] completed with state SUCCESS. Commit: 9514ac8
/LLM/main/L0_MergeRequest_PR pipeline #19531 completed with status: 'SUCCESS'
Pipeline passed with automatic retried tests. Check the rerun report for details.