Unverified Commit a3916381 authored by randyh62's avatar randyh62 Committed by GitHub
Browse files

doc reorg and edits (#1112)



* doc reorg and edits

* Update wrapper.rst with changes from PR #1098

* Update docs/dockerhub.rst
Co-authored-by: default avatarBartlomiej Wroblewski <bwroblewski10@gmail.com>

* Update docs/index.rst
Co-authored-by: default avatarBartlomiej Wroblewski <bwroblewski10@gmail.com>

* Update docs/what-is-ck.rst
Co-authored-by: default avatarBartlomiej Wroblewski <bwroblewski10@gmail.com>

* Update docs/what-is-ck.rst

Restored to 4 bullets, with additional text for wrapper.
Co-authored-by: default avatarBartlomiej Wroblewski <bwroblewski10@gmail.com>

* Update docs/Contributors_Guide.rst
Co-authored-by: default avatarLisa <lisajdelaney@gmail.com>

* Update API_Reference_Guide.rst

using sentence case for title

* updated index structure per Lisa

* separate docker hub and tutorial

---------
Co-authored-by: default avatarBartlomiej Wroblewski <bwroblewski10@gmail.com>
Co-authored-by: default avatarLisa <lisajdelaney@gmail.com>
Co-authored-by: default avatarIllia Silin <98187287+illsilin@users.noreply.github.com>
parent 61545bda
.. meta::
:description: Composable Kernel documentation and API reference library
:keywords: composable kernel, CK, ROCm, API, documentation
******************* .. _api-reference:
API Reference Guide
******************* ********************************************************************
API reference guide
********************************************************************
=================
Introduction
=================
This document contains details of the APIs for the Composable Kernel (CK) library and introduces This document contains details of the APIs for the Composable Kernel (CK) library and introduces
some of the key design principles that are used to write new classes that extend CK functionality. some of the key design principles that are used to write new classes that extend CK functionality.
...@@ -30,7 +32,7 @@ DeviceMem ...@@ -30,7 +32,7 @@ DeviceMem
Kernels For Flashattention Kernels For Flashattention
--------------------------- ---------------------------
The Flashattention algorithm is defined in :cite:t:`dao2022flashattention`. This sections lists The Flashattention algorithm is defined in :cite:t:`dao2022flashattention`. This section lists
the classes that are used in the CK GPU implementation of Flashattention. the classes that are used in the CK GPU implementation of Flashattention.
**Gridwise classes** **Gridwise classes**
......
=================== .. meta::
Contributor's Guide :description: Composable Kernel documentation and API reference library
=================== :keywords: composable kernel, CK, ROCm, API, documentation
.. _contributing-to:
********************************************************************
Contributor's guide
********************************************************************
This chapter explains how to get started contributing to the Composable Kernel project and what are This chapter explains the rules for contributing to the Composable Kernel project, and how to contribute.
the contributing rules.
Getting started Getting started
=============== ===============
...@@ -14,23 +19,21 @@ Getting started ...@@ -14,23 +19,21 @@ Getting started
build the library. You can also find some of this information in the build the library. You can also find some of this information in the
`README file <https://github.com/ROCmSoftwarePlatform/composable_kernel/blob/develop/README.md>`_ `README file <https://github.com/ROCmSoftwarePlatform/composable_kernel/blob/develop/README.md>`_
on the project's GitHub page. on the project's GitHub page.
#. **Additional reading:** We also recommend reading a `blog post #. **Additional reading:** The blog post `AMD Composable Kernel library: efficient fused kernels for AI apps with just a few lines of code <https://community.amd.com/t5/instinct-accelerators/amd-composable-kernel-library-efficient-fused-kernels-for-ai/ba-p/553224>`_ provides a deeper understanding of the CK library and showcases its performance capabilities.
<https://community.amd.com/t5/instinct-accelerators/amd-composable-kernel-library-efficient-fused-kernels-for-ai/ba-p/553224>`_ <https://community.amd.com/t5/instinct-accelerators/amd-composable-kernel-library-efficient-fused-kernels-for-ai/ba-p/553224>`_
from the AMD Community portal. It offers a deeper understanding of the library's objectives and from the AMD Community portal. It offers a deeper understanding of the library's objectives and showcases its performance capabilities.
showcases its performance capabilities.
#. **General information:** For broader information about AMD products, consider exploring the #. **General information:** For broader information about AMD products, consider exploring the
`AMD Developer Central portal <https://www.amd.com/en/developer.html>`_. `AMD Developer Central portal <https://www.amd.com/en/developer.html>`_.
How do I contribute How to contribute
=================== ===================
We deeply value contributions from our users. You can make an impact by reporting issues or You can make an impact by reporting issues or proposing code enhancements through pull requests.
proposing code enhancements through pull requests.
Reporting issues Reporting issues
---------------- ----------------
We use `Github issues <https://github.com/ROCmSoftwarePlatform/composable_kernel/issues>`_ Use `Github issues <https://github.com/ROCmSoftwarePlatform/composable_kernel/issues>`_
to track public bugs and enhancement requests. to track public bugs and enhancement requests.
If you encounter an issue with the library, please check if the problem has already been If you encounter an issue with the library, please check if the problem has already been
...@@ -59,7 +62,7 @@ issue. All reported issues must include: ...@@ -59,7 +62,7 @@ issue. All reported issues must include:
* How frequently does this issue happen? Does it reproduce every time? Or is it a sporadic issue? * How frequently does this issue happen? Does it reproduce every time? Or is it a sporadic issue?
Before sumbitting any issue, ensure you have addressed all relevant questions from the checklist. Before submitting any issue, ensure you have addressed all relevant questions from the checklist.
Creating Pull Requests Creating Pull Requests
---------------------- ----------------------
...@@ -68,7 +71,7 @@ You can submit `Pull Requests (PR) on GitHub ...@@ -68,7 +71,7 @@ You can submit `Pull Requests (PR) on GitHub
<https://github.com/ROCmSoftwarePlatform/composable_kernel/pulls>`_. <https://github.com/ROCmSoftwarePlatform/composable_kernel/pulls>`_.
All contributors are required to develop their changes on a separate branch and then create a All contributors are required to develop their changes on a separate branch and then create a
pull requrest to merge their changes into the `develop` branch, which is the default pull request to merge their changes into the `develop` branch, which is the default
development branch in the Composable Kernel project. All external contributors must use their own development branch in the Composable Kernel project. All external contributors must use their own
forks of the project to develop their changes. forks of the project to develop their changes.
...@@ -99,4 +102,4 @@ When submitting a Pull Request you should: ...@@ -99,4 +102,4 @@ When submitting a Pull Request you should:
Following the above guidelines ensures a seamless review process and faster assistance from our Following the above guidelines ensures a seamless review process and faster assistance from our
end. end.
Thank you for your commitment to enhancing the Composable Kernel project! We look forward to collaborating with you. Thank you for your commitment to enhancing the Composable Kernel project!
========================== .. meta::
:description: Composable Kernel documentation and API reference library
:keywords: composable kernel, CK, ROCm, API, documentation
.. _supported-primitives:
********************************************************************
Supported Primitives Guide Supported Primitives Guide
========================== ********************************************************************
This document contains details of supported primitives in Composable Kernel (CK). In contrast to the This document contains details of supported primitives in Composable Kernel (CK). In contrast to the API Reference Guide, the Supported Primitives Guide is an introduction to the math which underpins the algorithms implemented in CK.
API Reference Guide, the Supported Primitives Guide is an introduction to the math which underpins
the algorithms implemented in CK.
------------ ------------
Softmax Softmax
------------ ------------
For vectors :math:`x^{(1)}, x^{(2)}, \ldots, x^{(T)}` of size :math:`B` we can decompose the For vectors :math:`x^{(1)}, x^{(2)}, \ldots, x^{(T)}` of size :math:`B` you can decompose the
softmax of concatenated :math:`x = [ x^{(1)}\ | \ \ldots \ | \ x^{(T)} ]` as, softmax of concatenated :math:`x = [ x^{(1)}\ | \ \ldots \ | \ x^{(T)} ]` as,
.. math:: .. math::
...@@ -27,7 +31,7 @@ where :math:`f(x^{(j)}) = \exp( x^{(j)} - m(x^{(j)}) )` is of size :math:`B` and ...@@ -27,7 +31,7 @@ where :math:`f(x^{(j)}) = \exp( x^{(j)} - m(x^{(j)}) )` is of size :math:`B` and
:math:`z(x^{(j)}) = f(x_1^{(j)})+ \ldots+ f(x_B^{(j)})` is a scalar. :math:`z(x^{(j)}) = f(x_1^{(j)})+ \ldots+ f(x_B^{(j)})` is a scalar.
For a matrix :math:`X` composed of :math:`T_r \times T_c` tiles, :math:`X_{ij}`, of size For a matrix :math:`X` composed of :math:`T_r \times T_c` tiles, :math:`X_{ij}`, of size
:math:`B_r \times B_c` we can compute the row-wise softmax as follows. :math:`B_r \times B_c` you can compute the row-wise softmax as follows.
For :math:`j` from :math:`1` to :math:`T_c`, and :math:`i` from :math:`1` to :math:`T_r` calculate, For :math:`j` from :math:`1` to :math:`T_c`, and :math:`i` from :math:`1` to :math:`T_r` calculate,
......
=================== .. meta::
:description: Composable Kernel documentation and API reference library
:keywords: composable kernel, CK, ROCm, API, documentation
.. _docker-hub:
********************************************************************
CK Docker Hub CK Docker Hub
=================== ********************************************************************
-------------------------------------
Why do I need this? Why do I need this?
------------------------------------- ===================
To make things simpler, and bring Composable Kernel and its dependencies together,
docker images can be found on `Docker Hub <https://hub.docker.com/r/rocm/composable_kernel/tags>`_. Docker images provide a complete image of the OS, the Composable Kernel library, and its dependencies in a single downloadable file.
Refer to `Docker Overview <https://docs.docker.com/get-started/overview/>`_ for more information on Docker images and containers.
Which image is right for me?
============================
The image naming includes information related to the docker image.
For example ``ck_ub20.04_rocm6.0`` indicates the following:
* ``ck`` - made for running Composable Kernel;
* ``ub20.04`` - based on Ubuntu 20.04;
* ``rocm6.0`` - ROCm platform version 6.0.
To make our lives easier and bring Composable Kernel dependencies together, we recommend using Download a docker image suitable for your OS and ROCm release, run or start the docker container, and then resume the tutorial from this point. Use the ``docker pull`` command to download the file::
docker images that can be found on `Docker Hub <https://hub.docker.com/r/rocm/composable_kernel>`_.
------------------------------------- docker pull rocm/composable_kernel:ck_ub20.04_rocm6.0
So what is Composable Kernel?
-------------------------------------
Composable Kernel (CK) library aims to provide a programming model for writing performance critical
kernels for machine learning workloads across multiple architectures including GPUs, CPUs, etc,
through general purpose kernel languages, like HIP C++.
To get the CK library:: What is inside the image?
-------------------------
git clone https://github.com/ROCmSoftwarePlatform/composable_kernel.git The docker images have everything you need for running CK including:
* `ROCm <https://www.amd.com/en/graphics/servers-solutions-rocm>`_
* `CMake <https://cmake.org/getting-started/>`_
* `Compiler <https://github.com/RadeonOpenCompute/llvm-project>`_
* `Composable Kernel library <https://github.com/ROCm/composable_kernel>`_
Running the docker container
============================
run a docker container:: After downloading the docker image, you can start the container using one of a number of commands. Start with the ``docker run`` command as shown below::
docker run \ docker run \
-it \ -it \
...@@ -33,67 +55,47 @@ run a docker container:: ...@@ -33,67 +55,47 @@ run a docker container::
rocm/composable_kernel:ck_ub20.04_rocm6.0 \ rocm/composable_kernel:ck_ub20.04_rocm6.0 \
/bin/bash /bin/bash
and build the CK:: After starting the bash shell, the docker container current folder is `~/workspace`. The library path is ``~/workspace/composable_kernel``. Navigate to the library to begin the tutorial as explained in :ref:`hello-world`:
mkdir build && cd build .. note::
# Need to specify target ID, example below is for gfx908 and gfx90a
cmake \
-D CMAKE_PREFIX_PATH=/opt/rocm \
-D CMAKE_CXX_COMPILER=/opt/rocm/bin/hipcc \
-D CMAKE_CXX_FLAGS="-O3" \
-D CMAKE_BUILD_TYPE=Release \
-D GPU_TARGETS="gfx908;gfx90a" \
..
and:: If your current folder is different from `${HOME}`, adjust the line ``-v ${HOME}:/root/workspace`` in the ``docker run`` command to fit your folder structure.
make -j examples tests Stop and restart the docker image
=================================
To run all the test cases including tests and examples run:: After finishing the tutorial, or just when you have completed your work session, you can close the docker container, or stop the docker container to restart it at another time. Closing the docker container means that it is still in the active state, and can be resumed from where you left it. Stopping the container closes it, and returns the image to its initial state.
make test Use the ``Ctrl-D`` option to exit the container, while leaving it active, so you can return to the container in its current state to resume the tutorial, or pickup your project where you left off.
We can also run specific examples or tests like:: To restart the active container use the ``docker exec`` command to specify the container name and options as follows::
./bin/example_gemm_xdl_fp16 docker exec -it <container_name> bash
./bin/test_gemm_fp16
For more details visit `CK github repository <https://github.com/ROCmSoftwarePlatform/composable_kernel>`_, Where:
`CK examples <https://github.com/ROCmSoftwarePlatform/composable_kernel/tree/develop/example)>`_,
`even more CK examples <https://github.com/ROCmSoftwarePlatform/composable_kernel/tree/develop/client_example>`_.
------------------------------------- * `exec` is the docker command
And what is inside? * `-it` is the interactive option for `exec`
------------------------------------- * `<container_name>` specifies an active container on the system
* `bash` specifies the command to run in the interactive shell
The docker images have everything you need for running CK including: .. note::
* `ROCm <https://www.amd.com/en/graphics/servers-solutions-rocm>`_
* `CMake <https://cmake.org/>`_
* `Compiler <https://github.com/RadeonOpenCompute/llvm-project>`_
------------------------------------- You can use the ``docker container ls`` command to list the active containers on the system.
Which image is right for me?
-------------------------------------
Let's take a look at the image naming, for example ``ck_ub20.04_rocm6.0``. The image specs are: To start a container from the image, use the ``docker start`` command::
* ``ck`` - made for running Composable Kernel; docker start <container_name>
* ``ub20.04`` - based on Ubuntu 20.04;
* ``rocm6.0`` - ROCm platform version 6.0.
So just pick the right image for your project dependencies and you're all set. Then use the docker exec command as shown above to start the bash shell.
------------------------------------- Use the ``docker stop`` command to stop the container and restore the image to its initial state::
DIY starts here
-------------------------------------
If you need to customize a docker image or just can't stop tinkering, feel free to adjust the docker stop <container_name>
`Dockerfile <https://github.com/ROCmSoftwarePlatform/composable_kernel/blob/develop/Dockerfile>`_
for your needs.
------------------------------------- Editing the docker image
License =======================
-------------------------------------
CK is released under the MIT `license <https://github.com/ROCmSoftwarePlatform/composable_kernel/blob/develop/LICENSE>`_. If you want to customize the docker image, edit the
`Dockerfile <https://github.com/ROCmSoftwarePlatform/composable_kernel/blob/develop/Dockerfile>`_
from the GitHub repository to suit your needs.
============================ .. meta::
:description: Composable Kernel documentation and API reference library
:keywords: composable kernel, CK, ROCm, API, documentation
.. _composable-kernel:
********************************************************************
Composable Kernel User Guide Composable Kernel User Guide
============================ ********************************************************************
------------ The Composable Kernel (CK) library provides a programming model for writing performance critical kernels for machine learning workloads across multiple architectures including GPUs and CPUs, through general purpose kernel languages like HIP C++. This document contains instructions for installing, using, and contributing to the Composable Kernel project. To learn more see :ref:`what-is-ck`.
Introduction
------------
This document contains instructions for installing, using, and contributing to Composable Kernel (CK). The CK documentation is structured as follows:
----------- .. card:: Conceptual
Methodology
-----------
Composable Kernel (CK) library aims to provide a programming model for writing performance critical * :ref:`what-is-ck`
kernels for machine learning workloads across multiple architectures including GPUs, CPUs, etc,
through general purpose kernel languages, like HIP C++.
CK utilizes two concepts to achieve performance portability and code maintainability: .. card:: Installation
* A tile-based programming model * :ref:`docker-hub`
* Algorithm complexity reduction for complex ML operators, using innovative technique we call
"Tensor Coordinate Transformation".
.. image:: data/ck_component.png .. card:: Tutorial
:alt: CK Components
-------------- * :ref:`hello-world`
Code Structure
--------------
Current CK library are structured into 4 layers: .. card:: API reference
* "Templated Tile Operators" layer * :ref:`supported-primitives`
* "Templated Kernel and Invoker" layer * :ref:`api-reference`
* "Instantiated Kernel and Invoker" layer * :ref:`wrapper`
* "Wrapper for tensor transform operations"
* "Client API" layer
.. image:: data/ck_layer.png .. card:: Contributing to CK
:alt: CK Layers
Documentation Roadmap * :ref:`contributing-to`
^^^^^^^^^^^^^^^^^^^^^
The following is a list of CK documents in the suggested reading order:
.. toctree:: To contribute to the documentation refer to `Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/index.md>`_.
:maxdepth: 5
:caption: Contents:
:numbered:
tutorial_hello_world You can find licensing information at the `Licensing <https://rocm.docs.amd.com/en/latest/about/license.md>`_ page.
dockerhub
wrapper
Supported_Primitives_Guide
API_Reference_Guide
Contributors_Guide
```{include} ../LICENSE.md
```
=======
License
=======
.. include:: ../LICENSE
:literal:
# Anywhere {branch} is used, the branch name will be substituted.
# These comments will also be removed.
defaults: defaults:
numbered: False numbered: False
maxdepth: 6
root: index root: index
subtrees: subtrees:
- caption: About - entries:
entries: - file: what-is-ck.rst
- file: license title: What is Composable Kernel?
- file: dockerhub.rst
title: Docker Hub
- file: tutorial_hello_world.rst
title: Hello World Tutorial
- file: Supported_Primitives_Guide.rst
title: Supported Primitives
- file: API_Reference_Guide.rst
title: API Reference
- file: wrapper.rst
title: Wrapper
- file: Contributors_Guide.rst
title: Contributing to CK
- file: license.md
title: License
=============== .. meta::
CK Hello world :description: Composable Kernel documentation and API reference library
=============== :keywords: composable kernel, CK, ROCm, API, documentation
------------------------------------- .. _hello-world:
Motivation
-------------------------------------
This tutorial is aimed at engineers dealing with artificial intelligence and machine learning who ********************************************************************
would like to optimize their pipelines and squeeze every performance drop by adding Composable Hello World Tutorial
Kernel (CK) library to their projects. We would like to make the CK library approachable so ********************************************************************
the tutorial is not based on the latest release and doesn't have all the bleeding edge features,
but it will be reproducible now and forever.
During this tutorial we will have an introduction to the CK library, we will build it and run some This tutorial is for engineers dealing with artificial intelligence and machine learning who
examples and tests, so to say we will run a "Hello world" example. In future tutorials we will go would like to optimize pipelines and improve performance using the Composable
in depth and breadth and get familiar with other tools and ways to integrate CK into your project. Kernel (CK) library. This tutorial provides an introduction to the CK library. You will build the library and run some examples using a "Hello World" example.
-------------------------------------
Description Description
------------------------------------- ===========
Modern AI technology solves more and more problems in all imaginable fields, but crafting fast and Modern AI technology solves more and more problems in a variety of fields, but crafting fast and
efficient workflows is still challenging. CK is one of the tools to make AI heavy lifting as fast efficient workflows is still challenging. CK can make the AI workflow fast
and efficient as possible. CK is a collection of optimized AI operator kernels and tools to create and efficient. CK is a collection of optimized AI operator kernels with tools to create
new ones. The library has components required for majority of modern neural networks architectures new kernels. The library has components required for modern neural network architectures
including matrix multiplication, convolution, contraction, reduction, attention modules, variety of including matrix multiplication, convolution, contraction, reduction, attention modules, a variety of activation functions, and fused operators.
activation functions, fused operators and many more.
So how do we (almost) reach the speed of light? CK acceleration abilities are based on: CK library acceleration features are based on:
* Layered structure. * Layered structure
* Tile-based computation model. * Tile-based computation model
* Tensor coordinate transformation. * Tensor coordinate transformation
* Hardware acceleration use. * Hardware acceleration use
* Support of low precision data types including fp16, bf16, int8 and int4. * Support of low precision data types including fp16, bf16, int8 and int4
If you are excited and need more technical details and benchmarking results - read this awesome If you need more technical details and benchmarking results read the following
`blog post <https://community.amd.com/t5/instinct-accelerators/amd-composable-kernel-library-efficient-fused-kernels-for-ai/ba-p/553224>`_. `blog post <https://community.amd.com/t5/instinct-accelerators/amd-composable-kernel-library-efficient-fused-kernels-for-ai/ba-p/553224>`_.
For more details visit our `github repository <https://github.com/ROCmSoftwarePlatform/composable_kernel>`_. To download the library visit the `composable_kernel repository <https://github.com/ROCmSoftwarePlatform/composable_kernel>`_.
-------------------------------------
Hardware targets Hardware targets
------------------------------------- ================
CK library fully supports `gfx908` and `gfx90a` GPU architectures and only some operators are CK library fully supports `gfx908` and `gfx90a` GPU architectures, while only some operators are
supported for `gfx1030`. Let's check the hardware you have at hand and decide on the target supported for `gfx1030` devices. Check your hardware to determine the target GPU architecture.
GPU architecture.
========== ========= ========== =========
GPU Target AMD GPU GPU Target AMD GPU
...@@ -59,47 +51,24 @@ gfx1030 Radeon PRO V620, W6800, W6800X, W6800X Duo, W6900X, RX 6800, RX 6 ...@@ -59,47 +51,24 @@ gfx1030 Radeon PRO V620, W6800, W6800X, W6800X Duo, W6900X, RX 6800, RX 6
There are also `cloud options <https://aws.amazon.com/ec2/instance-types/g4/>`_ you can find if There are also `cloud options <https://aws.amazon.com/ec2/instance-types/g4/>`_ you can find if
you don't have an AMD GPU at hand. you don't have an AMD GPU at hand.
-------------------------------------
Build the library Build the library
------------------------------------- =================
First let's clone the library and rebase to the tested version:: This tutorial is based on the use of docker images as explained in :ref:`docker-hub`. Download a docker image suitable for your OS and ROCm release, run or start the docker container, and then resume the tutorial from this point.
git clone https://github.com/ROCmSoftwarePlatform/composable_kernel.git .. note::
cd composable_kernel/
git checkout tutorial_hello_world
To make our lives easier we prepared
`docker images <https://hub.docker.com/r/rocm/composable_kernel>`_ with all the necessary
dependencies. Pick the right image and create a container. In this tutorial we use
``rocm/composable_kernel:ck_ub20.04_rocm6.0`` image, it is based on Ubuntu 20.04 and
ROCm v6.0.
If your current folder is ``${HOME}``, start the docker container with::
docker run \
-it \
--privileged \
--group-add sudo \
-w /root/workspace \
-v ${HOME}:/root/workspace \
rocm/composable_kernel:ck_ub20.04_rocm6.0 \
/bin/bash
If your current folder is different from ``${HOME}``, adjust the line ``-v ${HOME}:/root/workspace`` You can also `install ROCm <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/>`_ on your system, clone the `Composable Kernel repository <https://github.com/ROCmSoftwarePlatform/composable_kernel.git>`_ on GitHub, and use that to build and run the examples using the commands described below.
to fit your folder structure.
Inside the docker container current folder is ``~/workspace``, library path is Both the docker container and GitHub repository include the Composable Kernel library. Navigate to the library::
``~/workspace/composable_kernel``, navigate to the library::
cd composable_kernel/ cd composable_kernel/
Create and go to the ``build`` directory:: Create and change to a ``build`` directory::
mkdir build && cd build mkdir build && cd build
In the previous section we talked about target GPU architecture. Once you decide which one is right The previous section discussed supported GPU architecture. Once you decide which hardware targets are needed, run CMake using the ``GPU_TARGETS`` flag::
for you, run CMake using the right ``GPU_TARGETS`` flag::
cmake \ cmake \
-D CMAKE_PREFIX_PATH=/opt/rocm \ -D CMAKE_PREFIX_PATH=/opt/rocm \
...@@ -109,26 +78,25 @@ for you, run CMake using the right ``GPU_TARGETS`` flag:: ...@@ -109,26 +78,25 @@ for you, run CMake using the right ``GPU_TARGETS`` flag::
-D BUILD_DEV=OFF \ -D BUILD_DEV=OFF \
-D GPU_TARGETS="gfx908;gfx90a;gfx1030" .. -D GPU_TARGETS="gfx908;gfx90a;gfx1030" ..
If everything went well the CMake run will end up with:: If everything goes well the CMake command will return::
-- Configuring done -- Configuring done
-- Generating done -- Generating done
-- Build files have been written to: "/root/workspace/composable_kernel/build" -- Build files have been written to: "/root/workspace/composable_kernel/build"
Finally, we can build examples and tests:: Finally, you can build examples and tests::
make -j examples tests make -j examples tests
If everything is smooth, you'll see:: When complete you should see::
Scanning dependencies of target tests Scanning dependencies of target tests
[100%] Built target tests [100%] Built target tests
---------------------------
Run examples and tests Run examples and tests
--------------------------- ======================
Examples are listed as test cases as well, so we can run all examples and tests with:: Examples are listed as test cases as well, so you can run all examples and tests with::
ctest ctest
...@@ -136,38 +104,32 @@ You can check the list of all tests by running:: ...@@ -136,38 +104,32 @@ You can check the list of all tests by running::
ctest -N ctest -N
We can also run them separately, here is a separate example execution:: You can also run examples separately as shown in the following example execution::
./bin/example_gemm_xdl_fp16 1 1 1 ./bin/example_gemm_xdl_fp16 1 1 1
The arguments ``1 1 1`` mean that we want to run this example in the mode: verify results with CPU, The arguments ``1 1 1`` mean that you want to run this example in the mode: verify results with CPU, initialize matrices with integers, and benchmark the kernel execution. You can play around with these parameters and see how output and execution results change.
initialize matrices with integers and benchmark the kernel execution. You can play around with
these parameters and see how output and execution results change.
If everything goes well and you have a device based on `gfx908` or `gfx90a` architecture you should see If you have a device based on `gfx908` or `gfx90a` architecture, and if the example runs as expected, you should see something like::
something like::
a_m_k: dim 2, lengths {3840, 4096}, strides {4096, 1} a_m_k: dim 2, lengths {3840, 4096}, strides {4096, 1}
b_k_n: dim 2, lengths {4096, 4096}, strides {1, 4096} b_k_n: dim 2, lengths {4096, 4096}, strides {4096, 1}
c_m_n: dim 2, lengths {3840, 4096}, strides {4096, 1} c_m_n: dim 2, lengths {3840, 4096}, strides {4096, 1}
launch_and_time_kernel: grid_dim {480, 1, 1}, block_dim {256, 1, 1} Perf: 1.08153 ms, 119.136 TFlops, 89.1972 GB/s, DeviceGemm_Xdl_CShuffle<Default, 256, 256, 128, 32, 8, 2, 32, 32, 4, 2, 8, 4, 1, 2> LoopScheduler: Interwave, PipelineVersion: v1
Warm up 1 time
Start running 10 times...
Perf: 1.10017 ms, 117.117 TFlops, 87.6854 GB/s, DeviceGemmXdl<256, 256, 128, 4, 8, 32, 32, 4, 2> NumPrefetch: 1, LoopScheduler: Default, PipelineVersion: v1
Meanwhile, running it on a `gfx1030` device should result in:: However, running it on a `gfx1030` device should result in the following::
a_m_k: dim 2, lengths {3840, 4096}, strides {4096, 1} a_m_k: dim 2, lengths {3840, 4096}, strides {4096, 1}
b_k_n: dim 2, lengths {4096, 4096}, strides {1, 4096} b_k_n: dim 2, lengths {4096, 4096}, strides {1, 4096}
c_m_n: dim 2, lengths {3840, 4096}, strides {4096, 1} c_m_n: dim 2, lengths {3840, 4096}, strides {4096, 1}
DeviceGemmXdl<256, 256, 128, 4, 8, 32, 32, 4, 2> NumPrefetch: 1, LoopScheduler: Default, PipelineVersion: v1 does not support this problem DeviceGemmXdl<256, 256, 128, 4, 8, 32, 32, 4, 2> NumPrefetch: 1, LoopScheduler: Default, PipelineVersion: v1 does not support this problem
But don't panic, some of the operators are supported on `gfx1030` architecture, so you can run a Don't worry, some operators are supported on `gfx1030` architecture, so you can run a
separate example like:: separate example like::
./bin/example_gemm_dl_fp16 1 1 1 ./bin/example_gemm_dl_fp16 1 1 1
and it should result in something nice similar to:: and it should return something like::
a_m_k: dim 2, lengths {3840, 4096}, strides {1, 4096} a_m_k: dim 2, lengths {3840, 4096}, strides {1, 4096}
b_k_n: dim 2, lengths {4096, 4096}, strides {4096, 1} b_k_n: dim 2, lengths {4096, 4096}, strides {4096, 1}
...@@ -182,12 +144,9 @@ and it should result in something nice similar to:: ...@@ -182,12 +144,9 @@ and it should result in something nice similar to::
.. note:: .. note::
There was a new CMake flag ``DL_KERNELS`` added in the latest versions of CK. If you use one of A new CMake flag ``DL_KERNELS`` has been added to the latest versions of CK. If you do not see the above results when running ``example_gemm_dl_fp16``, you might need to add ``-D DL_KERNELS=ON`` to your CMake command to build the operators supported on the `gfx1030` architecture.
the newest versions of the library and do not see the above results when running
``example_gemm_dl_fp16``, it might be necessary to add ``-D DL_KERNELS=ON`` to your CMake command
in order to build the operators supported on the `gfx1030` architecture.
We can also run a separate test:: You can also run a separate test::
ctest -R test_gemm_fp16 ctest -R test_gemm_fp16
...@@ -198,13 +157,9 @@ If everything goes well you should see something like:: ...@@ -198,13 +157,9 @@ If everything goes well you should see something like::
100% tests passed, 0 tests failed out of 1 100% tests passed, 0 tests failed out of 1
-----------
Summary Summary
----------- =======
In this tutorial we took the first look at the Composable Kernel library, built it on your system In this tutorial you took the first look at the Composable Kernel library, built it on your system and ran some examples and tests. In the next tutorial you will run kernels with different configurations to find out the best one for your hardware and task.
and ran some examples and tests. Stay tuned, in the next tutorial we will run kernels with different
configs to find out the best one for your hardware and task.
P.S.: Don't forget to switch off the cloud instance if you have launched one, you can find better P.S.: If you are running on a cloud instance, don't forget to switch off the cloud instance.
ways to spend your money for sure!
.. meta::
:description: Composable Kernel documentation and API reference library
:keywords: composable kernel, CK, ROCm, API, documentation
.. _what-is-ck:
********************************************************************
What is the Composable Kernel library
********************************************************************
Methodology
===========
The Composable Kernel (CK) library provides a programming model for writing performance critical kernels for machine learning workloads across multiple architectures including GPUs and CPUs, through general purpose kernel languages like HIP C++.
CK utilizes two concepts to achieve performance portability and code maintainability:
* A tile-based programming model
* Algorithm complexity reduction for complex ML operators using an innovative technique called
"Tensor Coordinate Transformation".
.. image:: data/ck_component.png
:alt: CK Components
Code Structure
==============
The CK library is structured into 4 layers:
* "Templated Tile Operators" layer
* "Templated Kernel and Invoker" layer
* "Instantiated Kernel and Invoker" layer
* "Client API" layer
It also includes a simple wrapper component used to perform tensor transform operations more easily and with fewer lines of code.
.. image:: data/ck_layer.png
:alt: CK Layers
\ No newline at end of file
=============== .. meta::
:description: Composable Kernel documentation and API reference library
:keywords: composable kernel, CK, ROCm, API, documentation
.. _wrapper:
********************************************************************
Wrapper Wrapper
=============== ********************************************************************
------------------------------------- -------------------------------------
Description Description
...@@ -11,7 +17,7 @@ Description ...@@ -11,7 +17,7 @@ Description
The wrapper is under development and its functionality is limited. The wrapper is under development and its functionality is limited.
CK provides a lightweight wrapper for more complex operations implemented in 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 the library. It allows indexing of nested layouts using a simple interface
(avoiding complex descriptor transformations) and memory access (using Tensor). (avoiding complex descriptor transformations) and memory access (using Tensor).
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment