Files
composable_kernel/client_example/27_im2col_col2im/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.3 KiB

Client Example: im2col and col2im Transformations

Theory

This client example demonstrates im2col (image-to-column) and col2im (column-to-image) transformations. These operations are used to convert image data into a matrix form suitable for GEMM-based convolution and reconstruct images from column representations.

Mathematical Formulation:

  • im2col: Rearranges image blocks into columns, mapping a 3D/4D tensor to a 2D matrix.
  • col2im: Reverses the process, mapping a 2D matrix back to an image tensor.

Algorithmic Background:

  • im2col is used to lower convolution to matrix multiplication (GEMM).
  • col2im is used to reconstruct the original image or feature map from the column representation.
  • These transformations are essential for efficient convolution implementations on GPUs.

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/27_im2col_col2im
mkdir build && cd build
cmake -DCMAKE_CXX_COMPILER=/opt/rocm/bin/hipcc ..
make -j

# Example run (image to column)
./image_to_column

# Example run (column to image)
./column_to_image

Source Code Structure

Directory Layout

client_example/27_im2col_col2im/
├── image_to_column.cpp         # im2col: image to column transformation
├── column_to_image.cpp         # col2im: column to image transformation
├── CMakeLists.txt              # Build configuration for the example

Key Functions

  • main() (in each .cpp):
    Sets up input tensors, configures transformation parameters, launches the im2col or col2im kernel, and verifies the result.
  • im2col/col2im kernel invocation:
    Uses the Composable Kernel device API to launch the transformation.

Additional Details

  • Supports various image and patch sizes.
  • Example parameters can be adjusted in the source for different workloads.


Back to Client Examples