mirror of
https://github.com/ROCm/composable_kernel.git
synced 2026-03-23 08:37:39 +00:00
a426f67301
* creation of install doc and refactor of doc in general * updates based on review comments * updated based on review comments * updated readme and contributors markdown * added extra note to not use -j on its own * added note about smoke tests and regression tests * made changes as per Illia's feedback --------- Co-authored-by: Aviral Goel <aviral.goel@amd.com>
90 lines
2.7 KiB
ReStructuredText
90 lines
2.7 KiB
ReStructuredText
.. meta::
|
|
:description: Composable Kernel wrapper
|
|
:keywords: composable kernel, CK, ROCm, API, wrapper
|
|
|
|
.. _wrapper:
|
|
|
|
********************************************************************
|
|
Composable Kernel wrapper
|
|
********************************************************************
|
|
|
|
|
|
The Composable Kernel library provides a lightweight wrapper to simplify the more complex operations.
|
|
|
|
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
|
|
|
|
|
|
Tutorials:
|
|
|
|
* `GEMM tutorial <https://github.com/ROCm/composable_kernel/blob/develop/client_example/25_wrapper/README.md>`_
|
|
|
|
Advanced examples:
|
|
|
|
* `Image to column <https://github.com/ROCm/composable_kernel/blob/develop/client_example/25_wrapper/wrapper_img2col.cpp>`_
|
|
* `Basic gemm <https://github.com/ROCm/composable_kernel/blob/develop/client_example/25_wrapper/wrapper_basic_gemm.cpp>`_
|
|
* `Optimized gemm <https://github.com/ROCm/composable_kernel/blob/develop/client_example/25_wrapper/wrapper_optimized_gemm.cpp>`_
|
|
|
|
-------------------------------------
|
|
Layout
|
|
-------------------------------------
|
|
|
|
.. doxygenstruct:: Layout
|
|
|
|
-------------------------------------
|
|
Layout helpers
|
|
-------------------------------------
|
|
|
|
.. doxygenfile:: include/ck/wrapper/utils/layout_utils.hpp
|
|
|
|
-------------------------------------
|
|
Tensor
|
|
-------------------------------------
|
|
|
|
.. doxygenstruct:: Tensor
|
|
|
|
-------------------------------------
|
|
Tensor helpers
|
|
-------------------------------------
|
|
|
|
.. doxygenfile:: include/ck/wrapper/utils/tensor_utils.hpp
|
|
|
|
.. doxygenfile:: include/ck/wrapper/utils/tensor_partition.hpp
|
|
|
|
-------------------------------------
|
|
Operations
|
|
-------------------------------------
|
|
|
|
.. doxygenfile:: include/ck/wrapper/operations/copy.hpp
|
|
.. doxygenfile:: include/ck/wrapper/operations/gemm.hpp
|