index.rst 1.32 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
16
.. grid:: 2
  :gutter: 3
Sam Wu's avatar
Sam Wu committed
17

randyh62's avatar
randyh62 committed
18
  .. grid-item-card:: Installation
Sam Wu's avatar
Sam Wu committed
19

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

randyh62's avatar
randyh62 committed
22
  .. grid-item-card:: Conceptual
Sam Wu's avatar
Sam Wu committed
23

randyh62's avatar
randyh62 committed
24
    * :ref:`what-is-ck`
Sam Wu's avatar
Sam Wu committed
25

randyh62's avatar
randyh62 committed
26
  .. grid-item-card:: API reference
Sam Wu's avatar
Sam Wu committed
27

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

randyh62's avatar
randyh62 committed
32
  .. grid-item-card:: Tutorial
Sam Wu's avatar
Sam Wu committed
33

randyh62's avatar
randyh62 committed
34
    * :ref:`hello-world`
Sam Wu's avatar
Sam Wu committed
35

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

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