mirror of
https://github.com/ROCm/composable_kernel.git
synced 2026-04-20 06:49:15 +00:00
* doc reorg and edits * Update wrapper.rst with changes from PR #1098 * Update docs/dockerhub.rst Co-authored-by: Bartlomiej Wroblewski <bwroblewski10@gmail.com> * Update docs/index.rst Co-authored-by: Bartlomiej Wroblewski <bwroblewski10@gmail.com> * Update docs/what-is-ck.rst Co-authored-by: Bartlomiej Wroblewski <bwroblewski10@gmail.com> * Update docs/what-is-ck.rst Restored to 4 bullets, with additional text for wrapper. Co-authored-by: Bartlomiej Wroblewski <bwroblewski10@gmail.com> * Update docs/Contributors_Guide.rst Co-authored-by: Lisa <lisajdelaney@gmail.com> * Update API_Reference_Guide.rst using sentence case for title * updated index structure per Lisa * separate docker hub and tutorial --------- Co-authored-by: Bartlomiej Wroblewski <bwroblewski10@gmail.com> Co-authored-by: Lisa <lisajdelaney@gmail.com> Co-authored-by: Illia Silin <98187287+illsilin@users.noreply.github.com>
40 lines
1.3 KiB
ReStructuredText
40 lines
1.3 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 (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`.
|
|
|
|
The CK documentation is structured as follows:
|
|
|
|
.. card:: Conceptual
|
|
|
|
* :ref:`what-is-ck`
|
|
|
|
.. card:: Installation
|
|
|
|
* :ref:`docker-hub`
|
|
|
|
.. card:: Tutorial
|
|
|
|
* :ref:`hello-world`
|
|
|
|
.. card:: API reference
|
|
|
|
* :ref:`supported-primitives`
|
|
* :ref:`api-reference`
|
|
* :ref:`wrapper`
|
|
|
|
.. card:: Contributing to CK
|
|
|
|
* :ref:`contributing-to`
|
|
|
|
To contribute to the documentation refer to `Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/index.md>`_.
|
|
|
|
You can find licensing information at the `Licensing <https://rocm.docs.amd.com/en/latest/about/license.md>`_ page.
|