wrapper.rst

.. meta::
  :description: Composable Kernel documentation and API reference library
  :keywords: composable kernel, CK, ROCm, API, documentation

.. _wrapper:

********************************************************************
Wrapper
********************************************************************

-------------------------------------
Description
-------------------------------------

.. note::

    The wrapper is under development and its functionality is limited.


The CK library provides a lightweight wrapper for more complex operations implemented in 
the library. It allows indexing of nested layouts using a simple interface 
(avoiding complex descriptor transformations) and memory access (using Tensor).

Example:

.. code-block:: c

    const auto shape_4x2x4         = ck::make_tuple(4, ck::make_tuple(2, 4));
    const auto strides_s2x1x8      = ck::make_tuple(2, ck::make_tuple(1, 8));
    const auto layout = ck::wrapper::make_layout(shape_4x2x4, strides_s2x1x8);
    
    std::array<ck::index_t, 32> data;
    auto tensor = ck::wrapper::make_tensor<ck::wrapper::MemoryTypeEnum::Generic>(&data[0], layout);

    for(ck::index_t w = 0; w < size(tensor); w++) {
        tensor(w) = w;
    }

    // slice() == slice(0, -1) (whole dimension)
    auto tensor_slice = tensor(ck::wrapper::slice(1, 3), ck::make_tuple(ck::wrapper::slice(), ck::wrapper::slice()));
    std::cout << "dims:2,(2,4) strides:2,(1,8)" << std::endl;
    for(ck::index_t h = 0; h < ck::wrapper::size<0>(tensor_slice); h++)
    {
        for(ck::index_t w = 0; w < ck::wrapper::size<1>(tensor_slice); w++)
        {
            std::cout << tensor_slice(h, w) << " ";
        }
        std::cout << std::endl;
    }

Output::

    dims:2,(2,4) strides:2,(1,8)
    1 5 9 13 17 21 25 29 
    2 6 10 14 18 22 26 30 


Advanced examples:

* `Image to column <https://github.com/ROCm/composable_kernel/blob/develop/client_example/25_wrapper/wrapper_img2col.cpp>`_

-------------------------------------
Layout
-------------------------------------

.. doxygenstruct:: ck::wrapper::Layout

-------------------------------------
Layout helpers
-------------------------------------

.. doxygenfile:: layout_utils.hpp

-------------------------------------
Tensor
-------------------------------------

.. doxygenstruct:: ck::wrapper::Tensor

-------------------------------------
Tensor helpers
-------------------------------------

.. doxygenfile:: tensor_utils.hpp

.. doxygenfile:: tensor_partition.hpp

-------------------------------------
Operations
-------------------------------------

.. doxygenfile:: copy.hpp