-
Notifications
You must be signed in to change notification settings - Fork 2k
[None][chore] Refactored the handle logits pp communication #7154
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[None][chore] Refactored the handle logits pp communication #7154
Conversation
Signed-off-by: Daniel Campora <961215+dcampora@users.noreply.github.com>
📝 WalkthroughWalkthroughRefactors inline logits communication logic in PyExecutor into a new private helper method Changes
Sequence Diagram(s)sequenceDiagram
participant PrevPP as Prev PP Rank
participant CurrPP as Current PP Rank
participant NextPP as Next PP Rank
Note over CurrPP: _handle_logits_communication(previous_batch, prev_microbatch_id)
rect rgb(245,250,255)
CurrPP->>CurrPP: Identify finished_reqs needing logits from previous_batch
end
alt If current rank is First PP
PrevPP->>CurrPP: Receive py_results for finished_reqs (tagged)
CurrPP->>CurrPP: Assign py_results to requests
end
alt If current rank is Last PP
CurrPP->>CurrPP: Wait for any pending send handle
CurrPP->>NextPP: Send [r.py_result for r in finished_reqs] (tagged)
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. 📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
✨ Finishing Touches
🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
|
/bot run |
There was a problem hiding this 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 (5)
tensorrt_llm/_torch/pyexecutor/py_executor.py (5)
849-851: Optional: add an NVTX range around the helper for profiling symmetry.Stage 2 uses explicit ranges; adding one here helps correlate Stage 3 work in traces.
Apply this diff:
- # Handle logits communication between pipeline parallel ranks - self._handle_logits_communication(previous_batch, prev_microbatch_id) + # Handle logits communication between pipeline parallel ranks + with torch.cuda.nvtx.range("_handle_logits_communication"): + self._handle_logits_communication(previous_batch, prev_microbatch_id)
1701-1710: Add type hints and tighten the docstring (Google-style) to match repo guidelines.Clarifies the API and eliminates trailing whitespace in the docstring stanza.
Apply this diff:
- def _handle_logits_communication(self, previous_batch, prev_microbatch_id): - """Handle logits communication between pipeline parallel ranks. - - If logits were requested, the last PP rank sends to the first PP rank (who sends responses) - the logits of the requests that have finished. - - Args: - previous_batch: The previous batch state - prev_microbatch_id: The microbatch ID for the previous batch - """ + def _handle_logits_communication( + self, + previous_batch: BatchStatePP, + prev_microbatch_id: int, + ) -> None: + """Handle logits communication between pipeline-parallel ranks. + + If any request in ``previous_batch`` finished and requested logits, the last PP rank + sends its ``py_result`` to the first PP rank (which emits responses). + + Args: + previous_batch (BatchStatePP): The previous microbatch state. + prev_microbatch_id (int): Microbatch identifier corresponding to ``previous_batch``. + """
1703-1706: Fix ruff W291/W293 (trailing whitespace/blank line with spaces).There’s trailing whitespace and whitespace-only blank lines in the docstring stanza. The diff in my previous comment removes these.
1721-1727: Remove unused assignment before recv to avoid confusion.
finished_reqs_py_results = [r.py_result ...]is immediately overwritten byrecv_object(). Drop it to prevent misleading “assigned-but-overwritten” patterns.Apply this diff:
- if self.dist.is_first_pp_rank and len(finished_reqs): - finished_reqs_py_results = [ - r.py_result for r in finished_reqs - ] - finished_reqs_py_results = self.dist.recv_object( + if self.dist.is_first_pp_rank and len(finished_reqs): + finished_reqs_py_results = self.dist.recv_object( src=self.dist.prev_pp_rank, tag=prev_microbatch_id, )
1728-1741: Make the transfer order-agnostic (key by request_id) and assert size parity.Zipping relies on identical ordering of
finished_reqsacross the first/last PP ranks. If ordering diverges (e.g., due to local state timing, cancellations), results could mis-attach silently. Sending a mapping keyed bypy_request_idremoves the ordering dependency and allows sanity checks.Apply this diff:
- for req, py_result in zip(finished_reqs, - finished_reqs_py_results): - req.py_result = py_result + # Order-agnostic attach by request id with sanity check + assert isinstance(finished_reqs_py_results, dict), "Expected dict payload keyed by py_request_id" + if len(finished_reqs_py_results) != len(finished_reqs): + logger.warning( + "Logits payload size mismatch (recv=%d, local finished=%d) for microbatch %d", + len(finished_reqs_py_results), len(finished_reqs), prev_microbatch_id + ) + for req in finished_reqs: + try: + req.py_result = finished_reqs_py_results[req.py_request_id] + except KeyError: + logger.error( + "Missing logits for request_id=%d in microbatch %d", + req.py_request_id, prev_microbatch_id + ) + # Leave as-is; downstream may handle missing py_result. - elif self.dist.is_last_pp_rank and len(finished_reqs): + elif self.dist.is_last_pp_rank and len(finished_reqs): if self.send_handles[ prev_microbatch_id] is not None: self.send_handles[prev_microbatch_id].wait() self.send_handles[ prev_microbatch_id] = self.dist.isend_object( - [r.py_result for r in finished_reqs], + {r.py_request_id: r.py_result for r in finished_reqs}, dest=self.dist.next_pp_rank, tag=prev_microbatch_id)Follow-up: please verify (in a multi-GPU PP job) that the first/last rank see the same set of finished-and-logits-requesting req_ids per microbatch. If you’d prefer to keep list semantics, at least add an
assert len(finished_reqs_py_results) == len(finished_reqs)after the recv to catch divergence early.
📜 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.
📒 Files selected for processing (1)
tensorrt_llm/_torch/pyexecutor/py_executor.py(2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.py
📄 CodeRabbit inference engine (CODING_GUIDELINES.md)
**/*.py: Python code must target Python 3.8+
Python indentation: 4 spaces, no tabs
Maintain module namespace in imports (from package.subpackage import foo; then use foo.SomeClass())
Python file names use snake_case
Python class names use PascalCase
Python functions/methods and local variables use snake_case; variables starting with a number get k_ prefix (e.g., k_99th_percentile)
Global variables use G_ prefixed UPPER_SNAKE_CASE (e.g., G_MY_GLOBAL)
Constants use UPPER_SNAKE_CASE in Python
Avoid shadowing variables from outer scopes in Python
Initialize all externally visible members of a Python class in init
Prefer docstrings for interfaces used outside a file; comments for local code
Use Google-style docstrings for classes and functions (Sphinx-parsable)
Document attributes/variables inline with short docstrings
Avoid reflection when simple alternatives exist (e.g., prefer explicit parameters over dict(**locals()))
In try/except, catch the narrowest exceptions possible
For duck-typing with try/except, keep try body minimal and put logic in else
Files:
tensorrt_llm/_torch/pyexecutor/py_executor.py
**/*.{cpp,cxx,cc,cu,h,hpp,hxx,hh,cuh,py}
📄 CodeRabbit inference engine (CODING_GUIDELINES.md)
Prepend NVIDIA copyright header (current year) to all source files
Files:
tensorrt_llm/_torch/pyexecutor/py_executor.py
🪛 Ruff (0.12.2)
tensorrt_llm/_torch/pyexecutor/py_executor.py
1703-1703: Blank line contains whitespace
Remove whitespace from blank line
(W293)
1704-1704: Trailing whitespace
Remove trailing whitespace
(W291)
1706-1706: Blank line contains whitespace
Remove whitespace from blank line
(W293)
🔇 Additional comments (1)
tensorrt_llm/_torch/pyexecutor/py_executor.py (1)
849-851: Nice extraction — call site reads much cleaner now.Moving the logits PP comms into a dedicated helper improves readability and localizes the concern. No behavioral red flags at the call site.
|
PR_Github #16155 [ run ] triggered by Bot |
|
PR_Github #16155 [ run ] completed with state |
Signed-off-by: Daniel Campora <961215+dcampora@users.noreply.github.com>
|
/bot run |
|
PR_Github #16162 [ run ] triggered by Bot |
|
PR_Github #16162 [ run ] completed with state |
|
/bot run |
|
PR_Github #16190 [ run ] triggered by Bot |
|
PR_Github #16190 [ run ] completed with state |
|
/bot run |
|
PR_Github #16401 [ run ] triggered by Bot |
|
PR_Github #16401 [ run ] completed with state |
Summary by CodeRabbit
Description
Test Coverage
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.
Details
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 thestage-listparameter 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.mdand the
scripts/test_to_stage_mapping.pyhelper.kill
killKill all running builds associated with pull request.
skip
skip --comment COMMENTSkip 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-pipelineReuse 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.