[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 06:49:15 +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/ck_tile/19_gemm_multi_d/README.md
+++ b/example/ck_tile/19_gemm_multi_d/README.md
@@ -1,8 +1,45 @@
-#Multiple D GEMM
+# Multiple D GEMM with CK Tile

-This folder contains example for Multiple D GEMM using ck_tile tile-programming implementation.
+This example demonstrates GEMM with multiple D tensors (multi-output GEMM) using the CK Tile programming model. This is useful for fused operations where the GEMM output is combined with multiple side inputs (e.g., bias, residual, or other elementwise sources).
+
+---
+
+## Algorithm and Math
+
+Given:
+- $A$: $[M, K]$
+- $B$: $[K, N]$
+- $D_0, D_1, ..., D_n$: $[M, N]$ (multiple side inputs)
+- $E$: $[M, N]$ (output)
+
+The operation:
+$$
+E = f(A \times B, D_0, D_1, ..., D_n)
+$$
+where $f$ is a fused elementwise function (e.g., add, multiply, activation).
+
+- **Tilewise Multi-D GEMM**: Each thread block processes a tile of $E$, loading corresponding tiles from $A$, $B$, and all $D_i$, performing blockwise GEMM and fused elementwise operations.
+
+---
+
+## Tile Programming Model
+
+- **Tiles**: Each thread block processes a tile of $E$.
+- **Pipeline**: Modular, supports different memory/computation pipelines and multi-D fusion.
+
+---
+
+## Features
+
+- **Multiple D Inputs**: Supports arbitrary number of side inputs for fusion.
+- **Flexible Layouts**: Supports row/column-major and custom strides for all tensors.
+- **SplitK**: Supports K-batching for large K dimensions.
+- **Validation**: GPU validation and benchmarking options.
+
+---
+
+## Build & Run

-## build
 ```
 #in the root of ck_tile
 mkdir build && cd build
@@ -14,7 +51,8 @@ make tile_example_gemm_multi_d_fp16 -j
 ```
 This will result in an executable `build/bin/tile_example_gemm_multi_d_fp16`

-## example
+### Arguments
+
 ```
 args:
          -m    m dimension (default:3840)
@@ -35,3 +73,25 @@ args:
       -json    0: No Json, 1: Dump Results in Json format (default:0)
   -jsonfile    json file name to dump results (default:cktile_gemm_multi_d_fp16.json)
 ```
+
+---
+
+## Source Structure
+
+- **Kernel**: [`gemm_multi_d_fp16.hpp`](gemm_multi_d_fp16.hpp) (tile-programming kernel template)
+- **Executable**: [`gemm_multi_d_fp16.cpp`](gemm_multi_d_fp16.cpp)
+- **Utils**: [`utils.hpp`](utils.hpp)
+- **Build**: `CMakeLists.txt`, `run_gemm_multi_d_fp16_example.inc`
+
+---
+
+## Related CK Tile Examples
+
+- [03_gemm](../03_gemm/README.md): Single GEMM with tiles
+- [16_batched_gemm](../16_batched_gemm/README.md): Batched GEMM with tiles
+- [17_grouped_gemm](../17_grouped_gemm/README.md): Grouped GEMM with tiles
+
+For distribution, see [`include/ck_tile/tile_engine/`](../../../include/ck_tile/tile_engine/) and [`include/ck_tile/tile_program/tile_distribution/`](../../../include/ck_tile/tile_program/tile_distribution/).
+
+---
+[Back to CK Tile Examples](../README.md)