Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 19, 2025

  • Synced with main branch
  • Resolved merge conflicts in examples/README.md
  • Added example 15 (gemm_all_reduce_ring_based) to both documentation files
  • Added example 16 (all_reduce_ring_based) to both documentation files
  • Added example 20 (gemm_all_scatter_independent) to both documentation files
  • Added example 21 (gemm_one_shot_all_reduce_independent) to both documentation files
  • Updated examples/README.md with all new examples and usage instructions
  • Removed example 17 from documentation (deleted from main branch)
  • Merged latest changes from main (arXiv paper, iris-ccl library, and test improvements)

Summary:
Successfully synced with main branch multiple times. The merge included:

  • Latest README updates with arXiv paper documentation and DOI badge
  • New iris-ccl collective communications library implementation
  • Example 17 (gemm_one_shot_all_reduce_pc) was removed from the main branch and documentation updated accordingly
  • Triton break statement fixes and VGPR reporting improvements
  • Added num_stages argument support

All documentation files are up to date and all examples are properly documented in both docs/reference/examples.md and examples/README.md. Current documented examples: 00-16, 20-21.

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
@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
Co-authored-by: mawad-amd <112003944+mawad-amd@users.noreply.github.com>
…pdated

Co-authored-by: mawad-amd <112003944+mawad-amd@users.noreply.github.com>
@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

@mawad-amd
Copy link
Collaborator

@copilot sync with main

Copy link
Contributor Author

Copilot AI commented Oct 31, 2025

@copilot sync with main

Synced with main branch in commit 70dba8d. The merge included:

  • README updates with latest news section
  • New all_reduce_wrapper.py files for examples 17 and 21
  • Triton break statement fixes and VGPR reporting improvements

All documentation for examples 15, 16, 17, 20, and 21 remains intact and up to date.

@mawad-amd
Copy link
Collaborator

@copilot sync with main

Copilot AI and others added 2 commits December 8, 2025 14:29
Co-authored-by: mawad-amd <112003944+mawad-amd@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Dec 8, 2025

@copilot sync with main

Synced with main branch in commit 4e5b5e2. The merge included:

  • arXiv paper documentation and DOI badge
  • New iris-ccl collective communications library
  • Example 17 was removed in main, updated docs/reference/examples.md accordingly
  • All remaining examples (15, 16, 20, 21) are properly documented

Copilot AI changed the title Add new examples to documentation (15, 16, 17, 20, and 21) Add new examples to documentation (15, 16, 20, and 21) Dec 8, 2025
Copilot AI requested a review from mawad-amd December 8, 2025 14:32
@mawad-amd mawad-amd merged commit 6219b1a into main Dec 8, 2025
4 checks passed
@mawad-amd mawad-amd deleted the copilot/add-examples-to-docs branch December 8, 2025 14:33
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