Skip to content

Conversation

faradawn
Copy link

@faradawn faradawn commented Oct 7, 2025

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive Quick Start deployment guide for running Qwen3-Next on TensorRT LLM.
    • Covers prerequisites, model selection, Docker build/run steps, server configuration (YAML and CLI), and API testing.
    • Explains key configuration parameters and optional advanced settings.
    • Provides troubleshooting for memory, compatibility, performance, and container startup issues.
    • Includes a benchmarking section with an example script and commands to collect results.

Description

Add Qwen3-Next Usage Guide. This guide is functional.

Rebasing from the previous PR: #8007

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.

@faradawn faradawn requested a review from a team as a code owner October 7, 2025 21:01
@svc-trtllm-gh-bot svc-trtllm-gh-bot added the Community want to contribute PRs initiated from Community label Oct 7, 2025
Copy link
Contributor

coderabbitai bot commented Oct 7, 2025

📝 Walkthrough

Walkthrough

Adds a new deployment guide documenting how to run Qwen3-Next on TensorRT LLM, including prerequisites, Docker build/run, server YAML configuration, trtllm-serve launch options, testing endpoint, troubleshooting, and benchmarking with a provided script scaffold.

Changes

Cohort / File(s) Summary
Docs — Deployment Guide for Qwen3-Next on TensorRT LLM
docs/source/deployment-guide/quick-start-recipe-for-qwen3-next-on-trtllm.md
New end-to-end Quick Start guide: prerequisites, model selection, Docker build/run, TRT-LLM server YAML config, launch CLI options (host/port/backend/batch/tokens/parallelism/trust_remote_code/extra options), testing steps, parameter explanations, troubleshooting, and benchmarking script scaffold.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant U as User
  participant D as Docker/Container
  participant S as TRT-LLM Server
  participant M as Model Repo

  U->>D: Build Docker image (TensorRT LLM)
  U->>D: Run container with GPUs and volumes
  U->>D: Provide YAML config (tp_size, ep_size, etc.)
  D->>M: Download/prepare Qwen3-Next model (trust_remote_code?)
  U->>S: Launch trtllm-serve with CLI options
  Note right of S: max_batch_size, max_num_tokens, kv cache, cuda graph, MoE
  U->>S: Send inference request (test endpoint)
  S-->>U: Return response

  alt Benchmarking
    U->>S: Run bench.sh with concurrent requests
    S-->>U: Emit latency/throughput metrics
  end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The pull request description fails to follow the repository’s required template because it does not include a properly formatted title line and the Test Coverage section is empty. The Description section is present but is very brief and lacks context about why the guide is needed. Overall, required template fields are missing or incomplete. Please add the PR title at the top following the “[JIRA/None][type] Summary” format, provide meaningful entries under Test Coverage, and expand the Description to briefly explain the motivation and impact of the new guide.
Title Check ❓ Inconclusive The PR title “[None][doc] Add Qwen3-Next Guide (new)” follows the required bracketed format but remains too broad, omitting the fact that it adds a detailed Quick Start recipe for Qwen3-Next on TensorRT-LLM. The parenthetical “(new)” is redundant and does not add meaningful context. As a result, a reader cannot discern the scope or purpose of the guide from the title alone. Please remove extraneous qualifiers like “(new)” and revise the title to specifically describe the guide, for example “[None][doc] Add Qwen3-Next Quick Start Guide for TensorRT-LLM”.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 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.

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

🧹 Nitpick comments (2)
docs/source/deployment-guide/quick-start-recipe-for-qwen3-next-on-trtllm.md (2)

24-30: Add a language hint to the shell snippet.

Please annotate this fenced block with a language (bash or shell) so markdownlint passes and readers get syntax highlighting.

Apply this diff:

-```
+```bash
 cd TensorRT-LLM
-
 make -C docker release_build IMAGE_TAG=qwen3-next-local
-
 make -C docker release_run IMAGE_NAME=tensorrt_llm IMAGE_TAG=qwen3-next-local LOCAL_USER=1

---

`176-178`: **Annotate the sample response block as JSON.**

Marking this fence as `json` keeps markdownlint happy and improves readability with highlighting.



Apply this diff:

```diff
-```
+```json
 {"id":"chatcmpl-64ac201c77bf46a7a3a4eca7759b1fd8","object":"chat.completion","created":1759022940,"model":"Qwen/Qwen3-Next-80B-A3B-Thinking","choices":[{"index":0,"message":{"role":"assistant","content":"Okay, the user is asking \"Where is New York?\" Hmm, this seems straightforward but I need to be careful. New York could mean different things—maybe they're confused about the city versus the state. 
📜 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 7facac0 and 6bf8c92.

📒 Files selected for processing (1)
  • docs/source/deployment-guide/quick-start-recipe-for-qwen3-next-on-trtllm.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/source/deployment-guide/quick-start-recipe-for-qwen3-next-on-trtllm.md

24-24: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


176-176: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


### Creating the TRT-LLM Server config

We create a YAML configuration file `/tmp/config.yml` for the TensorRT LLM Server. Note that we should set kv_cache_reuse to false.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Clarify the KV-cache reuse setting name.

The note references a kv_cache_reuse flag that does not exist in the sample YAML; the actual key is kv_cache_config.enable_block_reuse. This mismatch will confuse readers trying to align the prose with the config snippet. Please update the note so it cites the real field name.

Apply this diff:

-We create a YAML configuration file `/tmp/config.yml` for the TensorRT LLM Server. Note that we should set kv_cache_reuse to false. 
+We create a YAML configuration file `/tmp/config.yml` for the TensorRT LLM Server. Note that we should set `kv_cache_config.enable_block_reuse` to `false`. 
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
We create a YAML configuration file `/tmp/config.yml` for the TensorRT LLM Server. Note that we should set kv_cache_reuse to false.
We create a YAML configuration file `/tmp/config.yml` for the TensorRT LLM Server. Note that we should set `kv_cache_config.enable_block_reuse` to `false`.
🤖 Prompt for AI Agents
In docs/source/deployment-guide/quick-start-recipe-for-qwen3-next-on-trtllm.md
around line 34, the explanatory note incorrectly references a non-existent
kv_cache_reuse flag; update the prose to reference the actual YAML field
kv_cache_config.enable_block_reuse and indicate it should be set to false in the
config snippet so the text matches the sample configuration.

Signed-off-by: Faradawn Yang <[email protected]>
@faradawn faradawn force-pushed the qwen3-next-guide-new branch from 6bf8c92 to ec8086a Compare October 7, 2025 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Community want to contribute PRs initiated from Community
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants