KEMBAR78
[None][fix] fix scaffolding dynasor test by dc3671 · Pull Request #7070 · NVIDIA/TensorRT-LLM · GitHub
Skip to content

Conversation

@dc3671
Copy link
Collaborator

@dc3671 dc3671 commented Aug 20, 2025

Summary by CodeRabbit

  • New Features

    • Unified single entry-point runner for Dynasor.
    • Optional streaming mode with live progress updates.
    • Majority-vote mode to aggregate multiple generations.
  • Improvements

    • More consistent output formatting for both streaming and non-streaming runs.
    • Clearer final result display.
    • More reliable shutdown and cleanup after runs.
  • Refactor

    • Replaced the legacy test harness with a consolidated run flow, standardizing worker usage and execution path.

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.

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: Zhenhuan Chen <chenzhh3671@gmail.com>
@dc3671 dc3671 requested a review from WeiHaocheng August 20, 2025 03:17
@dc3671 dc3671 requested a review from a team as a code owner August 20, 2025 03:17
@dc3671 dc3671 requested review from QiJune and Shixiaowei02 August 20, 2025 03:17
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 20, 2025

📝 Walkthrough

Walkthrough

Replaces the legacy test harness with a single main() entry point. Switches from proposer_worker to generation_worker (TRTLLMWorker). Integrates DynasorGenerationController with optional MajorityVoteController. Adds both streaming (async) and non-streaming output handling and updates shutdown to use generation_worker.

Changes

Cohort / File(s) Summary of Changes
Dynasor run harness refactor
examples/scaffolding/contrib/Dynasor/scaffolding_dynasor_run.py
Replaced test(prompts, proposer_worker, args) with main(). Introduced generation_worker (TRTLLMWorker) and DynasorGenerationController with optional MajorityVoteController. Updated output access patterns for streaming and non-streaming flows. Adjusted worker wiring and shutdown to use generation_worker. Removed legacy harness logic.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant U as User (CLI)
  participant M as main()
  participant GW as generation_worker (TRTLLMWorker)
  participant L as ScaffoldingLlm
  participant C as Controller<br/>(DynasorGenerationController / MajorityVoteController)

  Note over U,M: Start application
  U->>M: Run script
  M->>GW: Initialize
  M->>C: Instantiate controller (streaming or non-streaming)
  M->>L: Create LLM with generation_worker
  alt Streaming
    M->>L: generate_async(prompts)
    L->>C: Control flow (streaming)
    C->>GW: Generate tokens (stream)
    loop token stream
      GW-->>C: Partial output
      C-->>L: Current output
      L-->>M: cur_output updates
      M->>U: Print progress
    end
    L-->>M: Final result
    M->>U: Print final output
  else Non-streaming
    M->>L: generate(prompts)
    L->>C: Control flow (batch)
    C->>GW: Generate output
    GW-->>C: Result
    C-->>L: Result
    L-->>M: results.outputs[0].text
    M->>U: Print output
  end
  M->>GW: shutdown()
  M-->>U: Exit
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

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.

✨ 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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@dc3671
Copy link
Collaborator Author

dc3671 commented Aug 20, 2025

/bot skip --comment "only modify scaffolding example file"

@dc3671 dc3671 changed the title fix(scaffolding): fix scaffolding dynasor test [None][fix] fix scaffolding dynasor test Aug 20, 2025
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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
examples/scaffolding/contrib/Dynasor/scaffolding_dynasor_run.py (2)

65-90: Make shutdown reliable and fix potential NameError in streaming path.

Two issues:

  • result is referenced after the async-for loop; if the generator yields nothing, this raises NameError.
  • Wrap generation in try/finally so we always shut down LLM/worker on error, avoiding GPU/resource leaks.
-    if args.streaming:
-
-        async def task(prompt: str):
-            i = 0
-            async for result in llm.generate_async(prompt):
-                i += 1
-                print(">>>", i, result)
-                async for output in result.cur_output:
-                    print(">>>", i, len(output.outputs[0].token_ids), "\n",
-                          output.outputs[0].text)
-            print(f">>> final output {len(result.outputs[0].token_ids)}\n",
-                  result.outputs[0].text)
-
-        # Need to provide LLM's event loop to get results in the middle of the whole process.
-        asyncio.run_coroutine_threadsafe(task(prompts[0]), llm.loop).result()
-    else:
-        results = llm.generate(prompts)
-        for result in results:
-            print(result.outputs[0].text)
-
-    print(f"main shutting down...")
-    llm.shutdown()
-    print(f"worker shutting down...")
-    generation_worker.shutdown()
-    print(f"main shut down done")
+    try:
+        if args.streaming:
+            async def task(prompt: str):
+                i = 0
+                last_result = None
+                async for result in llm.generate_async(prompt):
+                    i += 1
+                    print(">>>", i, result)
+                    async for output in result.cur_output:
+                        print(
+                            ">>>",
+                            i,
+                            len(output.outputs[0].token_ids),
+                            "\n",
+                            output.outputs[0].text,
+                        )
+                    last_result = result
+                if last_result is not None:
+                    print(
+                        f">>> final output {len(last_result.outputs[0].token_ids)}\n",
+                        last_result.outputs[0].text,
+                    )
+                else:
+                    print(">>> final output: <no output produced>")
+
+            # Need to provide LLM's event loop to get results in the middle of the whole process.
+            asyncio.run_coroutine_threadsafe(task(prompts[0]), llm.loop).result()
+        else:
+            results = llm.generate(prompts)
+            for result in results:
+                print(result.outputs[0].text)
+    finally:
+        print("main shutting down...")
+        llm.shutdown()
+        print("worker shutting down...")
+        generation_worker.shutdown()
+        print("main shut down done")

1-1: Add NVIDIA SPDX copyright header to Python source

Per repository convention, prepend the following two-line SPDX banner to the top of examples/scaffolding/contrib/Dynasor/scaffolding_dynasor_run.py (before any imports):

+ # SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+ # SPDX-License-Identifier: Apache-2.0
  import argparse
  import asyncio
  • File: examples/scaffolding/contrib/Dynasor/scaffolding_dynasor_run.py
  • Location: Insert immediately above the first import statement.
🧹 Nitpick comments (3)
examples/scaffolding/contrib/Dynasor/scaffolding_dynasor_run.py (3)

9-22: Add type hints and short docstrings to public entry points.

Improves readability and aligns with the docstring/type-hint guidelines.

-def parse_arguments():
+def parse_arguments() -> argparse.Namespace:
+    """Parse CLI arguments for the Dynasor scaffolding example.
+
+    Returns:
+        argparse.Namespace: Parsed command-line arguments.
+    """
     parser = argparse.ArgumentParser()
@@
-    return args
+    return args
@@
-def main():
-    args = parse_arguments()
+def main() -> None:
+    """Entry point for the Dynasor scaffolding example."""
+    args = parse_arguments()

Also applies to: 25-26


42-63: De-duplicate ScaffoldingLlm construction.

Reduce duplication by selecting the prototype_controller once, then constructing ScaffoldingLlm in a single place.

     # If majority voting is requested, wrap the controller in MajorityVoteController
     if args.majority_vote:
         majority_vote_controller = MajorityVoteController(
             generation_controller=dynasor_generation_controller,
             default_sample_num=args.sample_num,
         )
-        llm = ScaffoldingLlm(
-            prototype_controller=majority_vote_controller,
-            workers={
-                DynasorGenerationController.WorkerTag.GENERATION:
-                generation_worker
-            },
-        )
-    else:
-        # Otherwise Use Dynasor controller directly
-        llm = ScaffoldingLlm(
-            prototype_controller=dynasor_generation_controller,
-            workers={
-                DynasorGenerationController.WorkerTag.GENERATION:
-                generation_worker
-            },
-        )
+    # Choose controller and initialize the LLM once
+    prototype_controller = (
+        majority_vote_controller
+        if args.majority_vote
+        else dynasor_generation_controller
+    )
+    llm = ScaffoldingLlm(
+        prototype_controller=prototype_controller,
+        workers={
+            DynasorGenerationController.WorkerTag.GENERATION: generation_worker
+        },
+    )

65-79: Optional: stream all prompts (not just the first) or make it explicit.

Currently, the streaming path runs only prompts[0], while the non-streaming path handles all prompts. Either iterate through all prompts in streaming mode or add a comment flag making the intentional single-prompt behavior explicit.

Would you like a small helper to stream prompts sequentially (or concurrently) with asyncio.gather?

📜 Review details

Configuration used: .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.

📥 Commits

Reviewing files that changed from the base of the PR and between fc85e3d and 526300d.

📒 Files selected for processing (1)
  • examples/scaffolding/contrib/Dynasor/scaffolding_dynasor_run.py (4 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:

  • examples/scaffolding/contrib/Dynasor/scaffolding_dynasor_run.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:

  • examples/scaffolding/contrib/Dynasor/scaffolding_dynasor_run.py
🪛 Ruff (0.12.2)
examples/scaffolding/contrib/Dynasor/scaffolding_dynasor_run.py

29-29: Line too long (174 > 120)

(E501)


30-30: Line too long (151 > 120)

(E501)


31-31: Line too long (128 > 120)

(E501)

⏰ 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 #15865 [ skip ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #15865 [ skip ] completed with state SUCCESS
Skipping testing for commit 526300d

Copy link
Collaborator

@QiJune QiJune left a comment

Choose a reason for hiding this comment

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

LGTM

@dc3671 dc3671 merged commit 20f54cb into NVIDIA:main Aug 20, 2025
4 of 6 checks passed
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