[None] [chore] Enhancements and clean up to slurm scripts #9493
Conversation
kaiyux
changed the title
kaiyux
force-pushed
the
user/kaiyu/clean_up_slurm_scripts
branch
from
4143eff to
15a3231
Compare
kaiyux
requested review from
Barry-Delaney,
Tabrizian,
chenfeiz0326,
chzblych,
dc3671,
fredricz-20070104,
nv-guomingz and
schetlur-nv
and removed request for
chzblych,
nv-guomingz and
schetlur-nv
📝 WalkthroughWalkthroughThe pull request refactors profiling configuration in disaggregated Slurm benchmark scripts by replacing the enable_pdl mechanism with profiling range variables (ctx_profile_range and gen_profile_range). Configuration parameters are moved from runtime YAML parsing to pre-defined values, Slurm extra arguments support is added, and environment variable handling is streamlined across shell and Python scripts. Changes
Sequence DiagramsequenceDiagram
participant Config as config.yaml
participant SLURM as disaggr_torch.slurm
participant Worker as start_worker.sh
Config->>SLURM: Provide ctx_profile_range,<br/>gen_profile_range
SLURM->>SLURM: Parse profiling ranges<br/>(replaces enable_pdl)
SLURM->>Worker: Pass profile_range arg
alt enable_nsys is "true"
Worker->>Worker: Set NSYS_MPI_STORE_TEAMS_PER_RANK
Worker->>Worker: Set TLLM_PROFILE_START_STOP<br/>from profile_range
Worker->>Worker: Initialize nsys_prefix<br/>with profile command
Worker->>Worker: Execute with nsys_prefix<br/>prepended to launch
else enable_nsys is not "true"
Worker->>Worker: Execute launch command<br/>without nsys profiling
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. 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 |
There was a problem hiding this comment.
There are more config files in the repo now and I'll update those as well.
![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)
examples/disaggregated/slurm/benchmark/start_worker.sh (1)
46-46: Quote command substitutions to prevent word splitting.While hostnames typically don't contain spaces, quoting
$(hostname)follows shell scripting best practices and prevents potential issues if a hostname contains special characters.Apply this diff:
- echo $(hostname) > ${log_dir}/hostnames/${role}_${instance_id}.txt + echo "$(hostname)" > ${log_dir}/hostnames/${role}_${instance_id}.txtAnd:
- --host $(hostname) --port ${port} \ + --host "$(hostname)" --port ${port} \Also applies to: 65-65
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
examples/disaggregated/slurm/benchmark/config.yaml(2 hunks)examples/disaggregated/slurm/benchmark/disaggr_torch.slurm(4 hunks)examples/disaggregated/slurm/benchmark/start_worker.sh(2 hunks)examples/disaggregated/slurm/benchmark/submit.py(2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.py
📄 CodeRabbit inference engine (CODING_GUIDELINES.md)
**/*.py: The 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 (e.g., usefrom package.subpackage import fooand thenfoo.SomeClass()instead offrom package.subpackage.foo import SomeClass)
Python filenames should use snake_case (e.g.,some_file.py)
Python class names should use PascalCase (e.g.,class SomeClass)
Python function and method names should use snake_case (e.g.,def my_awesome_function():)
Python local variable names should use snake_case, with prefixkfor variable names that start with a number (e.g.,k_99th_percentile = ...)
Python global variables should use upper snake_case with prefixG(e.g.,G_MY_GLOBAL = ...)
Python constants should use upper snake_case (e.g.,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 for Python classes and functions, which can be parsed by Sphinx
Python attributes and variables can be documented inline with type and description (e.g.,self.x = 5followed by"""<type>: Description of 'x'""")
Avoid using reflection in Python when functionality can be easily achieved without reflection
When using try-except blocks in Python, limit the except clause to the smallest set of specific errors possible instead of catching all exceptions
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 and use the else block to implement the logic
Files:
examples/disaggregated/slurm/benchmark/submit.py
**/*.{cpp,h,cu,py}
📄 CodeRabbit inference engine (CODING_GUIDELINES.md)
All TensorRT-LLM Open Source Software code files should contain an NVIDIA copyright header that includes the current year at the top
Files:
examples/disaggregated/slurm/benchmark/submit.py
🧠 Learnings (1)
📓 Common learnings
Learnt from: venkywonka
Repo: NVIDIA/TensorRT-LLM PR: 6029
File: .github/pull_request_template.md:45-53
Timestamp: 2025-08-27T17:50:13.264Z
Learning: For PR templates in TensorRT-LLM, avoid suggesting changes that would increase developer overhead, such as converting plain bullets to mandatory checkboxes. The team prefers guidance-style bullets that don't require explicit interaction to reduce friction in the PR creation process.
🪛 Shellcheck (0.11.0)
examples/disaggregated/slurm/benchmark/start_worker.sh
[warning] 46-46: Quote this to prevent word splitting.
(SC2046)
[warning] 65-65: Quote this to prevent word splitting.
(SC2046)
⏰ 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 (12)
examples/disaggregated/slurm/benchmark/config.yaml (3)
38-39: LGTM! Environment configuration simplification.Moving
TRTLLM_ENABLE_PDL=1toworker_env_vareliminates the need for runtime YAML parsing in the Slurm script. The space-separated format is correctly parsed instart_worker.sh(lines 23-26).
44-45: LGTM! Profiling range configuration.The separate profiling ranges for context and generation workers allow for fine-grained control. The range format aligns with the
TLLM_PROFILE_START_STOPenvironment variable usage instart_worker.sh.
8-8: Verify handling of emptyextra_argsin the submission script.The concern about passing empty strings to
sbatchis theoretically valid—empty string arguments can be received as positional arguments in job scripts. However, without access to the actual implementation insubmit.py(line 141), I cannot confirm whether this creates a practical issue.Recommended verification: Inspect how
extra_argsis integrated into thesbatchcommand construction—specifically whether empty strings are filtered, stripped, or passed through to the command invocation.examples/disaggregated/slurm/benchmark/submit.py (1)
182-183: LGTM! Profiling ranges forwarded correctly.The profiling range values are correctly extracted from the config and passed as positional arguments to the Slurm script, which expects them at positions 30-31.
examples/disaggregated/slurm/benchmark/disaggr_torch.slurm (3)
43-56: LGTM! Argument parsing updated consistently.The new profiling range variables are correctly inserted at positions 30-31, and all subsequent argument indices (accuracy configuration at 32-35, environment variables at 36-37) are properly shifted.
95-96: LGTM! Debug output for profiling ranges.Adding echo statements for the new profiling range variables improves debuggability and is consistent with the existing argument printing pattern.
207-207: LGTM! Profiling ranges correctly routed to worker types.Generation workers receive
gen_profile_rangeand context workers receivectx_profile_range, allowing for differentiated profiling behavior based on workload characteristics.Also applies to: 222-222
examples/disaggregated/slurm/benchmark/start_worker.sh (5)
12-17: LGTM! Argument parsing updated for new profiling flow.The removal of
enable_pdland addition ofprofile_rangealigns with the refactoring to use explicit profiling ranges instead of deriving profiling configuration from YAML at runtime.
23-26: LGTM! Cleaner environment variable export.The loop correctly exports each space-separated environment variable from the config. The
export "${env_var}"syntax properly handlesVAR=valuepairs.
28-34: LGTM! Explicit handling of both numa_bind cases.The added
elseclause makes the non-binding case explicit and provides helpful guidance for GB200 users.
50-61: LGTM! Consolidated NSYS profiling configuration.The unified profiling setup using
profile_rangeeliminates per-role customization and simplifies the profiling flow. TheTLLM_PROFILE_START_STOPenvironment variable correctly receives the profiling range passed from the configuration.
63-66: LGTM! Launch command with conditional NSYS prefix.The launch command correctly uses
${nsys_prefix}to conditionally enable profiling. Whenenable_nsysis not "true", the prefix is empty and the command runs normally.
dc3671
left a comment
dc3671
left a comment
There was a problem hiding this comment.
I think we can try to use bash's getopts to handle named arguments, rather than use $0~$99 for arguments. Can be implemented in the future.
Signed-off-by: Kaiyu Xie <[email protected]>
Signed-off-by: Kaiyu Xie <[email protected]>
Signed-off-by: Kaiyu Xie <[email protected]>
Signed-off-by: Kaiyu Xie <[email protected]>
Signed-off-by: Kaiyu Xie <[email protected]>
Signed-off-by: Kaiyu Xie <[email protected]>
kaiyux
changed the title
kaiyux
force-pushed
the
user/kaiyu/clean_up_slurm_scripts
branch
from
67bd298 to
14d1702
Compare
Signed-off-by: Kaiyu Xie <[email protected]>
5 participants
Summary by CodeRabbit
Release Notes
New Features
Refactor
Chores
✏️ 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.
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.