index.rst 1.29 KB
Newer Older
randyh62's avatar
randyh62 committed
1
2
3
4
5
6
7
.. meta::
  :description: Composable Kernel documentation and API reference library
  :keywords: composable kernel, CK, ROCm, API, documentation

.. _composable-kernel:

********************************************************************
Sam Wu's avatar
Sam Wu committed
8
Composable Kernel User Guide
randyh62's avatar
randyh62 committed
9
10
11
********************************************************************

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`.
Sam Wu's avatar
Sam Wu committed
12

randyh62's avatar
randyh62 committed
13
The CK documentation is structured as follows:
Sam Wu's avatar
Sam Wu committed
14

randyh62's avatar
randyh62 committed
15
.. card:: Conceptual
Sam Wu's avatar
Sam Wu committed
16

randyh62's avatar
randyh62 committed
17
  * :ref:`what-is-ck`
Sam Wu's avatar
Sam Wu committed
18

randyh62's avatar
randyh62 committed
19
.. card:: Installation
Sam Wu's avatar
Sam Wu committed
20

randyh62's avatar
randyh62 committed
21
  * :ref:`docker-hub`
Sam Wu's avatar
Sam Wu committed
22

randyh62's avatar
randyh62 committed
23
.. card:: Tutorial
Sam Wu's avatar
Sam Wu committed
24

randyh62's avatar
randyh62 committed
25
  * :ref:`hello-world`
Sam Wu's avatar
Sam Wu committed
26

randyh62's avatar
randyh62 committed
27
.. card:: API reference
Sam Wu's avatar
Sam Wu committed
28

randyh62's avatar
randyh62 committed
29
30
31
  * :ref:`supported-primitives`
  * :ref:`api-reference`
  * :ref:`wrapper`
Sam Wu's avatar
Sam Wu committed
32

randyh62's avatar
randyh62 committed
33
.. card:: Contributing to CK
Sam Wu's avatar
Sam Wu committed
34

randyh62's avatar
randyh62 committed
35
  * :ref:`contributing-to`
Sam Wu's avatar
Sam Wu committed
36

randyh62's avatar
randyh62 committed
37
To contribute to the documentation refer to `Contributing to ROCm  <https://rocm.docs.amd.com/en/latest/contribute/index.md>`_.
Sam Wu's avatar
Sam Wu committed
38

randyh62's avatar
randyh62 committed
39
You can find licensing information at the `Licensing <https://rocm.docs.amd.com/en/latest/about/license.md>`_ page.