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

Doc reorg2 (#1189)

* doc_reorg2 updated TOC

* doc_reorg2 updates

* fix conflicts, add grid
parent 8e97e85a
...@@ -20,7 +20,7 @@ CK utilizes two concepts to achieve performance portability and code maintainabi ...@@ -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 * Algorithm complexity reduction for complex ML operators using an innovative technique called
"Tensor Coordinate Transformation". "Tensor Coordinate Transformation".
.. image:: data/ck_component.png .. image:: ../data/ck_component.png
:alt: CK Components :alt: CK Components
...@@ -36,6 +36,6 @@ The CK library is structured into 4 layers: ...@@ -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. 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 :alt: CK Layers
\ No newline at end of file
...@@ -12,27 +12,26 @@ The Composable Kernel (CK) library provides a programming model for writing perf ...@@ -12,27 +12,26 @@ The Composable Kernel (CK) library provides a programming model for writing perf
The CK documentation is structured as follows: 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` .. grid-item-card:: Tutorial
* :ref:`api-reference`
* :ref:`wrapper`
.. card:: Contributing to CK * :ref:`hello-world`
* :ref:`contributing-to`
To contribute to the documentation refer to `Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/index.html>`_. To contribute to the documentation refer to `Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/index.html>`_.
......
```{include} ../LICENSE.md
```
.. meta::
:description: Composable Kernel documentation and API reference library
:keywords: composable kernel, CK, ROCm, API, documentation
.. _license:
********************************************************************
License
********************************************************************
.. include:: ../LICENSE
\ No newline at end of file
...@@ -2,20 +2,35 @@ defaults: ...@@ -2,20 +2,35 @@ defaults:
numbered: False numbered: False
root: index root: index
subtrees: subtrees:
- entries:
- file: what-is-ck.rst - caption: Conceptual
entries:
- file: conceptual/what-is-ck.rst
title: What is Composable Kernel? title: What is Composable Kernel?
- file: dockerhub.rst
- caption: Install
entries:
- file: install/dockerhub.rst
title: Docker Hub title: Docker Hub
- file: tutorial_hello_world.rst
title: Hello World Tutorial - caption: CK API Reference
- file: Supported_Primitives_Guide.rst entries:
- file: reference/Supported_Primitives_Guide.rst
title: Supported Primitives title: Supported Primitives
- file: API_Reference_Guide.rst - file: reference/API_Reference_Guide.rst
title: API Reference title: API Reference
- file: wrapper.rst - file: reference/wrapper.rst
title: Wrapper title: Wrapper
- caption: Tutorial
entries:
- file: tutorial/tutorial_hello_world.rst
title: Hello World Tutorial
- caption: About
entries:
- file: Contributors_Guide.rst - file: Contributors_Guide.rst
title: Contributing to CK title: Contributing to CK
- file: license.md - file: license.rst
title: License title: License
\ No newline at end of file
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