[DOCS] Documentation Addition (Readme updates) (#2495)

* GH-2368 Adding a basic glossary GH-2368 Minor edits GH-2368 Adding missing READMEs and standardization. resolving readme updates GH-2368 Minor improvements to documentation. Improving some readmes. Further improvement for readmes. Cleaned up the documentation in 'client_example' (#2468) Update for PR Update ACRONYMS.md to remove trivial terms Update ACRONYMS.md to provide detailed explanations for BF16 and BF8 formats Apply suggestion from @spolifroni-amd Co-authored-by: spolifroni-amd <Sandra.Polifroni@amd.com> Apply suggestion from @spolifroni-amd Co-authored-by: spolifroni-amd <Sandra.Polifroni@amd.com> Update README.md to clarify CK Tile API description and remove outdated references to the Tile Engine. revise 37_transpose readme revise 36_copy readme Remove references to the Tile Engine in README files for 19_gemm_multi_d and 35_batched_transpose, and update distribution links for clarity. Remove references to the Tile Engine in multiple README files and update distribution links for consistency and clarity. Remove references to the Tile Engine in README files across multiple examples * GH-2368 Adding a basic glossary GH-2368 Minor edits GH-2368 Adding missing READMEs and standardization. resolving readme updates GH-2368 Minor improvements to documentation. Improving some readmes. Further improvement for readmes. Cleaned up the documentation in 'client_example' (#2468) Update for PR Update ACRONYMS.md to remove trivial terms Update ACRONYMS.md to provide detailed explanations for BF16 and BF8 formats Apply suggestion from @spolifroni-amd Co-authored-by: spolifroni-amd <Sandra.Polifroni@amd.com> Apply suggestion from @spolifroni-amd Co-authored-by: spolifroni-amd <Sandra.Polifroni@amd.com> Update README.md to clarify CK Tile API description and remove outdated references to the Tile Engine. revise 37_transpose readme revise 36_copy readme Remove references to the Tile Engine in README files for 19_gemm_multi_d and 35_batched_transpose, and update distribution links for clarity. Remove references to the Tile Engine in multiple README files and update distribution links for consistency and clarity. Remove references to the Tile Engine in README files across multiple examples Refine README files by removing outdated references to the Tile Engine * Updates based on PR feedback 1 * Updates based on PR feedback 2 * Updates based on PR feedback 3 * Updates based on PR feedback 4 * Updates based on PR feedback 5 * Updates based on PR feedback 6 * Updates based on PR feedback 7 * Updates based on PR feedback 8 * Content Modification of CK Tile Example * Modify the ck_tile gemm config --------- Co-authored-by: AviralGoelAMD <aviral.goel@amd.com> Co-authored-by: ThomasNing <thomas.ning@amd.com>
2026-04-20 14:59:17 +00:00 · 2025-10-16 03:10:57 -07:00
parent 013ba3c737
commit 92c67a824f
120 changed files with 8188 additions and 221 deletions
--- a/example/24_batched_gemm/README.md
+++ b/example/24_batched_gemm/README.md
@@ -0,0 +1,57 @@
+# Batched GEMM
+
+## Theory
+
+This example demonstrates **batched GEMM**: performing multiple independent matrix multiplications (all with the same shape) in a single kernel launch. Batched GEMM is used in multi-head attention, RNNs, and other models requiring parallel matrix multiplications.
+
+**Mathematical Formulation:**
+For $B$ batches:
+$$
+C_b = A_b \times B_b \quad \text{for} \quad b = 1, 2, ..., B
+$$
+- $A_b$: [M, K] input matrix for batch $b$
+- $B_b$: [K, N] weight matrix for batch $b$
+- $C_b$: [M, N] output matrix for batch $b$
+
+**Algorithmic Background:**
+- All matrices in the batch have the same shape and strides.
+- The kernel launches a grid covering all batches, with each block assigned to a batch.
+- Used for multi-head attention, parallel MLPs, and more.
+
+## How to Run
+
+### Prerequisites
+
+Please follow the instructions in the main [Build Guide](../../README.md#building-ck) section as a prerequisite to building and running this example.
+
+### Build and run
+```bash
+cd composable_kernel/example/24_batched_gemm
+mkdir build && cd build
+cmake -DCMAKE_CXX_COMPILER=/opt/rocm/bin/hipcc ..
+make -j
+
+# Example run
+./batched_gemm_xdl --verify=1 --time=1
+```
+
+## Source Code Structure
+
+### Directory Layout
+```
+example/24_batched_gemm/
+├── batched_gemm_xdl.cpp         # Main example: sets up, runs, and verifies batched GEMM
+include/ck/tensor_operation/gpu/device/
+│   └── device_batched_gemm_xdl.hpp       # Device-level batched GEMM API
+include/ck/tensor_operation/gpu/grid/
+│   └── gridwise_batched_gemm_xdl.hpp     # Grid-level batched GEMM kernel
+```
+
+### Key Classes and Functions
+
+- **DeviceBatchedGemmXdl** (in `device_batched_gemm_xdl.hpp`):  
+  Device API for batched GEMM.
+- **gridwise_batched_gemm_xdl** (in `gridwise_batched_gemm_xdl.hpp`):  
+  Implements the tiled/blocking batched GEMM kernel.
+
+This example demonstrates how Composable Kernel supports efficient parallel matrix multiplication for batched and multi-head workloads.