KEMBAR78
[None][test] add test for min_tokens by ixlmar · Pull Request #7678 · NVIDIA/TensorRT-LLM · GitHub
Skip to content

Conversation

@ixlmar
Copy link
Collaborator

@ixlmar ixlmar commented Sep 10, 2025

Description

Adds test coverage for https://nvbugs/5513423.

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.

Summary by CodeRabbit

  • Tests
    • Added a new test to validate that minimum token constraints are honored during text generation.
    • Ensures generation outputs respect configured token limits and produce expected sequence lengths.
    • Marked as an expected failure due to a known issue, providing early visibility and preventing regressions once fixed.

Signed-off-by: ixlmar <206748156+ixlmar@users.noreply.github.com>
@ixlmar ixlmar requested review from DomBrown and dcampora September 10, 2025 15:47
@ixlmar
Copy link
Collaborator Author

ixlmar commented Sep 10, 2025

/bot run

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 10, 2025

📝 Walkthrough

Walkthrough

Adds a new xfail-marked unit test (test_min_tokens) to verify that min_tokens is enforced during generation with specific SamplingParams in the PyTorch LLM tests.

Changes

Cohort / File(s) Summary of Changes
Tests — LLM PyTorch
tests/unittest/llmapi/test_llm_pytorch.py
Added test_min_tokens marked with part0 and xfail; constructs LLM with mixed sampler and large max_seq_len; sets SamplingParams with max_tokens=min_tokens=5000; runs generation and asserts single output with 5000 token_ids.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks (2 passed, 1 warning)

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The current description includes a brief note and an unmodified PR checklist but omits the required “## Test Coverage” section and does not explain the solution approach or list the specific test that safeguards against the referenced bug. It also lacks a detailed Description section that outlines the issue context, how the new test addresses it, and any relevant parameters or behaviors being validated. As such, the description is incomplete relative to the repository’s template requirements. Please add a “## Test Coverage” section that names the test_min_tokens function and explains how it verifies the min_tokens behavior, expand the “## Description” section to summarize the bug’s context and the test approach, and ensure all template headings are present and populated with the required information.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title correctly follows the repository’s naming convention by using the “[None][test]” prefix and succinctly describes the primary change—adding a test for the min_tokens parameter. It is clear, concise, and directly related to the new test implementation in test_llm_pytorch.py, making it easy for reviewers to understand the purpose at a glance. Therefore, the title meets the criteria for a well-formed, informative PR title.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

✨ 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

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 (3)
tests/unittest/llmapi/test_llm_pytorch.py (3)

861-863: Make xfail strict so CI surfaces the fix when the bug is resolved

Ensure the test flips to XPASS-strict failure once https://nvbugs/5513423 is fixed.

-@pytest.mark.xfail(reason="https://nvbugs/5513423")
+@pytest.mark.xfail(reason="https://nvbugs/5513423", strict=True)

865-877: Use context manager to ensure LLM cleanup and mute tqdm noise in test logs

Avoid GPU resource leaks and unnecessary progress bars in CI.

     llm = LLM(model=llama_model_path,
               kv_cache_config=global_kvcache_config,
               enable_mixed_sampler=True,
               max_seq_len=20000)

     output_len = 5000
     sampling_params = SamplingParams(max_tokens=output_len,
                                      min_tokens=output_len,
                                      temperature=1)
-    res = llm.generate("The end.", sampling_params=sampling_params)
-
-    assert len(res.outputs) == 1
-    assert len(res.outputs[0].token_ids) == output_len
+    with llm:
+        res = llm.generate("The end.",
+                           sampling_params=sampling_params,
+                           use_tqdm=False)
+        assert len(res.outputs) == 1
+        assert len(res.outputs[0].token_ids) == output_len

870-874: Confirm if 5,000 tokens are necessary to reproduce the issue; otherwise lower or mark as slow

5k tokens can add noticeable CI time. If a smaller value (e.g., 512 or 1024) still repros, prefer that; otherwise consider marking the test as slow or gating by GPU memory.

📜 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 222e016 and df113af.

📒 Files selected for processing (1)
  • tests/unittest/llmapi/test_llm_pytorch.py (1 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:

  • tests/unittest/llmapi/test_llm_pytorch.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:

  • tests/unittest/llmapi/test_llm_pytorch.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:

  • tests/unittest/llmapi/test_llm_pytorch.py
🧬 Code graph analysis (1)
tests/unittest/llmapi/test_llm_pytorch.py (2)
tensorrt_llm/llmapi/llm.py (2)
  • LLM (1017-1033)
  • generate (237-315)
tensorrt_llm/sampling_params.py (1)
  • SamplingParams (125-486)
⏰ 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 #18383 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

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

@ixlmar
Copy link
Collaborator Author

ixlmar commented Sep 10, 2025

/bot run --disable-fail-fast

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18397 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

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

@DomBrown
Copy link
Collaborator

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18433 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

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

@DomBrown DomBrown merged commit 965a3da into NVIDIA:main Sep 15, 2025
8 of 9 checks passed
@ixlmar ixlmar deleted the test/min-tokens branch September 16, 2025 07:21
Wong4j pushed a commit to Wong4j/TensorRT-LLM that referenced this pull request Sep 20, 2025
Signed-off-by: ixlmar <206748156+ixlmar@users.noreply.github.com>
MrGeva pushed a commit to nv-auto-deploy/TensorRT-LLM that referenced this pull request Sep 21, 2025
Signed-off-by: ixlmar <206748156+ixlmar@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