ROCm/composable_kernel
1
0
Fork 0
mirror of https://github.com/ROCm/composable_kernel.git synced 2026-05-21 21:39:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[CK] updated github repo link (#4431)

Browse Source 
The location of the github repo has changed; the landing page of the
docs needs to reflect this.

Updated only the git repo links in the docs folder. 

Also added info to the install doc about how to do a sparse checkout.

Updated some refs that were messed up while I was at it.

---------

Co-authored-by: Illia Silin <98187287+illsilin@users.noreply.github.com>
This commit is contained in:
spolifroni-amd
2026-02-26 13:35:42 -05:00
committed by GitHub
parent f7c2b42170
commit 0e4de442e4
12 changed files with 44 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/install/Composable-Kernel-install.rst
View File

@@ -6,12 +6,28 @@
Building and installing Composable Kernel with CMake
******************************************************
Before you begin, clone the `Composable Kernel GitHub repository <https://github.com/ROCm/composable_kernel.git>`_ and create a ``build`` directory in its root:
Before you begin, clone the `Composable Kernel project <https://github.com/ROCm/rocm-libraries/tree/develop/projects/composablekernel>`_.
Use sparse checkout when cloning the Composable Kernel project:
.. code::
git clone --no-checkout --filter=blob:none https://github.com/ROCm/rocm-libraries.git
cd rocm-libraries
git sparse-checkout init --cone
git sparse-checkout set projects/composablekernel
Then use ``git checkout`` to check out the branch you need.
The develop branch is intended for users who want to preview new features or contribute to the Composable Kernel codebase.
If you don't intend to contribute to the codebase and won't be previewing features, use a branch that matches the version of ROCm installed on your system.
Create the ``build`` directory under ``rocm-libraries/projects/composablekernel``:
.. code:: shell
git clone https://github.com/ROCm/composable_kernel.git
cd composable_kernel
cd projects/composablekernel
mkdir build
Change directory to the ``build`` directory and generate the makefile using the ``cmake`` command. Two build options are required:
@@ -19,7 +35,6 @@ Change directory to the ``build`` directory and generate the makefile using the
* ``CMAKE_PREFIX_PATH``: The ROCm installation path. ROCm is installed in ``/opt/rocm`` by default.
* ``CMAKE_CXX_COMPILER``: The path to the Clang compiler. Clang is found at ``/opt/rocm/llvm/bin/clang++`` by default.
.. code:: shell
cd build
@@ -65,8 +80,9 @@ After running ``make install``, the Composable Kernel files will be saved to the
* Header files: ``/opt/rocm/include/ck/`` and ``/opt/rocm/include/ck_tile/``
* Examples, tests, and ckProfiler: ``/opt/rocm/bin/``
For information about ckProfiler, see `the ckProfiler readme file <https://github.com/ROCm/composable_kernel/blob/develop/profiler/README.md>`_.
For information about ckProfiler, see `the ckProfiler readme file <https://github.com/ROCm/rocm-libraries/tree/develop/projects/composablekernel/profiler/README.md>`_.
For information about running the examples and tests, see :doc:`Composable Kernel examples and tests <../tutorial/Composable-Kernel-examples>`.