3. Programmer’s Guide¶

3.1. Library Source Code Organization¶

The rocWMMA code is split into four major parts:

The library directory contains all source code for the library.
The samples directory contains real-world use-cases of the rocWMMA API.
The test directory contains all validation, performance and unit tests of rocWMMA API.
Infrastructure

Contains C++ include files for the rocWMMA API. These files also contain Doxygen comments that document the API.

Internal include files for:

sample code for calling Simple matrix multiply-accumulate with a vector demonstration, without LDS and no transpose.

Sample code for calling Simple GEMM algorithm demonstration without LDS memory usage and no transpose.

Sample code for calling Simple Deep Learning Recommendation Model (DLRM) for machine learning.

Common code used by all the above rocWMMA samples files.

Script to generate benchmark plots from the gtest output dumps of benchmark tests of rocWMMA.

Test code for various strategies of DLRM application. This test is used to validate dlrm functions using rocWMMA API.

Test Code for various strategies of GEMM application. This test is used to validate and benchmark GEMM functions using rocWMMA API.

Test code for testing the basic functional units of rocWMMA library.

CMake is used to build and package rocWMMA. There are CMakeLists.txt files throughout the code.
Doxygen/Breathe/Sphinx/ReadTheDocs are used to produce documentation. Content for the documentation is from:
- Doxygen comments in include files in the directory library/include
- files in the directory docs/source.
Jenkins is used to automate Continuous Integration testing.
clang-format is used to format C++ code.