[None][feat] move some disagg script's env configs from bash to submit.py#10223
[None][feat] move some disagg script's env configs from bash to submit.py#10223dc3671 merged 4 commits intoNVIDIA:mainfrom
Conversation
📝 WalkthroughWalkthroughThe changes modify benchmark worker startup configuration by simplifying shell script arguments, moving profiling environment variable exports from the worker startup script to Python-level coordination, and introducing per-server-type profiling and configuration handling in the submission process. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes 🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
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: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
examples/disaggregated/slurm/benchmark/submit.py (1)
1-16: Missing NVIDIA copyright header.As per coding guidelines, all TensorRT-LLM Open Source Software code should contain an NVIDIA copyright header that includes the year of its latest meaningful modification.
examples/disaggregated/slurm/benchmark/start_worker.sh (1)
39-41: Bug: Undefined variableprofile_rangewill cause script failure.The script uses
set -u(line 2), which causes the script to fail on undefined variables. Line 40 references${profile_range}, but this variable is never defined in the script—it was removed when simplifying the positional arguments.The value is now passed via
TLLM_PROFILE_START_STOPinworker_env_var, so the echo statement should use that instead.🔎 Proposed fix
nsys_file=${log_dir}/nsys_worker_proc_${role}_${instance_id}_${SLURM_PROCID} - echo "nsys is enabled on ${role} GPUs, TLLM_PROFILE_START_STOP=${profile_range}" + echo "nsys is enabled on ${role} GPUs, TLLM_PROFILE_START_STOP=${TLLM_PROFILE_START_STOP}" nsys_prefix="nsys profile -o ${nsys_file} -f true -t cuda,nvtx,python-gil -c cudaProfilerApi --cuda-graph-trace node --capture-range-end=stop --gpu-metrics-devices=none"
🧹 Nitpick comments (1)
examples/disaggregated/slurm/benchmark/submit.py (1)
286-295: Potential leading space in environment variable string.When
worker_env_varis empty (default fromsetdefault('worker_env_var', '')), appending with+=adds leading spaces tocur_worker_env_var. While the shell may handle this gracefully, it's cleaner to strip or use a list and join.Also, per static analysis: prefer
next(iter(allocation["nodes"].values()))overlist(...)[0]for efficiency.🔎 Proposed fix
cur_worker_env_var = worker_env_var if profiling_config['nsys_on']: cur_worker_env_var += " TLLM_PROFILE_RECORD_GC=1" cur_worker_env_var += " TLLM_NVTX_DEBUG=1" cur_worker_env_var += " NSYS_MPI_STORE_TEAMS_PER_RANK=1" cur_worker_env_var += f" TLLM_PROFILE_START_STOP={profile_range}" cuda_devices = ",".join([ - str(device) for device in list(allocation["nodes"].values())[0] + str(device) for device in next(iter(allocation["nodes"].values())) ]) cur_worker_env_var += f" CUDA_VISIBLE_DEVICES={cuda_devices}"
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
examples/disaggregated/slurm/benchmark/start_worker.shexamples/disaggregated/slurm/benchmark/submit.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:
examples/disaggregated/slurm/benchmark/submit.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:
examples/disaggregated/slurm/benchmark/submit.py
🧠 Learnings (1)
📚 Learning: 2025-08-26T09:49:04.956Z
Learnt from: pengbowang-nv
Repo: NVIDIA/TensorRT-LLM PR: 7192
File: tests/integration/test_lists/test-db/l0_dgx_b200.yml:56-72
Timestamp: 2025-08-26T09:49:04.956Z
Learning: In TensorRT-LLM test configuration files, the test scheduling system handles wildcard matching with special rules that prevent duplicate test execution even when the same tests appear in multiple yaml files with overlapping GPU wildcards (e.g., "*b200*" and "*gb200*").
Applied to files:
examples/disaggregated/slurm/benchmark/start_worker.sh
🪛 Ruff (0.14.10)
examples/disaggregated/slurm/benchmark/submit.py
293-293: Prefer next(iter(allocation["nodes"].values())) over single element slice
Replace with next(iter(allocation["nodes"].values()))
(RUF015)
⏰ 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/disaggregated/slurm/benchmark/start_worker.sh (2)
19-23: Approve: Clean approach for exporting environment variables.The loop-based export of worker environment variables is a clean pattern that allows Python to control the environment configuration while keeping the shell script simple. The echo statement provides good visibility for debugging.
10-14: Simplified argument handling looks good.The reduced positional arguments align with the changes in
submit.py. The new flow centralizes configuration in Python and passes it viaconfig_fileandworker_env_var.
dc3671
force-pushed
the
improve-disagg-script
branch
from
6474c4b to
36943d4
Compare
kaiyux
force-pushed
the
improve-disagg-script
branch
from
36943d4 to
cc17d98
Compare
dc3671
force-pushed
the
improve-disagg-script
branch
from
cc17d98 to
1dc1e10
Compare
|
/bot skip --comment "No CI for slurm scripts" |
|
PR_Github #34404 [ skip ] triggered by Bot. Commit: |
|
PR_Github #34404 [ skip ] completed with state |
|
/bot skip --comment "No CI for slurm scripts" |
|
PR_Github #34427 [ skip ] triggered by Bot. Commit: |
|
PR_Github #34427 [ skip ] completed with state |
|
/bot skip --comment "No CI for slurm scripts" |
|
PR_Github #34431 [ skip ] triggered by Bot. Commit: |
|
PR_Github #34431 [ skip ] completed with state |
|
/bot skip --comment "No CI for slurm scripts" |
|
/bot skip --comment "No CI for slurm scripts" |
Signed-off-by: Zhenhuan Chen <zhenhuanc@nvidia.com>
dc3671
force-pushed
the
improve-disagg-script
branch
from
e611fba to
f28304a
Compare
|
/bot skip --comment "No CI for slurm scripts" |
1 similar comment
|
/bot skip --comment "No CI for slurm scripts" |
|
PR_Github #34740 [ skip ] triggered by Bot. Commit: |
|
PR_Github #34740 [ skip ] completed with state |
…t.py (NVIDIA#10223) Signed-off-by: Zhenhuan Chen <zhenhuanc@nvidia.com>
4 participants
Summary by CodeRabbit
Refactor
Bug Fixes
✏️ Tip: You can customize this high-level summary in your review settings.
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
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 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.