mirror of
https://github.com/ROCm/composable_kernel.git
synced 2026-06-30 11:47:48 +00:00
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
FLATMM Matrix Multiplication with CK Tile
This example demonstrates FLATMM (flattened matrix multiplication) using the CK Tile programming model. FLATMM is a variant of GEMM optimized for certain memory layouts and batch processing patterns. Currently, it only supports the basic feature of the CK Tile FLATMM, but creates the placeholders for the future support on different FLATMM pipeline and different FLATMM modules. In the near future, we will gradually migrate all the FLATMM features from old CK to CK Tile.
Algorithm and Math
Given:
A:[\text{batch}, M, K]B:[\text{batch}, K, N]C:[\text{batch}, M, N]
For each batch b:
C^{(b)} = A^{(b)} \times B^{(b)}
- Tilewise FLATMM: Each thread block processes a tile of
Cfor a specific batch, loading corresponding tiles fromAandB, performing blockwise matrix multiply-accumulate, and writing results. FLATMM may use flattened or packed memory layouts for improved memory access.
Tile Programming Model
- Tiles: Each thread block processes a tile of
Cfor a given batch. - Pipeline: Modular, supports different memory/computation pipelines and flat/padded layouts.
Features
- Flexible Layouts: Supports row/column-major and custom strides for
A,B,C. - Batching: Efficiently computes multiple GEMMs in parallel.
- Precision: Supports fp16, bf16, fp8, bf8.
- Validation: CPU/GPU validation and error tolerance options.
Build & Run
# in the root of ck_tile
mkdir build && cd build
# you can replace <arch> with the appropriate architecture (for example gfx90a or gfx942) or leave it blank
../script/cmake-ck-dev.sh ../ <arch>
# The basic pipeline method on the flatmm calculation
make tile_example_flatmm_basic -j
This will result in an executable build/bin/tile_example_flatmm_basic
Arguments
args:
-m m dimension (default:256)
-n n dimension (default:256)
-k k dimension (default:128)
-a_layout A tensor data layout - Row by default (default:R)
-b_layout B tensor data layout - Row by default (default:C)
-c_layout C tensor data layout - Row by default (default:R)
-stride_a Tensor A stride (default:0)
-stride_b Tensor B stride (default:0)
-stride_c Tensor C stride (default:0)
-v 0. No validation, 1. Validation on CPU, 2. Validation on GPU (default:1)
-prec data type. fp16/bf16/fp8/bf8 (default:fp16)
-warmup number of iterations before benchmark the kernel (default:50)
-repeat number of iterations to benchmark the kernel (default:100)
-timer gpu:gpu timer, cpu:cpu timer (default:gpu)
-split_k splitK value (default:1)
-init 0:random, 1:linear, 2:constant(1) (default:0)
-warp_tile 0: 16x16, 1: 32x32, 2: 16x16x128 (950 only), 3: 32x32x64 (950 only) (default:0)
-json 0: No Json, 1: Dump Results in Json format (default:0)
-jsonfile json file name to dump results (default:flatmm_basic.json)
Source Structure
- Kernel:
flatmm_basic.hpp(tile-programming kernel template) - Executable:
flatmm_basic.cpp - Build:
CMakeLists.txt,run_flatmm_example.inc,script/
Related CK Tile Examples
- 16_batched_gemm: Batched GEMM with tiles
- 03_gemm: Single GEMM with tiles
- 17_grouped_gemm: Grouped GEMM with tiles
For distribution, see include/ck_tile/tile_program/tile_distribution/.