Skip to content

Update documentation for new RCCL test suite structure#146

Merged
cijohnson merged 1 commit into
mainfrom
ichristo/doc-update-new-rccl-test-suite
Apr 29, 2026
Merged

Update documentation for new RCCL test suite structure#146
cijohnson merged 1 commit into
mainfrom
ichristo/doc-update-new-rccl-test-suite

Conversation

@cijohnson

Copy link
Copy Markdown
Collaborator
  • Replace old RCCL test suites (rccl_multinode_cvs, rccl_multinode_default_cvs, rccl_singlenode_cvs, rccl_heatmap_cvs) with new ones (rccl_perf, rccl_regression)
  • Update configuration format to reflect new structure with mpi_params, rccl_test_params, and cvs_params sections
  • Document cvs generate heatmap command for performance comparison
  • Add comprehensive cvs scp command documentation for cluster file distribution
  • Update all examples and command references across documentation files

Changes:

  • docs/reference/configuration-files/rccl.rst: Updated test suite descriptions and config format
  • docs/how-to/run-cvs-tests.rst: Updated RCCL section with correct suite names
  • docs/how-to/copy-to-cluster.rst: New documentation for cvs scp command
  • docs/index.rst: Added copy-to-cluster documentation to index
  • README.md: Updated RCCL examples to use rccl_perf
  • cvs/tests/rccl/README.md: Removed references to non-existent singlenode suite

Made-with: Cursor

Motivation

Technical Details

Test Plan

Test Result

Submission Checklist

@cijohnson cijohnson changed the title Update documentation for new RCCL test suite structure [WIP]Update documentation for new RCCL test suite structure Apr 28, 2026

@speriaswamy-amd speriaswamy-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.

LGTM

@cijohnson cijohnson force-pushed the ichristo/doc-update-new-rccl-test-suite branch 2 times, most recently from 91e6ec5 to 9d9a373 Compare April 28, 2026 23:37
- Replace old RCCL test suites (rccl_multinode_cvs, rccl_multinode_default_cvs,
  rccl_singlenode_cvs, rccl_heatmap_cvs) with new ones (rccl_perf, rccl_regression)
- Update configuration format to reflect new structure with mpi_params,
  rccl_test_params, and cvs_params sections
- Document cvs generate heatmap command for performance comparison
- Add comprehensive cvs scp command documentation for cluster file distribution
- Update all examples and command references across documentation files

Changes:
- docs/reference/configuration-files/rccl.rst: Updated test suite descriptions and config format
- docs/how-to/run-cvs-tests.rst: Updated RCCL section with correct suite names
- docs/how-to/copy-to-cluster.rst: New documentation for cvs scp command
- docs/index.rst: Added copy-to-cluster documentation to index
- README.md: Updated RCCL examples to use rccl_perf
- cvs/tests/rccl/README.md: Removed references to non-existent singlenode suite

Made-with: Cursor
Signed-off-by: Ignatious Johnson <ichristo@amd.com>
@cijohnson cijohnson force-pushed the ichristo/doc-update-new-rccl-test-suite branch from 9d9a373 to d11410f Compare April 29, 2026 19:38
@cijohnson cijohnson changed the title [WIP]Update documentation for new RCCL test suite structure Update documentation for new RCCL test suite structure Apr 29, 2026
@cijohnson cijohnson merged commit 341532b into main Apr 29, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants