[https://nvbugs/5405041][fix] Update wide ep doc

[qiaoxj07]

Summary by CodeRabbit

• Refactor
  • Clarified per-context node count calculation by introducing a dedicated variable and aligning total node computation; operational behavior and scheduling results remain unchanged.
• Documentation
  • Enhanced inline comments for readability, including explicit note about 8 GPUs per node and guidance for alternate calculations on specific hardware.
• Chores
  • Minor script cleanup to improve maintainability; submission invocation and argument handling are unchanged.

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.

[coderabbitai]

📝 Walkthrough

Walkthrough

Reorganizes variable calculations in examples/wide_ep/slurm_scripts/submit.sh by introducing ctx_node_num, assigning ctx_num from it, and computing total_node_num from ctx_node_num in relevant blocks; expands comments to note B200 specifics and 8 GPUs per node. No changes to sbatch invocation or runtime behavior.

Changes

Cohort / File(s)	Summary
Slurm script variable reorg and comments examples/wide_ep/slurm_scripts/submit.sh	Introduced ctx_node_num computed from concurrency, assigned ctx_num=ctx_node_num, and derived total_node_num from ctx_node_num in both parameter blocks; expanded comments to reference B200 node alternative and note ntasks_per_node equals 8 GPUs per B200 node. No functional changes to submission flow.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• [https://nvbugs/5405041][fix] Update wide-ep doc #6933 — Mirrors the same submit.sh refactor introducing ctx_node_num, reassigning ctx_num, updating total_node_num calculations, and editing B200/ntasks_per_node comments.

Suggested labels

Documentation

Suggested reviewers

• chzblych
• QiJune
• kaiyux

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.

---

📜 Recent 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 cf8054e and ffd3acb.

📒 Files selected for processing (1)

• examples/wide_ep/slurm_scripts/submit.sh (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• examples/wide_ep/slurm_scripts/submit.sh

⏰ 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

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (4)

examples/wide_ep/slurm_scripts/submit.sh (4)

14-14: Avoid manual drift: derive ntasks_per_node from node type (GB200 vs B200).

The comment reminds the operator to change ntasks_per_node when switching hardware. This is error-prone and can desync with ctx_* math below.

Consider adding a node-type switch once and deriving GPUs-per-node (and any dependent knobs) from it. Minimal change:

-ntasks_per_node=4 # 4 GPUs per GB200 node, 8 GPUs per B200 node
+ntasks_per_node=${NTASKS_PER_NODE:-4} # default: GB200=4. Override via env: NTASKS_PER_NODE=8 for B200

Outside the selected range, you can make this safer by defining a single hardware selector near the top:

# Hardware profile: GB200 | B200
NODE_TYPE=${NODE_TYPE:-GB200}
case "$NODE_TYPE" in
  GB200) NTASKS_PER_NODE=4 ;;
  B200)  NTASKS_PER_NODE=8 ;;
  *) echo "Unknown NODE_TYPE=$NODE_TYPE"; exit 1 ;;
esac

This ensures --ntasks-per-node and --gres stay aligned when switching to B200.

---

25-28: Ceiling division and renaming look correct; consider centralizing GB200/B200 knobs.

The ceiling division for ctx_node_num is correct. Aliasing ctx_num to ctx_node_num preserves original semantics. total_node_num offsets (+4 for this block) also remain intact.

Because B200 adjustments require changing three places (divisor, ctx_num multiplier, and total_node_num offset), consider deriving them from a single profile to avoid partial edits. Example:

-ctx_node_num=$(((concurrency + 5499)/5500)) # $(((concurrency + 10999)/11000)) for B200
-ctx_num=${ctx_node_num} # $((ctx_node_num * 2)) for B200
-total_node_num=$((ctx_node_num + 4)) # $((ctx_node_num + 2)) for B200
+if [[ "${NODE_TYPE:-GB200}" == "B200" ]]; then
+  ctx_node_num=$(((concurrency + 10999)/11000))
+  ctx_num=$((ctx_node_num * 2))
+  total_node_num=$((ctx_node_num + 2))
+else
+  ctx_node_num=$(((concurrency + 5499)/5500))
+  ctx_num=${ctx_node_num}
+  total_node_num=$((ctx_node_num + 4))
+fi

This keeps the two hardware configurations in lockstep and avoids manual edits across multiple lines.

---

60-62: Mirrored block stays consistent; same suggestion to parameterize B200 mode.

This second block mirrors the first (with different offsets) and remains internally consistent. Apply the same NODE_TYPE-driven derivation here to reduce duplication and prevent configuration skew when toggling B200.

-ctx_node_num=$(((concurrency + 5499)/5500)) # $(((concurrency + 10999)/11000)) for B200
-ctx_num=${ctx_node_num} # $((ctx_node_num * 2)) for B200
-total_node_num=$((ctx_node_num + 8)) # $((ctx_node_num + 4)) for B200
+if [[ "${NODE_TYPE:-GB200}" == "B200" ]]; then
+  ctx_node_num=$(((concurrency + 10999)/11000))
+  ctx_num=$((ctx_node_num * 2))
+  total_node_num=$((ctx_node_num + 4))
+else
+  ctx_node_num=$(((concurrency + 5499)/5500))
+  ctx_num=${ctx_node_num}
+  total_node_num=$((ctx_node_num + 8))
+fi

---

21-44: Optional: reduce duplication with a helper for layout computation.

Both blocks replicate concurrency, ctx_node_num/ctx_num, total_node_num, ntasks, and args assembly with small variations (offsets, generation server args). A small bash function would improve maintainability.

Happy to draft a refactor if you want a follow-up PR that introduces:

• NODE_TYPE profile
• a compute_layout() helper returning ctx_num and total_node_num
• a build_args() helper for args arrays

Also applies to: 57-80

📜 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 9e02f6b and cf8054e.

📒 Files selected for processing (1)

• examples/wide_ep/slurm_scripts/submit.sh (3 hunks)

⏰ 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 (1)

examples/wide_ep/slurm_scripts/submit.sh (1)

45-53: Confirm non-standard sbatch flag ‘--segment’.

Slurm’s upstream CLI does not include --segment. If this is a site-specific extension, all good. If not, sbatch may error out.

Can you confirm --segment is supported in your target cluster? If portability is a goal, consider gating it behind an env flag:

[[ -n "${USE_SEGMENT:-}" ]] && extra_flags+=(--segment="${total_node_num}")
sbatch "${extra_flags[@]}" ...

Also applies to: 81-89

[kaiyux]

/bot skip --comment "slurm examples are not tested in CI"

[tensorrt-cicd]

PR_Github #15525 [ skip ] triggered by Bot

[tensorrt-cicd]

PR_Github #15525 [ skip ] completed with state SUCCESS
Skipping testing for commit ffd3acb