Skip to content

rccl: add CAST environment variables to docs - #8613

Merged
VadimKutovoi merged 4 commits into
developfrom
users/vkutovoi/cast-docs
Nov 1, 2026
Merged

VadimKutovoi merged 4 commits into
developfrom
users/vkutovoi/cast-docs

Conversation

@VadimKutovoi

@VadimKutovoi VadimKutovoi commented Jul 15, 2026 •

Copy link
Copy Markdown
Contributor

Motivation

This pull request adds documentation for the CAST (Congestion aware sprayed traffic) QP (Queue Pair) scheduler in the RCCL library. These variables allow users to tune the scheduler's operation, logging, and message distribution modes.

QP scheduling (CAST) documentation:

  • Added a new section describing the CAST QP scheduler, its purpose, and how it balances RDMA traffic using measured RTT.
  • Documented all CAST-related environment variables (with RCCL_ or NCCL_ prefixes), including enabling/disabling the scheduler, WRR scheduling, intervals for statistics reset and update, EMA weighting, minimum split size, logging options, and message distribution modes.
  • Clarified default values, valid ranges, and the effect of each variable, making it easier for users to configure and troubleshoot the scheduler.

Technical Details

JIRA ID

JIRA ID AICOMNET-37

Test Plan

Test Result

Submission Checklist

@VadimKutovoi VadimKutovoi self-assigned this Jul 15, 2026
@VadimKutovoi
VadimKutovoi requested a review from a team as a code owner July 15, 2026 11:12
Copilot AI review requested due to automatic review settings July 15, 2026 11:12
@VadimKutovoi VadimKutovoi added the documentation Improvements or additions to documentation label Jul 15, 2026
@VadimKutovoi
VadimKutovoi force-pushed the users/vkutovoi/cast-docs branch from f6e019f to c8074cd Compare July 15, 2026 11:13
@therock-pr-bot

therock-pr-bot Bot commented Jul 15, 2026 •

Copy link
Copy Markdown

✅ All Policy Checks Passed

Check Status Details
📝 PR Description ✅ Pass —
⛔ Forbidden Files ✅ Pass —
🧪 Unit Test ✅ Pass PR does not contain code files — Unit Test auto-passed
🚫 Draft PR 🔜 To Be Enabled —
🚩 Feature Flag 🔜 To Be Enabled —
📊 Code Coverage 🔜 To Be Enabled —

🎉 All policy checks passed!

📖 Need help? See the Policy FAQ for details on every check and how to fix failures.

🙋 Wish to Override Policy?

@therock-pr-bot

Copy link
Copy Markdown

🚫 Please fix the failed policies before requesting reviews.

The following policy checks failed:

  • ❌ PR Title/Description

The Not ready to Review label has been added to this PR.
Once all policies pass, the label will be removed automatically.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds documentation for CAST (Congestion aware sprayed traffic) QP scheduling tunables in the RCCL environment variables reference, describing how to enable the scheduler and configure its update/reset behavior, weighting, split-data mode, and logging.

Changes:

  • Introduces a new “QP scheduling (CAST)” section in the env var reference.
  • Documents CAST scheduler enable/WRR, timing/weighting knobs, split-data chunk minimum, and log path/interval.
  • Adds guidance for NCCL_IB_SPLIT_DATA_ON_QPS behavior when distributing traffic across QPs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

@VadimKutovoi
VadimKutovoi force-pushed the users/vkutovoi/cast-docs branch from 3f7fac8 to 73140d7 Compare July 27, 2026 21:13
@github-actions

Copy link
Copy Markdown
Contributor

This pull request has been inactive for 25 days and will be marked as stale.

If you would like to keep this PR open, please:

  • Add new commits
  • Add a comment explaining why it should remain open

This PR will be automatically closed in 5 days if no further activity occurs.

@github-actions github-actions Bot added the Stale PR has no activity for 25+ days label Aug 22, 2026
@VadimKutovoi VadimKutovoi removed the Stale PR has no activity for 25+ days label Aug 22, 2026
@VadimKutovoi
VadimKutovoi force-pushed the users/vkutovoi/cast-docs branch from 73140d7 to 4e7cccf Compare October 22, 2026 09:30

@amd-argus amd-argus Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

ARGUS

Bottom line: Worth settling before approval: the RCCL_IB_QP_SCHED_ENABLE row says NCCL_NET=IB-CAST forces the scheduler on, which does not hold on AINIC, where the matching scheme defaults to BY_ORDER.

Comment @argus review to re-run, or @argus re-review after pushing.

@VadimKutovoi

Copy link
Copy Markdown
Contributor Author

@argus re-review

@VadimKutovoi
VadimKutovoi requested a review from ddurnov October 22, 2026 10:58
@amd-argus

amd-argus Bot commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

@VadimKutovoi the current head (4e7cccfb) already has a review from me above; nothing has changed since then for me to look at again. Push a change and I'll pick it up, or ask again once you have.

@VadimKutovoi
VadimKutovoi force-pushed the users/vkutovoi/cast-docs branch from 4e7cccf to 75b382b Compare October 22, 2026 11:25
@VadimKutovoi

Copy link
Copy Markdown
Contributor Author

@argus re-review

@amd-argus amd-argus Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

ARGUS

Bottom line: LGTM.

Comment @argus review to re-run, or @argus re-review after pushing.

@amd-argus

amd-argus Bot commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

@VadimKutovoi the current head (75b382b3) already has a review from me above; nothing has changed since then for me to look at again. Push a change and I'll pick it up, or ask again once you have.

@VadimKutovoi
VadimKutovoi force-pushed the users/vkutovoi/cast-docs branch from 75b382b to 2aed6c1 Compare October 29, 2026 09:28

@amd-argus amd-argus Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

ARGUS

Bottom line: LGTM.

Comment @argus review to re-run, or @argus re-review after pushing.

Fix the default-enablement claim (it's disabled by default on AINIC,
not enabled everywhere except when forced), scope the port
failover/QP-sharing override to apply regardless of the enable value,
and explain concretely when a connection resolves to BY_ORDER receive
matching.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

@amd-argus amd-argus Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

ARGUS

Bottom line: LGTM.

Comment @argus review to re-run, or @argus re-review after pushing.

List accepted values flat up front, man-page style, and describe when
the scheduler has no effect on AINIC in terms of other documented
knobs (NCCL_IB_OOO_RQ, NCCL_IB_RECEIVER_SIDE_MATCHING_SCHEME) instead
of the internal, undocumented BY_ORDER/CTS-offload machinery.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

@amd-argus amd-argus Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

ARGUS

Bottom line: Worth settling before approval: the RCCL_IB_QP_SCHED_ENABLE auto rule at lines 811-814 does not match rcclUseIbCastQpSched for NCCL_NET=ROCM-IB on non-AINIC NICs, or for NCCL_NET=IB-CAST on AINIC while CTS offload is on.

Comment @argus review to re-run, or @argus re-review after pushing.

@VadimKutovoi
VadimKutovoi force-pushed the users/vkutovoi/cast-docs branch from 5371907 to 09a519a Compare October 30, 2026 12:58

@amd-argus amd-argus Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

ARGUS

Bottom line: Nothing new worth raising; still open from earlier: env-variables.rst:814. Worth clearing before approval.

Comment @argus review to re-run, or @argus re-review after pushing.

@corey-derochie-amd corey-derochie-amd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Approved, but the wording is slightly misleading on a couple, recommend following the copilot suggestion.

Co-authored-by: VadimKutovoi <32107368+VadimKutovoi@users.noreply.github.com>

@amd-argus amd-argus Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

ARGUS

Bottom line: Nothing new worth raising; still open from earlier: env-variables.rst:814. Worth clearing before approval.

Comment @argus review to re-run, or @argus re-review after pushing.

@VadimKutovoi
VadimKutovoi merged commit 6a091f4 into develop Nov 1, 2026
23 of 26 checks passed
@VadimKutovoi
VadimKutovoi deleted the users/vkutovoi/cast-docs branch November 1, 2026 20:01
@systems-assistant

Copy link
Copy Markdown
Contributor

TheRock Submodule Bump Activity

Newest first

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation organization: ROCm project: rccl

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants