Files
composable_kernel/client_example/13_batchnorm/README.md
Vidyasagar Ananthan 92c67a824f [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>
2025-10-16 03:10:57 -07:00

2.5 KiB

Client Example: Batch Normalization (Forward, Backward, Inference)

Theory

This client example demonstrates batch normalization in forward, backward, and inference modes for NHWC tensors. Batch normalization is used in deep neural networks to normalize activations across the batch and spatial dimensions, improving training stability and convergence.

Mathematical Formulation: Given input X[N, H, W, C]:

  • Mean: \mu_c = \frac{1}{NHW} \sum_{n,h,w} X_{n,h,w,c}
  • Variance: \sigma^2_c = \frac{1}{NHW} \sum_{n,h,w} (X_{n,h,w,c} - \mu_c)^2
  • Normalized: \hat{X}_{n,h,w,c} = \frac{X_{n,h,w,c} - \mu_c}{\sqrt{\sigma^2_c + \epsilon}}
  • Output: Y_{n,h,w,c} = \gamma_c \hat{X}_{n,h,w,c} + \beta_c

\gamma_c, \beta_c are learnable scale and shift parameters per channel.

Algorithmic Background:

  • Forward pass computes mean, variance, normalization, and affine transformation.
  • Backward pass computes gradients with respect to input, gamma, and beta.
  • Inference uses running mean and variance for normalization.

How to Run

Prerequisites

Please follow the instructions in the main Build Guide section as a prerequisite to building and running this example.

Build and run

cd composable_kernel/client_example/13_batchnorm
mkdir build && cd build
cmake -DCMAKE_CXX_COMPILER=/opt/rocm/bin/hipcc ..
make -j

# Example run (forward)
./batchnorm_fwd_nhwc

# Example run (backward)
./batchnorm_bwd_nhwc

# Example run (inference)
./batchnorm_infer_nhwc

Source Code Structure

Directory Layout

client_example/13_batchnorm/
├── batchnorm_fwd_nhwc.cpp         # Batchnorm forward (NHWC)
├── batchnorm_bwd_nhwc.cpp         # Batchnorm backward (NHWC)
├── batchnorm_infer_nhwc.cpp       # Batchnorm inference (NHWC)
├── CMakeLists.txt                 # Build configuration for the example

Key Functions

  • main() (in each .cpp):
    Sets up input tensors, configures batchnorm parameters, launches the forward, backward, or inference kernel, and verifies the result.
  • BatchNorm kernel invocation:
    Uses the Composable Kernel device API to launch batch normalization for different modes.

Additional Details

  • Supports NHWC layout for image and vision models.
  • Example parameters can be adjusted in the source for different workloads.

  • 34_batchnorm: Batch normalization in the main example directory

Back to Client Examples