mirror of
https://github.com/ROCm/composable_kernel.git
synced 2026-05-11 17:00:18 +00:00
a39163814e
* 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>
55 lines
1.3 KiB
ReStructuredText
55 lines
1.3 KiB
ReStructuredText
.. meta::
|
|
:description: Composable Kernel documentation and API reference library
|
|
:keywords: composable kernel, CK, ROCm, API, documentation
|
|
|
|
.. _api-reference:
|
|
|
|
********************************************************************
|
|
API reference guide
|
|
********************************************************************
|
|
|
|
|
|
This document contains details of the APIs for the Composable Kernel (CK) library and introduces
|
|
some of the key design principles that are used to write new classes that extend CK functionality.
|
|
|
|
=================
|
|
Using CK API
|
|
=================
|
|
|
|
This section describes how to use the CK library API.
|
|
|
|
=================
|
|
CK Datatypes
|
|
=================
|
|
|
|
-----------------
|
|
DeviceMem
|
|
-----------------
|
|
|
|
.. doxygenstruct:: DeviceMem
|
|
|
|
---------------------------
|
|
Kernels For Flashattention
|
|
---------------------------
|
|
|
|
The Flashattention algorithm is defined in :cite:t:`dao2022flashattention`. This section lists
|
|
the classes that are used in the CK GPU implementation of Flashattention.
|
|
|
|
**Gridwise classes**
|
|
|
|
.. doxygenstruct:: ck::GridwiseBatchedGemmSoftmaxGemm_Xdl_CShuffle
|
|
|
|
**Blockwise classes**
|
|
|
|
.. doxygenstruct:: ck::ThreadGroupTensorSliceTransfer_v4r1
|
|
|
|
.. doxygenstruct:: ck::BlockwiseGemmXdlops_v2
|
|
|
|
.. doxygenstruct:: ck::BlockwiseSoftmax
|
|
|
|
**Threadwise classes**
|
|
|
|
.. doxygenstruct:: ck::ThreadwiseTensorSliceTransfer_StaticToStatic
|
|
|
|
.. bibliography::
|