mirror of
https://github.com/ROCm/composable_kernel.git
synced 2026-05-13 17:55:48 +00:00
Doc reorg2 (#1189)
* doc_reorg2 updated TOC
* doc_reorg2 updates
* fix conflicts, add grid
[ROCm/composable_kernel commit: 12441af014]
This commit is contained in:
@@ -20,7 +20,7 @@ CK utilizes two concepts to achieve performance portability and code maintainabi
|
||||
* Algorithm complexity reduction for complex ML operators using an innovative technique called
|
||||
"Tensor Coordinate Transformation".
|
||||
|
||||
.. image:: data/ck_component.png
|
||||
.. image:: ../data/ck_component.png
|
||||
:alt: CK Components
|
||||
|
||||
|
||||
@@ -36,6 +36,6 @@ The CK library is structured into 4 layers:
|
||||
|
||||
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
|
||||
.. image:: ../data/ck_layer.png
|
||||
:alt: CK Layers
|
||||
|
||||
@@ -12,27 +12,26 @@ The Composable Kernel (CK) library provides a programming model for writing perf
|
||||
|
||||
The CK documentation is structured as follows:
|
||||
|
||||
.. card:: Conceptual
|
||||
.. grid:: 2
|
||||
:gutter: 3
|
||||
|
||||
* :ref:`what-is-ck`
|
||||
.. grid-item-card:: Installation
|
||||
|
||||
.. card:: Installation
|
||||
* :ref:`docker-hub`
|
||||
|
||||
* :ref:`docker-hub`
|
||||
.. grid-item-card:: Conceptual
|
||||
|
||||
.. card:: Tutorial
|
||||
* :ref:`what-is-ck`
|
||||
|
||||
* :ref:`hello-world`
|
||||
.. grid-item-card:: API reference
|
||||
|
||||
.. card:: API reference
|
||||
* :ref:`supported-primitives`
|
||||
* :ref:`api-reference`
|
||||
* :ref:`wrapper`
|
||||
|
||||
* :ref:`supported-primitives`
|
||||
* :ref:`api-reference`
|
||||
* :ref:`wrapper`
|
||||
.. grid-item-card:: Tutorial
|
||||
|
||||
.. card:: Contributing to CK
|
||||
|
||||
* :ref:`contributing-to`
|
||||
* :ref:`hello-world`
|
||||
|
||||
To contribute to the documentation refer to `Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/index.html>`_.
|
||||
|
||||
|
||||
@@ -1,2 +0,0 @@
|
||||
```{include} ../LICENSE.md
|
||||
```
|
||||
11
docs/license.rst
Normal file
11
docs/license.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
.. meta::
|
||||
:description: Composable Kernel documentation and API reference library
|
||||
:keywords: composable kernel, CK, ROCm, API, documentation
|
||||
|
||||
.. _license:
|
||||
|
||||
********************************************************************
|
||||
License
|
||||
********************************************************************
|
||||
|
||||
.. include:: ../LICENSE
|
||||
@@ -2,20 +2,35 @@ defaults:
|
||||
numbered: False
|
||||
root: index
|
||||
subtrees:
|
||||
- entries:
|
||||
- file: what-is-ck.rst
|
||||
|
||||
- caption: Conceptual
|
||||
entries:
|
||||
- file: conceptual/what-is-ck.rst
|
||||
title: What is Composable Kernel?
|
||||
- file: dockerhub.rst
|
||||
|
||||
- caption: Install
|
||||
entries:
|
||||
- file: install/dockerhub.rst
|
||||
title: Docker Hub
|
||||
- file: tutorial_hello_world.rst
|
||||
title: Hello World Tutorial
|
||||
- file: Supported_Primitives_Guide.rst
|
||||
|
||||
- caption: CK API Reference
|
||||
entries:
|
||||
- file: reference/Supported_Primitives_Guide.rst
|
||||
title: Supported Primitives
|
||||
- file: API_Reference_Guide.rst
|
||||
- file: reference/API_Reference_Guide.rst
|
||||
title: API Reference
|
||||
- file: wrapper.rst
|
||||
- file: reference/wrapper.rst
|
||||
title: Wrapper
|
||||
|
||||
- caption: Tutorial
|
||||
entries:
|
||||
- file: tutorial/tutorial_hello_world.rst
|
||||
title: Hello World Tutorial
|
||||
|
||||
- caption: About
|
||||
entries:
|
||||
- file: Contributors_Guide.rst
|
||||
title: Contributing to CK
|
||||
- file: license.md
|
||||
- file: license.rst
|
||||
title: License
|
||||
|
||||
Reference in New Issue
Block a user