mirror of
https://github.com/ROCm/composable_kernel.git
synced 2026-03-28 02:57:42 +00:00
92c67a824f
* 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>
60 lines
2.5 KiB
Markdown
60 lines
2.5 KiB
Markdown
# Elementwise Operation with Permutation Fusion
|
|
|
|
## Theory
|
|
|
|
This example demonstrates **elementwise operations fused with tensor permutation**. This pattern is used in deep learning for applying activation functions or scaling while simultaneously reordering tensor dimensions (e.g., NCHW to NHWC).
|
|
|
|
**Mathematical Formulation:**
|
|
- Elementwise: $Z = f(X)$ or $Z = f(X, Y)$
|
|
- Permute: $Y_{i_{p_0}, i_{p_1}, ..., i_{p_{n-1}}} = Z_{i_0, i_1, ..., i_{n-1}}$
|
|
- $P = [p_0, p_1, ..., p_{n-1}]$ is the permutation pattern
|
|
|
|
**Algorithmic Background:**
|
|
- The elementwise operation and permutation are fused in a single kernel.
|
|
- Intermediate results are kept in registers, not written to global memory.
|
|
- Used for layout conversion with activation, attention head reshaping, 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/44_elementwise_permute
|
|
mkdir build && cd build
|
|
cmake -DCMAKE_CXX_COMPILER=/opt/rocm/bin/hipcc ..
|
|
make -j
|
|
|
|
# Example run (ReLU + NCHW to NHWC)
|
|
./elementwise_permute_xdl --input_shape=32,128,56,56 --permutation=0,2,3,1 --operation=relu --verify=1 --time=1
|
|
```
|
|
|
|
## Source Code Structure
|
|
|
|
### Directory Layout
|
|
```
|
|
example/44_elementwise_permute/
|
|
├── elementwise_permute_xdl.cpp # Main example: sets up, runs, and verifies elementwise+permute
|
|
include/ck/tensor_operation/gpu/device/
|
|
│ └── device_elementwise_permute.hpp # Device-level API for fused elementwise+permute
|
|
include/ck/tensor_operation/gpu/device/impl/
|
|
│ └── device_elementwise_permute_impl.hpp # Implementation
|
|
include/ck/tensor_operation/gpu/grid/
|
|
│ └── gridwise_elementwise_permute.hpp # Grid-level kernel
|
|
include/ck/tensor_operation/gpu/element/
|
|
└── element_wise_operation.hpp # Elementwise operation definitions
|
|
```
|
|
|
|
### Key Classes and Functions
|
|
|
|
- **DeviceElementwisePermute** (in `device_elementwise_permute.hpp`):
|
|
Device API for fused elementwise and permutation.
|
|
- **gridwise_elementwise_permute** (in `gridwise_elementwise_permute.hpp`):
|
|
Implements the tiled/blocking elementwise+permute kernel.
|
|
- **element_wise_operation** (in `element_wise_operation.hpp`):
|
|
Defines elementwise operations (e.g., relu, scale).
|
|
|
|
This example demonstrates how Composable Kernel supports efficient fusion of elementwise operations and tensor permutation for deep learning and data layout transformations.
|