Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 19, 2025

Overview

This PR adds documentation for five new examples that were recently added to the repository but were missing from the documentation files. The PR also syncs with the main branch to include the latest examples.

Changes

New Examples Added to Documentation

  1. 15_gemm_all_reduce_ring_based: Matrix multiplication with ring-based all-reduce communication pattern
  2. 16_all_reduce_ring_based: Ring-based all-reduce operation for distributed computing
  3. 17_gemm_one_shot_all_reduce_pc: Matrix multiplication with one-shot all-reduce using producer-consumer pattern with two distribution modes (striding and block)
  4. 20_gemm_all_scatter_independent: Independent GEMM and all-scatter operations with support for CSV input configurations (was in examples/README.md but missing from docs/reference/examples.md)
  5. 21_gemm_one_shot_all_reduce_independent: Independent GEMM and all-reduce operations with support for CSV input configurations and selective execution

Files Updated

  • docs/reference/examples.md: Added links and descriptions for examples 15, 16, 17, 20, and 21 in the GEMM Operations section
  • examples/README.md:
    • Added directory listings for examples 15, 16, 17, and 21 in the GEMM Operations section
    • Added usage examples showing how to run the benchmark scripts for all new examples
    • Merged with main branch to include usage examples and CSV configuration documentation for examples 17 and 21

Example Usage

The new examples can be run as follows:

# Ring-based all-reduce for GEMM
python examples/15_gemm_all_reduce_ring_based/benchmark.py --benchmark --validate --num_ranks 8

# Ring-based all-reduce
python examples/16_all_reduce_ring_based/benchmark.py --benchmark --validate --num_ranks 8

# One-shot all-reduce with producer-consumer pattern
python examples/17_gemm_one_shot_all_reduce_pc/benchmark.py --benchmark --validate --num_ranks 8 --distribution 0

# Independent GEMM and all-reduce
python examples/21_gemm_one_shot_all_reduce_independent/benchmark.py --benchmark --validate --num_ranks 8

All example directories are now properly documented and accessible to users through both the main documentation site and the examples README.

Fixes #259

Original prompt

This section details on the original issue you should resolve

<issue_title>Add new examples to docs and readmes</issue_title>
<issue_description>We added a few new examples but we didn’t update and add links to them in our docs. Add links to new examples</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #259


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: mawad-amd <112003944+mawad-amd@users.noreply.github.com>
Copilot AI changed the title [WIP] Add new examples to documentation and readmes Add new examples to documentation (15, 16, and 20) Oct 19, 2025
Copilot AI requested a review from mawad-amd October 19, 2025 05:16
Copilot finished work on behalf of mawad-amd October 19, 2025 05:16
@mawad-amd
Copy link
Collaborator

@copilot sync with main and add all new examples

Co-authored-by: mawad-amd <112003944+mawad-amd@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Oct 19, 2025

@copilot sync with main and add all new examples

Synced with main branch and added all new examples to documentation. Commit 5011648 includes:

  • Merged main branch
  • Added example 17 (gemm_one_shot_all_reduce_pc) to both documentation files
  • Added example 21 (gemm_one_shot_all_reduce_independent) to both documentation files

All 20 example directories are now documented in docs/reference/examples.md and examples/README.md.

Copilot AI changed the title Add new examples to documentation (15, 16, and 20) Add new examples to documentation (15, 16, 17, 20, and 21) Oct 19, 2025
Copilot finished work on behalf of mawad-amd October 19, 2025 07:57
Co-authored-by: mawad-amd <112003944+mawad-amd@users.noreply.github.com>
Copilot AI requested a review from mawad-amd October 19, 2025 10:02
Copilot finished work on behalf of mawad-amd October 19, 2025 10:02
…pdated

Co-authored-by: mawad-amd <112003944+mawad-amd@users.noreply.github.com>
Copilot finished work on behalf of mawad-amd October 19, 2025 10:06
@mawad-amd mawad-amd marked this pull request as ready for review October 19, 2025 10:11
@mawad-amd mawad-amd requested a review from neoblizz as a code owner October 19, 2025 10:11
Copilot AI review requested due to automatic review settings October 19, 2025 10:11
@mawad-amd mawad-amd requested a review from BKP as a code owner October 19, 2025 10:11
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds documentation for five new examples (15, 16, 17, 20, and 21) that were recently added to the repository but were missing from the documentation files.

  • Updates docs/reference/examples.md to include links and descriptions for the new examples
  • Updates examples/README.md to add usage commands for examples 15 and 16
  • Ensures all new examples are properly documented and accessible to users

Reviewed Changes

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

File Description
examples/README.md Added usage examples for ring-based all-reduce examples (15 and 16)
docs/reference/examples.md Added documentation links and descriptions for examples 15, 16, 17, 20, and 21 in the GEMM Operations section

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.

Add new examples to docs and readmes

2 participants