derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
60 lines
1.9 KiB
ReStructuredText
60 lines
1.9 KiB
ReStructuredText
.. meta::
|
|
:description: Source code organization and structure for the hipBLASLt library
|
|
:keywords: hipBLASLt, ROCm, library, API, source code, structure, organization
|
|
|
|
.. _source-code-organization:
|
|
|
|
******************************************
|
|
hipBLASLt library source code organization
|
|
******************************************
|
|
|
|
The hipBLASLt source code resides in the following two directories:
|
|
|
|
* The ``library`` directory contains all source code for the library.
|
|
* The ``clients`` directory contains all test code and the code to build the clients.
|
|
|
|
The library directory
|
|
-----------------------
|
|
|
|
Here are the subdirectories within the ``library`` directory:
|
|
|
|
* ``library/include``
|
|
|
|
Contains C98 include files for the external API. These files also contain Doxygen
|
|
comments that document the API.
|
|
|
|
* ``library/src/amd_detail``
|
|
|
|
Contains the implementation of the hipBLASLt interface that is compatible with the rocBLASLt APIs.
|
|
|
|
* ``library/src/include``
|
|
|
|
Contains internal include files for converting C++ exceptions to hipBLAS statuses.
|
|
|
|
.. note::
|
|
|
|
For important information about handle management, see the API reference information for the
|
|
:ref:`hipblaslthandle_t structure <hipblaslthandle_t_desc>`.
|
|
|
|
The clients directory
|
|
-----------------------
|
|
|
|
Here is the subdirectory within the ``clients`` directory:
|
|
|
|
* ``clients/samples``
|
|
|
|
Contains sample code for calling the hipBLASLt functions.
|
|
|
|
Infrastructure
|
|
--------------
|
|
|
|
* ``CMake`` is used to build and package hipBLASLt. There are ``CMakeLists.txt`` files throughout the code.
|
|
* Doxygen, Breathe, Sphinx, and ReadTheDocs generate the documentation
|
|
based on these sources:
|
|
|
|
* Doxygen comments in the ``include`` files in the ``library/include`` directory.
|
|
* Files in the ``docs/source`` directory.
|
|
|
|
* Jenkins is used to automate continuous integration testing.
|
|
* ``clang-format`` is used to format the C++ code.
|