mirror of
https://github.com/ROCm/composable_kernel.git
synced 2026-04-20 14:59:17 +00:00
standardize docs (#655)
This commit is contained in:
52
docs/index.rst
Normal file
52
docs/index.rst
Normal file
@@ -0,0 +1,52 @@
|
||||
============================
|
||||
Composable Kernel User Guide
|
||||
============================
|
||||
|
||||
------------
|
||||
Introduction
|
||||
------------
|
||||
|
||||
This document contains instructions for installing, using, and contributing to Composable Kernel (CK).
|
||||
|
||||
-----------
|
||||
Methodology
|
||||
-----------
|
||||
|
||||
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++.
|
||||
|
||||
CK utilizes two concepts to achieve performance portability and code maintainability:
|
||||
|
||||
* A tile-based programming model
|
||||
* Algorithm complexity reduction for complex ML operators, using innovative technique we call "Tensor Coordinate Transformation".
|
||||
|
||||
.. image:: data/ck_component.png
|
||||
:alt: CK Components
|
||||
|
||||
--------------
|
||||
Code Structure
|
||||
--------------
|
||||
|
||||
Current CK library are structured into 4 layers:
|
||||
|
||||
* "Templated Tile Operators" layer
|
||||
* "Templated Kernel and Invoker" layer
|
||||
* "Instantiated Kernel and Invoker" layer
|
||||
* "Client API" layer
|
||||
|
||||
.. image:: data/ck_layer.png
|
||||
:alt: CK Layers
|
||||
|
||||
Documentation Roadmap
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
The following is a list of CK documents in the suggested reading order:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
:caption: Contents:
|
||||
:numbered:
|
||||
|
||||
tutorial_hello_world
|
||||
dockerhub
|
||||
Supported_Primitives_Guide
|
||||
API_Reference_Guide
|
||||
Contributors_Guide
|
||||
Reference in New Issue
Block a user