[#7588][feat] lock gpu clocks in test_perf.py to reliably detect perf regressions #8099
Conversation
Signed-off-by: Eran Geva <19514940+MrGeva@users.noreply.github.com>
|
/bot run |
📝 WalkthroughWalkthroughAdds GPU clock locking to the GPUClockLock context: captures current clocks, sets max SM/MEM clocks via NVML on enter, restores or resets on exit/teardown. Introduces methods to lock/unlock, queries target clocks from the first GPU, and guards for unsupported/mobile/Jetson or missing GPU handles. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Test as Test/Client
participant G as GPUClockLock
participant N as NVML
participant GPU as GPU Device
Test->>G: __enter__()
G->>N: nvmlInit / get handles
alt Has GPU handle and locking enabled
G->>N: nvmlDeviceGetMaxClockInfo(SM, MEM)
N-->>G: max_sm, max_mem
G->>N: nvmlDeviceGetApplicationsClocks()
N-->>G: orig_sm, orig_mem
G->>N: nvmlDeviceSetApplicationsClocks(max_sm, max_mem)
G->>G: mark clocks_locked=true
else No GPU / unsupported
G->>G: skip locking
end
G-->>Test: context ready (monitoring starts)
Test->>G: __exit__()/teardown
alt clocks_locked
G->>N: nvmlDeviceSetApplicationsClocks(orig_sm, orig_mem)
note over G,N: If originals unknown, reset to defaults
G->>N: nvmlDeviceResetApplicationsClocks() (fallback)
G->>G: mark clocks_locked=false
else not locked
G->>G: no-op
end
G-->>Test: cleanup done
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
tests/integration/defs/perf/gpu_clock_lock.py (1)
139-155: Consider refactoring for clarity per static analysis hint.The
return Noneat line 151 inside theexceptblock could be moved to anelseblock of the outerifstatement for better structure. However, the current implementation is functionally correct.Apply this diff to address the static analysis hint:
def get_target_gpu_clocks(self): """ Get the target GPU clocks (sm_clk and mem_clk) for the first GPU in the list. """ if self._gpu_handles and len(self._gpu_handles) > 0: try: # Get maximum supported clocks for the first GPU handle = self._gpu_handles[0] max_sm_clk = pynvml.nvmlDeviceGetMaxClockInfo( handle, pynvml.NVML_CLOCK_SM) max_mem_clk = pynvml.nvmlDeviceGetMaxClockInfo( handle, pynvml.NVML_CLOCK_MEM) return (max_sm_clk, max_mem_clk) except pynvml.NVMLError as e: print_warning(f"Failed to get max clock info: {e}") - return None - return None + else: + return None
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
tests/integration/defs/perf/gpu_clock_lock.py(5 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/integration/defs/perf/gpu_clock_lock.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/integration/defs/perf/gpu_clock_lock.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/integration/defs/perf/gpu_clock_lock.py
🧬 Code graph analysis (1)
tests/integration/defs/perf/gpu_clock_lock.py (1)
tests/integration/defs/trt_test_alternative.py (2)
print_warning(305-311)print_info(296-302)
🪛 Ruff (0.13.1)
tests/integration/defs/perf/gpu_clock_lock.py
151-151: Consider moving this statement to an else block
(TRY300)
⏰ 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 (5)
tests/integration/defs/perf/gpu_clock_lock.py (5)
114-116: LGTM!The new fields for clock locking state are properly initialized and follow naming conventions.
200-228: LGTM! Best-effort cleanup strategy is appropriate.The unlock method uses a best-effort approach with fallback to default clocks when original values aren't available. The state is always cleared at the end, which is appropriate for cleanup/teardown scenarios.
244-246: LGTM!Clock locking is properly integrated into the context manager's entry point, ensuring consistent performance during monitoring.
259-261: LGTM!Clock unlocking is properly integrated into the context manager's exit point, ensuring clocks are restored after monitoring completes.
331-331: LGTM!The call to
_unlock_gpu_clocks()in teardown provides an additional safety net to restore clocks at session end, even if the context manager wasn't used properly.
|
PR_Github #20373 [ run ] triggered by Bot |
|
PR_Github #20373 [ run ] completed with state |
Signed-off-by: Eran Geva <19514940+MrGeva@users.noreply.github.com>
|
/bot run |
MrGeva
changed the title
|
PR_Github #20390 [ run ] triggered by Bot |
|
PR_Github #20390 [ run ] completed with state |
|
/bot run |
|
PR_Github #20405 [ run ] triggered by Bot |
|
PR_Github #20405 [ run ] completed with state |
MrGeva
changed the title
…t perf regressions (NVIDIA#8099) Signed-off-by: Eran Geva <19514940+MrGeva@users.noreply.github.com> Signed-off-by: Faradawn Yang <faradawny@gmail.com>
…t perf regressions (NVIDIA#8099) Signed-off-by: Eran Geva <19514940+MrGeva@users.noreply.github.com>
…t perf regressions (NVIDIA#8099) Signed-off-by: Eran Geva <19514940+MrGeva@users.noreply.github.com> Signed-off-by: Faradawn Yang <faradawny@gmail.com>
3 participants
Summary by CodeRabbit
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 thestage-listparameter 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.mdand the
scripts/test_to_stage_mapping.pyhelper.kill
killKill all running builds associated with pull request.
skip
skip --comment COMMENTSkip 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-pipelineReuse 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.