Skip to content

Conversation

@LinPoly
Copy link
Collaborator

@LinPoly LinPoly commented Dec 23, 2025

Summary by CodeRabbit

  • Chores

    • Enhanced tokenizer path configuration to support environment variable overrides in example scripts, allowing flexible model path customization while maintaining default fallback behavior.
  • Tests

    • Updated test utilities to explicitly set tokenizer path configuration via environment variables before test execution.

✏️ Tip: You can customize this high-level summary in your review settings.

Description

This also fixes https://nvbugs/5546197

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

  • Update tava architecture diagram if there is a significant design change in PR.

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

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

Signed-off-by: Pengyun Lin <[email protected]>
@LinPoly LinPoly requested a review from JunyiXu-nv December 23, 2025 09:17
@LinPoly LinPoly self-assigned this Dec 23, 2025
@LinPoly LinPoly requested a review from a team as a code owner December 23, 2025 09:17
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 23, 2025

📝 Walkthrough

Walkthrough

The changes enable parameterization of the tokenizer path through environment variables. A shell script now accepts an optional TOKENIZER_PATH override with a fallback default, while test infrastructure explicitly sets this environment variable before launching servers. An unnecessary sys.path manipulation in tests is removed in favor of direct imports.

Changes

Cohort / File(s) Summary
Tokenizer path parameterization
examples/serve/aiperf_client.sh
Replaces hardcoded tokenizer path with parameter expansion ${TOKENIZER_PATH:-TinyLlama/TinyLlama-1.1B-Chat-v1.0}, allowing environment-variable override while maintaining backward compatibility.
Test infrastructure updates
tests/unittest/llmapi/apps/_test_trtllm_serve_example.py
Removes sys.path manipulation; imports get_model_path directly; sets TOKENIZER_PATH environment variable in server fixture using the resolved model path to ensure consistent tokenizer resolution.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
Description check ⚠️ Warning The PR description lacks critical required information. It is missing a properly formatted PR title following the template, a clear explanation of what and why, and test coverage details. Add a PR title in format [ticket/issue][type] Summary, provide a detailed description explaining the changes and rationale, and clearly list test coverage with relevant test cases.
✅ Passed checks (1 passed)
Check name Status Explanation
Title check ✅ Passed The title '[https://nvbugs/5747938][fix] Use local tokenizer' clearly summarizes the main change: making tokenizers local to improve the serve example.
✨ 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: 0

🧹 Nitpick comments (1)
tests/unittest/llmapi/apps/_test_trtllm_serve_example.py (1)

35-36: Setting environment variable in fixture may affect other tests.

The TOKENIZER_PATH environment variable is set in a module-scoped fixture but is never cleaned up. While the module scope limits the impact, this variable will persist for the lifetime of the test module and could potentially affect other tests if they read this environment variable.

Consider adding cleanup in the fixture's teardown phase if isolation is important.

🔎 Optional refactor to add cleanup
 @pytest.fixture(scope="module")
 def server(model_name: str, temp_extra_llm_api_options_file: str):
     model_path = get_model_path(model_name)
+    original_tokenizer_path = os.environ.get("TOKENIZER_PATH")
     os.environ["TOKENIZER_PATH"] = model_path
     # fix port to facilitate concise trtllm-serve examples
     args = ["--extra_llm_api_options", temp_extra_llm_api_options_file]
-    with RemoteOpenAIServer(model_path, args, port=8000) as remote_server:
-        yield remote_server
+    try:
+        with RemoteOpenAIServer(model_path, args, port=8000) as remote_server:
+            yield remote_server
+    finally:
+        if original_tokenizer_path is None:
+            os.environ.pop("TOKENIZER_PATH", None)
+        else:
+            os.environ["TOKENIZER_PATH"] = original_tokenizer_path
📜 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 522f1d2 and dd043ce.

📒 Files selected for processing (2)
  • examples/serve/aiperf_client.sh
  • tests/unittest/llmapi/apps/_test_trtllm_serve_example.py
🧰 Additional context used
📓 Path-based instructions (2)
**/*.py

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

**/*.py: Code developed for TensorRT-LLM should conform to Python 3.8+
Indent Python code with 4 spaces. Do not use tabs
Always maintain the namespace when importing in Python, even if only one class or function from a module is used
Python files should use snake_case naming: some_file.py
Python classes should use PascalCase naming: class SomeClass
Python functions and methods should use snake_case naming: def my_awesome_function():
Python local variables should use snake_case naming: my_variable = ...
Python variable names that start with a number should be prefixed with 'k': k_99th_percentile = ...
Python global variables should use upper snake_case with prefix 'G': G_MY_GLOBAL = ...
Python constants should use upper snake_case naming: MY_CONSTANT = ...
Avoid shadowing variables declared in an outer scope in Python
Initialize all externally visible members of a Python class in the constructor
For Python interfaces that may be used outside a file, prefer docstrings over comments
Python comments should be reserved for code within a function, or interfaces that are local to a file
Use Google style docstrings in Python for classes and functions, which can be parsed by Sphinx
Python attributes and variables can be documented inline with type and description
Avoid using reflection in Python when functionality can be easily achieved without reflection
When using try-except blocks in Python, limit the except to the smallest set of errors possible
When using try-except blocks in Python to handle multiple possible variable types (duck-typing), keep the body of the try as small as possible, using the else block for logic

Files:

  • tests/unittest/llmapi/apps/_test_trtllm_serve_example.py
**/*.{cpp,h,cu,cuh,py}

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

All TensorRT-LLM Open Source Software code should contain an NVIDIA copyright header that includes the year of its latest meaningful modification

Files:

  • tests/unittest/llmapi/apps/_test_trtllm_serve_example.py
🧠 Learnings (3)
📓 Common learnings
Learnt from: thorjohnsen
Repo: NVIDIA/TensorRT-LLM PR: 6910
File: cpp/tensorrt_llm/batch_manager/kvCacheManager.cpp:0-0
Timestamp: 2025-08-14T21:04:50.248Z
Learning: In KV cache onboarding logic during prefill in cpp/tensorrt_llm/batch_manager/kvCacheManager.cpp, when calculating which blocks fall within the attention window, use getTokensPerBlock() to advance token indices rather than block->getUniqueTokens().size(), because the calculation needs to consider the post-prefill state where blocks will be filled to capacity, not their current token count.
Learnt from: samuellees
Repo: NVIDIA/TensorRT-LLM PR: 6974
File: tensorrt_llm/serve/scripts/benchmark_dataset.py:558-566
Timestamp: 2025-08-18T08:42:02.640Z
Learning: In TensorRT-LLM's RandomDataset (tensorrt_llm/serve/scripts/benchmark_dataset.py), when using --random-token-ids option, sequence length accuracy is prioritized over semantic correctness for benchmarking purposes. The encode/decode operations should use skip_special_tokens=True and add_special_tokens=False to ensure exact target token lengths.
📚 Learning: 2025-07-28T17:06:08.621Z
Learnt from: moraxu
Repo: NVIDIA/TensorRT-LLM PR: 6303
File: tests/integration/test_lists/qa/examples_test_list.txt:494-494
Timestamp: 2025-07-28T17:06:08.621Z
Learning: In TensorRT-LLM testing, it's common to have both CLI flow tests (test_cli_flow.py) and PyTorch API tests (test_llm_api_pytorch.py) for the same model. These serve different purposes: CLI flow tests validate the traditional command-line workflow, while PyTorch API tests validate the newer LLM API backend. Both are legitimate and should coexist.

Applied to files:

  • tests/unittest/llmapi/apps/_test_trtllm_serve_example.py
📚 Learning: 2025-08-06T13:58:07.506Z
Learnt from: galagam
Repo: NVIDIA/TensorRT-LLM PR: 6487
File: tests/unittest/_torch/auto_deploy/unit/singlegpu/test_ad_trtllm_bench.py:1-12
Timestamp: 2025-08-06T13:58:07.506Z
Learning: In TensorRT-LLM, test files (files under tests/ directories) do not require NVIDIA copyright headers, unlike production source code files. Test files typically start directly with imports, docstrings, or code.

Applied to files:

  • tests/unittest/llmapi/apps/_test_trtllm_serve_example.py
🧬 Code graph analysis (1)
tests/unittest/llmapi/apps/_test_trtllm_serve_example.py (1)
tests/integration/defs/stress_test/stress_test.py (1)
  • get_model_path (310-312)
⏰ 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
🔇 Additional comments (2)
examples/serve/aiperf_client.sh (1)

5-5: LGTM! Environment variable parameterization is well-implemented.

The bash parameter expansion with fallback default is correct and maintains backward compatibility.

tests/unittest/llmapi/apps/_test_trtllm_serve_example.py (1)

9-9: The import path is correct. The test_llm module exists at tests/unittest/llmapi/test_llm.py, and the relative import from ..test_llm import get_model_path from tests/unittest/llmapi/apps/_test_trtllm_serve_example.py properly resolves to this module, which contains the get_model_path function at line 70.

@LinPoly
Copy link
Collaborator Author

LinPoly commented Dec 23, 2025

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #29588 [ run ] triggered by Bot. Commit: dd043ce

Copy link
Collaborator

@JunyiXu-nv JunyiXu-nv left a comment

Choose a reason for hiding this comment

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

LGTM

@LinPoly
Copy link
Collaborator Author

LinPoly commented Dec 23, 2025

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #29588 [ run ] completed with state SUCCESS. Commit: dd043ce
/LLM/main/L0_MergeRequest_PR pipeline #22755 completed with status: 'FAILURE'

⚠️ Action Required:

  • Please check the failed tests and fix your PR
  • If you cannot view the failures, ask the CI triggerer to share details
  • Once fixed, request an NVIDIA team member to trigger CI again

@tensorrt-cicd
Copy link
Collaborator

PR_Github #29629 [ run ] triggered by Bot. Commit: dd043ce

@tensorrt-cicd
Copy link
Collaborator

PR_Github #29629 [ run ] completed with state DISABLED
CI server is currently disabled for scheduled maintenance. Estimated completion time: 12 PM PST on 12/23.

@LinPoly
Copy link
Collaborator Author

LinPoly commented Dec 24, 2025

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #29760 [ run ] triggered by Bot. Commit: dd043ce

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