[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/34_batchnorm/README.md
+++ b/example/34_batchnorm/README.md
@@ -1,4 +1,39 @@
-# Instructions for ```batchnorm nhwc``` Example
+# Batch Normalization Forward
+
+## Theory
+
+This example demonstrates **batch normalization forward pass**. Batch normalization is used in deep neural networks to normalize activations across the batch dimension, improving training stability and convergence.
+
+**Mathematical Formulation:**
+Given input $X[N, C, ...]$:
+- Mean: $\mu_c = \frac{1}{N \cdot ...} \sum_{n,...} X_{n,c,...}$
+- Variance: $\sigma^2_c = \frac{1}{N \cdot ...} \sum_{n,...} (X_{n,c,...} - \mu_c)^2$
+- Normalized: $\hat{X}_{n,c,...} = \frac{X_{n,c,...} - \mu_c}{\sqrt{\sigma^2_c + \epsilon}}$
+- Output: $Y_{n,c,...} = \gamma_c \hat{X}_{n,c,...} + \beta_c$
+
+$\gamma_c$, $\beta_c$ are learnable scale and shift parameters per channel.
+
+**Algorithmic Background:**
+- Computes mean and variance per channel (across batch and spatial dimensions).
+- Applies normalization and affine transformation.
+- Used in CNNs, MLPs, and other deep learning models.
+
+## 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/34_batchnorm
+mkdir build && cd build
+cmake -DCMAKE_CXX_COMPILER=/opt/rocm/bin/hipcc ..
+make -j
+
+# Example run
+./batchnorm_fwd_xdl --verify=1 --time=1
+```

 ## Run ```batchnorm forward nhwc```
 ```bash
@@ -79,3 +114,26 @@ Warm up 1 time
 Start running 10 times...
 Perf: 0.411026 ms, 91.8702 GB/s
 ```
+
+## Source Code Structure
+
+### Directory Layout
+```
+example/34_batchnorm/
+├── batchnorm_fwd_xdl.cpp         # Main example: sets up, runs, and verifies batchnorm
+include/ck/tensor_operation/gpu/device/
+│   └── device_batchnorm_fwd.hpp       # Device-level batchnorm API
+include/ck/tensor_operation/gpu/device/impl/
+│   └── device_batchnorm_fwd_impl.hpp  # Implementation
+include/ck/tensor_operation/gpu/grid/
+    └── gridwise_batchnorm_fwd.hpp     # Grid-level kernel
+```
+
+### Key Classes and Functions
+
+- **DeviceBatchnormFwd** (in `device_batchnorm_fwd.hpp`):  
+  Device API for batch normalization.
+- **gridwise_batchnorm_fwd** (in `gridwise_batchnorm_fwd.hpp`):  
+  Implements the tiled/blocking batchnorm kernel.
+
+This example demonstrates how Composable Kernel implements efficient batch normalization for deep learning models.