mirror of
https://github.com/ROCm/composable_kernel.git
synced 2026-06-30 03:37:38 +00:00
2ae753c2d0
* creation of install doc and refactor of doc in general (#1908) * 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> (cherry picked from commita426f67301) (cherry picked from commitef9871ff23) * Docs: Add precision support reference page (#1973) * Docs: Add precision support reference page * edit of the precision type content * added more description on scalars --------- Co-authored-by: spolifroni-amd <sandra.polifroni@amd.com> Co-authored-by: Aviral Goel <aviral.goel@amd.com> (cherry picked from commitfc073b483e) (cherry picked from commit1f61b696ee) * fixed broken github link (#2063) (cherry picked from commit2c8132126c) (cherry picked from commitae2e3ffb29) * updated Doxyfile and added the class list (#2147) * updated Doxyfile and added the class list * Update Doxyfile (cherry picked from commitcfae863431) (cherry picked from commit1e3f59543d) * added more API reference (cherry picked from commit8bb52d0ab0) * Update README.md Co-authored-by: John Afaganis <john.afaganis@gmail.com> (cherry picked from commit415273ea5f) --------- Co-authored-by: Aviral Goel <aviral.goel@amd.com> Co-authored-by: Adel Johar <adel.johar@amd.com> Co-authored-by: John Afaganis <john.afaganis@gmail.com>
40 lines
1.6 KiB
ReStructuredText
40 lines
1.6 KiB
ReStructuredText
.. meta::
|
|
:description: Composable Kernel examples and tests
|
|
:keywords: composable kernel, CK, ROCm, API, examples, tests
|
|
|
|
********************************************************************
|
|
Composable Kernel examples and tests
|
|
********************************************************************
|
|
|
|
After :doc:`building and installing Composable Kernel <../install/Composable-Kernel-install>`, the examples and tests will be moved to ``/opt/rocm/bin/``.
|
|
|
|
All tests have the prefix ``test`` and all examples have the prefix ``example``.
|
|
|
|
Use ``ctest`` with no arguments to run all examples and tests, or use ``ctest -R`` to run a single test. For example:
|
|
|
|
.. code:: shell
|
|
|
|
ctest -R test_gemm_fp16
|
|
|
|
Examples can be run individually as well. For example:
|
|
|
|
.. code:: shell
|
|
|
|
./bin/example_gemm_xdl_fp16 1 1 1
|
|
|
|
For instructions on how to run individual examples and tests, see their README files in the |example|_ and |test|_ GitHub folders.
|
|
|
|
To run smoke tests, use ``make smoke``.
|
|
|
|
To run regression tests, use ``make regression``.
|
|
|
|
In general, tests that run for under thirty seconds are included in the smoke tests and tests that run for over thirty seconds are included in the regression tests.
|
|
|
|
.. |example| replace:: ``example``
|
|
.. _example: https://github.com/ROCm/composable_kernel/tree/develop/example
|
|
|
|
.. |client_example| replace:: ``client_example``
|
|
.. _client_example: https://github.com/ROCm/composable_kernel/tree/develop/client_example
|
|
|
|
.. |test| replace:: ``test``
|
|
.. _test: https://github.com/ROCm/composable_kernel/tree/develop/test |