mirror of
https://github.com/ROCm/composable_kernel.git
synced 2026-05-16 19:09:59 +00:00
408c8b8125
* creation of install doc and refactor of doc in general
* updates based on review comments
* updated based on review comments
* updated readme and contributors markdown
* added extra note to not use -j on its own
* added note about smoke tests and regression tests
* made changes as per Illia's feedback
---------
Co-authored-by: Aviral Goel <aviral.goel@amd.com>
[ROCm/composable_kernel commit: a426f67301]
42 lines
1.8 KiB
ReStructuredText
42 lines
1.8 KiB
ReStructuredText
.. meta::
|
|
:description: Composable Kernel documentation and API reference library
|
|
:keywords: composable kernel, CK, ROCm, API, documentation
|
|
|
|
.. _composable-kernel:
|
|
|
|
********************************************************************
|
|
Composable Kernel User Guide
|
|
********************************************************************
|
|
|
|
The Composable Kernel 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 such as `HIP C++ <https://rocm.docs.amd.com/projects/HIP/en/latest/index.html>`_.
|
|
|
|
The Composable Kernel repository is located at `https://github.com/ROCm/composable-kernel <https://github.com/ROCm/composable-kernel>`_.
|
|
|
|
.. grid:: 2
|
|
:gutter: 3
|
|
|
|
.. grid-item-card:: Install
|
|
|
|
* :doc:`Composable Kernel prerequisites <./install/Composable-Kernel-prerequisites>`
|
|
* :doc:`Build and install Composable Kernel <./install/Composable-Kernel-install>`
|
|
* :doc:`Build and install Composable Kernel on a Docker image <./install/Composable-Kernel-Docker>`
|
|
|
|
.. grid-item-card:: Conceptual
|
|
|
|
* :doc:`Composable Kernel structure <./conceptual/Composable-Kernel-structure>`
|
|
* :doc:`Composable Kernel mathematical basis <./conceptual/Composable-Kernel-math>`
|
|
|
|
.. grid-item-card:: Tutorials
|
|
|
|
* :doc:`Composable Kernel examples and tests <./tutorial/Composable-Kernel-examples>`
|
|
|
|
.. grid-item-card:: Reference
|
|
|
|
* :ref:`api-reference`
|
|
* :ref:`wrapper`
|
|
|
|
|
|
To contribute to the documentation refer to `Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_.
|
|
|
|
You can find licensing information on the `Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.
|