Skip to content

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.

Sign up for GitHub

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add new examples to documentation (15, 16, 17, 20, and 21) #260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7d805eb
Initial plan
Copilot Oct 19, 2025
3823694
Add examples 15, 16, and 20 to documentation
Copilot Oct 19, 2025
5011648
Merge main and add examples 17 and 21 to documentation
Copilot Oct 19, 2025
c16ab23
Merge branch 'main' into copilot/add-examples-to-docs
mawad-amd Oct 19, 2025
79b6d6c
Add README.md files for new examples (15, 16, 17, 20, 21)
Copilot Oct 19, 2025
5f98d70
Revert individual example README files - examples/README.md already u…
Copilot Oct 19, 2025
70dba8d
Merge branch 'main' of https://github.com/ROCm/iris into copilot/add-…
Copilot Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/reference/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ We've curated a growing collection of practical examples that showcase the power
- **[12_gemm_all_scatter_bulk_synchronous](https://github.com/ROCm/iris/tree/main/examples/12_gemm_all_scatter_bulk_synchronous)**: Matrix multiplication with all-scatter using the bulk synchronous parallel approach
- **[13_flash_decode](https://github.com/ROCm/iris/tree/main/examples/13_flash_decode)**: Fused Flash Decode Attention for accelerating LLM inference
- **[14_all_gather_gemm](https://github.com/ROCm/iris/tree/main/examples/14_all_gather_gemm)**: Fused All-Gather + GEMM with Pull and Push models
- **[15_gemm_all_reduce_ring_based](https://github.com/ROCm/iris/tree/main/examples/15_gemm_all_reduce_ring_based)**: Matrix multiplication with ring-based all-reduce
- **[16_all_reduce_ring_based](https://github.com/ROCm/iris/tree/main/examples/16_all_reduce_ring_based)**: Ring-based all-reduce operation
- **[17_gemm_one_shot_all_reduce_pc](https://github.com/ROCm/iris/tree/main/examples/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)
- **[20_gemm_all_scatter_independent](https://github.com/ROCm/iris/tree/main/examples/20_gemm_all_scatter_independent)**: Independent GEMM and all-scatter operations with support for CSV input configurations
- **[21_gemm_one_shot_all_reduce_independent](https://github.com/ROCm/iris/tree/main/examples/21_gemm_one_shot_all_reduce_independent)**: Independent GEMM and all-reduce operations with support for CSV input configurations and selective execution

### Utilities
- **[benchmark](https://github.com/ROCm/iris/tree/main/examples/benchmark)**: Benchmarking utilities and performance testing tools
Expand Down
6 changes: 6 additions & 0 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,12 @@ python examples/14_all_gather_gemm/example_run_pull.py --num_ranks 8
# All-Gather + GEMM - Push model
python examples/14_all_gather_gemm/example_run_push.py --num_ranks 8

# Example command to run benchmark with ring-based all-reduce for GEMM
python examples/15_gemm_all_reduce_ring_based/benchmark.py --benchmark --validate --num_ranks 8

# Example command to run benchmark with ring-based all-reduce
python examples/16_all_reduce_ring_based/benchmark.py --benchmark --validate --num_ranks 8

# Independent GEMM and all-scatter - single configuration
python examples/20_gemm_all_scatter_independent/benchmark.py --benchmark --validate --num_ranks 8

Expand Down
Loading