Skip to content

Conversation

IzzyPutterman
Copy link
Collaborator

@IzzyPutterman IzzyPutterman commented Sep 4, 2025

Summary by CodeRabbit

  • New Features

    • Introduces optional per-layer capture of hidden states during speculative decoding, enabling more granular analysis and observability when needed.
    • Capturing is gated and disabled by default, ensuring no change to default behavior or output quality during normal generation.
  • Refactor

    • Integrates capture logic cleanly into the decoding flow while preserving existing behavior and performance characteristics when capture is not enabled.

Description

Test Coverage

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

  • The reviewers assigned automatically/manually are appropriate for the PR.

  • 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.

@IzzyPutterman IzzyPutterman requested a review from a team as a code owner September 4, 2025 23:07
Copy link
Contributor

coderabbitai bot commented Sep 4, 2025

📝 Walkthrough

Walkthrough

Introduces per-layer hidden-state capture in SpecDecOneEngineForCausalLM by adding a layer_idx attribute (default -1) and a conditional call in forward to maybe_capture_hidden_states when spec_metadata.is_layer_capture(layer_idx) is true. No API signatures or other logic paths were changed.

Changes

Cohort / File(s) Summary of Changes
Speculative decoding per-layer capture
tensorrt_llm/_torch/models/modeling_speculative.py
Added layer_idx instance attribute (default -1). In forward, after computing hidden_states, conditionally calls spec_metadata.maybe_capture_hidden_states(layer_idx, hidden_states) when spec_metadata is set and is_layer_capture(layer_idx) returns true. No other control flow altered.

Sequence Diagram(s)

sequenceDiagram
    actor Caller
    participant Model as SpecDecOneEngineForCausalLM
    participant Base as Base Model
    participant SpecMeta as spec_metadata

    Caller->>Model: forward(input_ids, ..., spec_metadata)
    Model->>Base: compute hidden_states
    Base-->>Model: hidden_states

    alt spec_metadata present and is_layer_capture(layer_idx)
        Model->>SpecMeta: maybe_capture_hidden_states(layer_idx, hidden_states)
        Note right of Model: New conditional per-layer capture
    else
        Note right of Model: No capture
    end

    Model-->>Caller: continue normal processing and return outputs
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • yizhang-nv
  • mikeiovine
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

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

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
tensorrt_llm/_torch/models/modeling_speculative.py (1)

413-413: Clarify -1 sentinel semantics for engine-level layer capture

Add a brief comment/doc to state that -1 denotes “final post-norm hidden states” and confirm SpecMetadata.layers_to_capture supports -1 across implementations.

Apply this small inline doc:

-        self.layer_idx = -1
+        # Sentinel: capture at the engine output (final post-norm hidden states).
+        # Must be recognized by SpecMetadata.is_layer_capture (supports -1).
+        self.layer_idx = -1
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between bddf183 and f5ca6a3.

📒 Files selected for processing (1)
  • tensorrt_llm/_torch/models/modeling_speculative.py (2 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
**/*.{h,hpp,hh,hxx,cpp,cxx,cc,cu,cuh,py}

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

Use only spaces, no tabs; indent with 4 spaces.

Files:

  • tensorrt_llm/_torch/models/modeling_speculative.py
**/*.py

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

**/*.py: Python code must target Python 3.8+.
Indent Python code with 4 spaces; do not use tabs.
Maintain module namespace when importing; prefer 'from package.subpackage import foo' then 'foo.SomeClass()' instead of importing the class directly.
Python filenames should be snake_case (e.g., some_file.py).
Python classes use PascalCase names.
Functions and methods use snake_case names.
Local variables use snake_case; prefix 'k' for variables that start with a number (e.g., k_99th_percentile).
Global variables use upper SNAKE_CASE prefixed with 'G' (e.g., G_MY_GLOBAL).
Constants use upper SNAKE_CASE (e.g., MY_CONSTANT).
Avoid shadowing variables from an outer scope.
Initialize all externally visible members of a class in the constructor.
Prefer docstrings for interfaces that may be used outside a file; comments for in-function or file-local interfaces.
Use Google-style docstrings for classes and functions (Sphinx-parsable).
Document attributes and variables inline so they render under the class/function docstring.
Avoid reflection when a simpler, explicit approach suffices (e.g., avoid dict(**locals()) patterns).
In try/except, catch the most specific exceptions possible.
For duck-typing try/except, keep the try body minimal and use else for the main logic.

Files:

  • tensorrt_llm/_torch/models/modeling_speculative.py
**/*.{cpp,cxx,cc,h,hpp,hh,hxx,cu,cuh,py}

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

Prepend the NVIDIA Apache-2.0 copyright header with current year to the top of all source files (e.g., .cpp, .h, .cu, .py).

Files:

  • tensorrt_llm/_torch/models/modeling_speculative.py
🧬 Code graph analysis (1)
tensorrt_llm/_torch/models/modeling_speculative.py (3)
tensorrt_llm/_torch/pyexecutor/cuda_graph_runner.py (1)
  • spec_metadata (60-61)
tensorrt_llm/_torch/speculative/eagle3.py (4)
  • is_layer_capture (166-167)
  • is_layer_capture (239-240)
  • maybe_capture_hidden_states (169-183)
  • maybe_capture_hidden_states (254-266)
tensorrt_llm/_torch/speculative/interface.py (2)
  • is_layer_capture (194-199)
  • maybe_capture_hidden_states (201-207)
🔇 Additional comments (1)
tensorrt_llm/_torch/models/modeling_speculative.py (1)

434-437: Slice hidden_states before capture to avoid padded-shape mismatches
Trim hidden_states to attn_metadata.num_tokens when attn_metadata.padded_num_tokens is set, preventing padded rows from being captured:

-if spec_metadata is not None and spec_metadata.is_layer_capture(self.layer_idx):
-    spec_metadata.maybe_capture_hidden_states(self.layer_idx, hidden_states)
+if spec_metadata is not None and spec_metadata.is_layer_capture(self.layer_idx):
+    to_capture = (hidden_states[:attn_metadata.num_tokens]
+                  if attn_metadata.padded_num_tokens is not None
+                  else hidden_states)
+    spec_metadata.maybe_capture_hidden_states(self.layer_idx, to_capture)

Optional: since maybe_capture_hidden_states currently requires a non-optional residual: torch.Tensor, consider updating its signature to accept Optional[torch.Tensor] with a default or explicitly pass None here after changing the interface.

@IzzyPutterman IzzyPutterman changed the title Eagle, use last hidden post norm [None][feat] Eagle, use last hidden post norm Sep 4, 2025
@IzzyPutterman IzzyPutterman requested a review from a team as a code owner September 9, 2025 23:00
Copy link
Collaborator

@yechank-nvidia yechank-nvidia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left minor comments.

Signed-off-by: Izzy Putterman <[email protected]>
Signed-off-by: Izzy Putterman <[email protected]>
@IzzyPutterman IzzyPutterman force-pushed the iputterman/eagle-post-norm branch from 96c8c6d to 03697e9 Compare September 15, 2025 03:09
@IzzyPutterman
Copy link
Collaborator Author

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18553 [ run ] triggered by Bot

Copy link
Collaborator

@yechank-nvidia yechank-nvidia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18553 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #13927 completed with status: 'FAILURE'

@IzzyPutterman
Copy link
Collaborator Author

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18579 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18579 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #13947 completed with status: 'SUCCESS'

@mikeiovine mikeiovine merged commit 8097be7 into NVIDIA:main Sep 15, 2025
6 of 7 checks passed
Wong4j pushed a commit to Wong4j/TensorRT-LLM that referenced this pull request Sep 20, 2025
MrGeva pushed a commit to nv-auto-deploy/TensorRT-LLM that referenced this pull request Sep 21, 2025
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.

5 participants