-
Couldn't load subscription status.
- Fork 21
Add new examples to documentation (15, 16, 17, 20, and 21) #260
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: mawad-amd <112003944+mawad-amd@users.noreply.github.com>
|
@copilot sync with main and add all new examples |
Co-authored-by: mawad-amd <112003944+mawad-amd@users.noreply.github.com>
Synced with main branch and added all new examples to documentation. Commit 5011648 includes:
All 20 example directories are now documented in |
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>
There was a problem hiding this 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.mdto include links and descriptions for the new examples - Updates
examples/README.mdto 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 |
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
15_gemm_all_reduce_ring_based: Matrix multiplication with ring-based all-reduce communication pattern16_all_reduce_ring_based: Ring-based all-reduce operation for distributed computing17_gemm_one_shot_all_reduce_pc: Matrix multiplication with one-shot all-reduce using producer-consumer pattern with two distribution modes (striding and block)20_gemm_all_scatter_independent: Independent GEMM and all-scatter operations with support for CSV input configurations (was inexamples/README.mdbut missing fromdocs/reference/examples.md)21_gemm_one_shot_all_reduce_independent: Independent GEMM and all-reduce operations with support for CSV input configurations and selective executionFiles Updated
docs/reference/examples.md: Added links and descriptions for examples 15, 16, 17, 20, and 21 in the GEMM Operations sectionexamples/README.md:Example Usage
The new examples can be run as follows:
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
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.