KEMBAR78
[None][doc] Ray orchestrator initial doc by hchings · Pull Request #8373 · NVIDIA/TensorRT-LLM · GitHub
Skip to content

Conversation

@hchings
Copy link
Collaborator

@hchings hchings commented Oct 14, 2025

Summary by CodeRabbit

  • Documentation
    • Added a new page detailing the Ray Orchestrator prototype for distributed inference, including motivation, setup, basic usage, supported features (async generation, multi-node, disaggregated serving), current model support, roadmap, and architecture overview with an illustrative diagram.
    • Integrated the new page into the Features navigation for easier discovery.
    • Refined example README wording and formatting, clarified the TP=2 example instructions, and reordered upcoming RLHF framework mentions for clarity.

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.

@hchings hchings self-assigned this Oct 14, 2025
@hchings hchings requested a review from a team as a code owner October 14, 2025 22:29
@hchings hchings requested review from chzblych and kaiyux October 14, 2025 22:29
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 14, 2025

📝 Walkthrough

Walkthrough

Adds a new Ray Orchestrator documentation page, includes it in the docs index, and makes minor wording/formatting updates to the Ray orchestrator example README. No code or API changes.

Changes

Cohort / File(s) Summary of Changes
Docs: New Ray Orchestrator page
docs/source/features/ray-orchestrator.md
Added a new doc describing the Ray Orchestrator prototype, usage, features, roadmap, and architecture references.
Docs: Index update
docs/source/index.rst
Added the new Ray Orchestrator page to the Features toctree.
Examples: README wording
examples/ray_orchestrator/README.md
Minor text edits: phrasing tweak, bold-to-italic style change, and re-ordered RLHF framework items.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The PR description remains as the default template without any filled sections, so it lacks a summary of the changes, an explanation of the solution, test coverage details, and any context for reviewers to understand the purpose and scope of this documentation update. Please replace the template placeholders with a concise summary of the new Ray orchestrator documentation, an explanation of why these docs are needed, and details on any tests or examples added to ensure reviewers can assess the completeness and impact of the changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title “[None][doc] Ray orchestrator initial doc” accurately follows the repository’s ticket and type conventions and concisely summarizes the primary change of adding initial documentation for the Ray orchestrator, making it immediately clear to reviewers what this PR introduces.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • 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

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

@hchings
Copy link
Collaborator Author

hchings commented Oct 14, 2025

/bot skip --comment "doc"

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: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 22471ec and b8ada15.

📒 Files selected for processing (3)
  • docs/source/features/ray-orchestrator.md (1 hunks)
  • docs/source/index.rst (1 hunks)
  • examples/ray_orchestrator/README.md (2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/source/features/ray-orchestrator.md

[grammar] ~11-~11: There might be a mistake here.
Context: ...efault in TensorRT-LLM. ## Basic Usage To use Ray orchestrator, you need to fir...

(QB_NEW_EN)


[grammar] ~27-~27: There might be a mistake here.
Context: ...rly by toggling this flag. ## Features Currently available: - Generate text asy...

(QB_NEW_EN)


[grammar] ~28-~28: There might be a mistake here.
Context: ...flag. ## Features Currently available: - Generate text asynchronously (refer to [...

(QB_NEW_EN)


[grammar] ~35-~35: There might be a mistake here.
Context: ... we can prioritize support.* ## Roadmap - Performance optimization - Integration w...

(QB_NEW_EN)


[grammar] ~36-~36: There might be a mistake here.
Context: ...* ## Roadmap - Performance optimization - Integration with RLHF frameworks, such a...

(QB_NEW_EN)

examples/ray_orchestrator/README.md

[grammar] ~39-~39: There might be a mistake here.
Context: ... ### Upcoming - Performance optimization - Integration with RLHF frameworks, such a...

(QB_NEW_EN)

⏰ 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)
  • GitHub Check: Pre-commit Check

@tensorrt-cicd
Copy link
Collaborator

PR_Github #21390 [ skip ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #21390 [ skip ] completed with state SUCCESS
Skipping testing for commit b8ada15

Signed-off-by: Erin Ho <14718778+hchings@users.noreply.github.com>
@hchings hchings enabled auto-merge (squash) October 15, 2025 01:33
@hchings
Copy link
Collaborator Author

hchings commented Oct 15, 2025

/bot skip --comment "doc"

@tensorrt-cicd
Copy link
Collaborator

PR_Github #21399 [ skip ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #21399 [ skip ] completed with state SUCCESS
Skipping testing for commit 64f5065

Signed-off-by: Erin <14718778+hchings@users.noreply.github.com>
@hchings
Copy link
Collaborator Author

hchings commented Oct 15, 2025

/bot skip --comment "doc"

@tensorrt-cicd
Copy link
Collaborator

PR_Github #21428 [ skip ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #21428 [ skip ] completed with state SUCCESS
Skipping testing for commit 13a75b9

@hchings hchings merged commit f4e7738 into NVIDIA:main Oct 15, 2025
4 of 5 checks passed
@hchings hchings deleted the ray_doc branch October 15, 2025 04:26
govind-ramnarayan pushed a commit to nv-auto-deploy/TensorRT-LLM that referenced this pull request Oct 21, 2025
Signed-off-by: Erin Ho <14718778+hchings@users.noreply.github.com>
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.

3 participants