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
513 lines
29 KiB
ReStructuredText
513 lines
29 KiB
ReStructuredText
.. meta::
|
|
:description: install guide for the rocWMMA C++ library
|
|
:keywords: rocWMMA, ROCm, library, API, tool, installation, building
|
|
|
|
.. _installation:
|
|
|
|
*************************************
|
|
Build and install rocWMMA from source
|
|
*************************************
|
|
|
|
To build rocWMMA as part of the ROCm Core SDK, see `TheRock build
|
|
instructions
|
|
<https://github.com/ROCm/TheRock/blob/main/docs/development/README.md>`__.
|
|
TheRock is the recommended way to build ROCm components from source.
|
|
|
|
Alternatively, you can build rocWMMA standalone using the following sections,
|
|
which provide instructions for installing and configuring the rocWMMA library.
|
|
|
|
Prerequisites
|
|
=============
|
|
|
|
rocWMMA requires the following prerequisites:
|
|
|
|
* A ROCm-enabled platform, using ROCm version 6.4 or later.
|
|
For more information, see :doc:`ROCm installation <rocm:install/rocm>`.
|
|
* :doc:`rocBLAS <rocblas:index>` version 4.3.0 for ROCm version 6.3 or later. (Optional: only required if rocWMMA is configured
|
|
to use rocBLAS for validation. See below for more information.)
|
|
|
|
Building and installing rocWMMA from source
|
|
=============================================
|
|
|
|
It isn't necessary to build rocWMMA from source because it's ready to use after installing
|
|
the prebuilt packages, as described in :doc:`./installation`.
|
|
To build rocWMMA from source, follow the instructions in this section.
|
|
|
|
System requirements
|
|
-------------------------------------------
|
|
|
|
8GB of system memory is required for a full rocWMMA build.
|
|
This value might be lower if rocWMMA is built without tests.
|
|
|
|
GPU support
|
|
-------------------------------------------
|
|
|
|
rocWMMA is supported on the following GPUs.
|
|
|
|
* AMD CDNA class GPUs featuring matrix core support,
|
|
including the gfx908, gfx90a, gfx942, and gfx950 GPUs (collectively labeled as gfx9).
|
|
|
|
.. note::
|
|
|
|
Double precision ``FP64`` data type support requires the gfx90a, gfx942, or gfx950.
|
|
|
|
``F8`` and ``BF8`` data type support requires the gfx942 or gfx950.
|
|
|
|
* AMD RDNA class GPUs featuring AI acceleration support, including the
|
|
gfx1100, gfx1101, and gfx1102 (collectively known as gfx11), and the gfx1200 and gfx1201 (collectively known as gfx12).
|
|
|
|
.. note::
|
|
|
|
``F8`` and ``BF8`` data type support requires the gfx1200 or gfx1201.
|
|
|
|
Dependencies
|
|
-------------------------------------------
|
|
|
|
rocWMMA is designed to have minimal external dependencies so it's lightweight and portable.
|
|
The following dependencies are required:
|
|
|
|
.. <!-- spellcheck-disable -->
|
|
|
|
* `ROCm <https://github.com/ROCm/ROCm>`_ (Version 6.4 or later)
|
|
* `CMake <https://cmake.org/>`_ (Version 3.14 or later)
|
|
* `rocm-cmake <https://github.com/ROCm/rocm-cmake>`_ (Version 0.8.0 or later)
|
|
* `HIP runtime <https://github.com/ROCm/rocm-systems/tree/develop/projects/hip>`_ (Version 6.4.0 or later) (Or the ROCm hip-runtime-amd package)
|
|
* `LLVM OpenMP <https://openmp.llvm.org/>`_ runtime dev package (Version 10.0 or later) (Also available as the ROCm rocm-llvm-dev package)
|
|
* (Optional, only required to use rocBLAS for validation) `rocBLAS <https://github.com/ROCm/rocm-libraries/tree/develop/projects/rocblas>`_ (Version 4.3.0 for ROCm 6.3 or later) (Or the ROCm rocblas and rocblas-dev packages).
|
|
|
|
.. <!-- spellcheck-enable -->
|
|
|
|
.. note::
|
|
|
|
It's best to use ROCm packages from the same release where applicable.
|
|
|
|
Downloading rocWMMA
|
|
-------------------------------------------
|
|
|
|
The rocWMMA source code is available from the `rocWMMA GitHub <https://github.com/ROCm/rocm-libraries/tree/develop/projects/rocwmma>`_.
|
|
ROCm version 6.4 or later is required.
|
|
|
|
.. note::
|
|
|
|
The rocWMMA repository for ROCm 7.1.1 and earlier is located at `<https://github.com/ROCm/rocWMMA>`_.
|
|
|
|
To verify the ROCm version installed on an Ubuntu system, use this command:
|
|
|
|
.. code-block:: shell
|
|
|
|
apt show rocm-libs -a
|
|
|
|
On a RHEL-based system, use:
|
|
|
|
.. code-block:: shell
|
|
|
|
yum info rocm-libs
|
|
|
|
The ROCm version has major, minor, and patch fields, possibly followed by a build-specific identifier.
|
|
For example, a ROCm version of ``6.0.0.40000-23`` corresponds to major release = ``6``, minor release = ``0``,
|
|
patch = ``0``, and build identifier ``40000-23``.
|
|
The rocWMMA GitHub repository has branches with names like ``rocm-major.minor.x``,
|
|
where ``major`` and ``minor`` are the same as for the ROCm version.
|
|
To download rocWMMA on ROCm version ``x.y``, use this command:
|
|
|
|
.. tab-set::
|
|
.. tab-item:: ROCm 7.2.0 and later
|
|
|
|
.. code-block:: shell
|
|
|
|
git clone -b release/rocm-rel-x.y https://github.com/ROCm/rocm-libraries.git
|
|
cd projects/rocwmma
|
|
|
|
Alternatively, you can use ``sparse-checkout`` to clone only the rocWMMA project from the ``rocm-libraries`` monorepo. For more information, see `Contributing to the ROCm Libraries <https://github.com/ROCm/rocm-libraries/blob/develop/CONTRIBUTING.md#option-b-clone-the-monorepo-with-sparse-checkout>`_.
|
|
|
|
.. tab-item:: ROCm 7.1.1 and prior
|
|
|
|
.. code-block:: shell
|
|
|
|
git clone -b release/rocm-rel-x.y https://github.com/ROCm/rocWMMA.git
|
|
cd rocWMMA
|
|
|
|
Replace ``x.y`` in the above command with the version of ROCm installed on your machine.
|
|
For example, if you have ROCm 6.0 installed, then replace ``release/rocm-rel-x.y`` with ``release/rocm-rel-6.0``.
|
|
|
|
Build configuration
|
|
-------------------------------------------
|
|
|
|
You can choose to build any of the following combinations:
|
|
|
|
* The rocWMMA library only
|
|
* The library and samples
|
|
* The library and tests (validation and benchmarks)
|
|
* The library, samples, tests, and (optionally) assembly
|
|
|
|
rocWMMA is a header library, so you only need the header includes to call rocWMMA from your code.
|
|
The client contains the tests, samples, and benchmark code.
|
|
|
|
Here are the available options to build the rocWMMA library, with or without clients.
|
|
|
|
.. list-table::
|
|
|
|
* - **Option**
|
|
- **Description**
|
|
- **Default value**
|
|
* - ``GPU_TARGETS``
|
|
- Build code for specific GPU target(s)
|
|
- ``gfx908``; ``gfx90a``; ``gfx942``; ``gfx950``; ``gfx1100``; ``gfx1101``; ``gfx1102``; ``gfx1200``; ``gfx1201``
|
|
* - ``ROCWMMA_BUILD_TESTS``
|
|
- Build the tests
|
|
- ``ON``
|
|
* - ``ROCWMMA_BUILD_SAMPLES``
|
|
- Build the samples
|
|
- ``ON``
|
|
* - ``ROCWMMA_BUILD_ASSEMBLY``
|
|
- Generate assembly files
|
|
- ``OFF``
|
|
* - ``ROCWMMA_BUILD_VALIDATION_TESTS``
|
|
- Build validation tests
|
|
- ``ON`` (requires ``ROCWMMA_BUILD_TESTS=ON``)
|
|
* - ``ROCWMMA_BUILD_REGRESSION_TESTS``
|
|
- Build regression tests
|
|
- ``ON`` (requires ``ROCWMMA_BUILD_TESTS=ON``)
|
|
* - ``ROCWMMA_BUILD_BENCHMARK_TESTS``
|
|
- Build benchmark tests
|
|
- ``OFF`` (requires ``ROCWMMA_BUILD_TESTS=ON``)
|
|
* - ``ROCWMMA_BUILD_EXTENDED_TESTS``
|
|
- Build extended testing coverage
|
|
- ``OFF`` (requires ``ROCWMMA_BUILD_TESTS=ON``)
|
|
* - ``ROCWMMA_VALIDATE_WITH_ROCBLAS``
|
|
- Use rocBLAS for validation tests
|
|
- ``ON`` (requires ``ROCWMMA_BUILD_VALIDATION_TESTS=ON``)
|
|
* - ``ROCWMMA_BENCHMARK_WITH_ROCBLAS``
|
|
- Include rocBLAS benchmarking data
|
|
- ``OFF`` (requires ``ROCWMMA_BUILD_BENCHMARK_TESTS=ON``)
|
|
* - ``ROCWMMA_USE_SYSTEM_GOOGLETEST``
|
|
- Use the system GoogleTest library instead of downloading and building it
|
|
- ``OFF`` (requires ``ROCWMMA_BUILD_TESTS=ON``)
|
|
|
|
Building the library alone
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
By default, the project is configured in Release mode.
|
|
|
|
To build the library alone, run this command:
|
|
|
|
.. code-block:: bash
|
|
|
|
CC=/opt/rocm/bin/amdclang CXX=/opt/rocm/bin/amdclang++ cmake -B <build_dir> . -DROCWMMA_BUILD_TESTS=OFF -DROCWMMA_BUILD_SAMPLES=OFF
|
|
|
|
Here are some other example project configurations:
|
|
|
|
.. csv-table::
|
|
:header: "Configuration","Command"
|
|
:widths: 35, 95
|
|
|
|
"Basic", "``CC=/opt/rocm/bin/amdclang CXX=/opt/rocm/bin/amdclang++ cmake -B <build_dir>``"
|
|
"Targeting gfx908", "``CC=/opt/rocm/bin/amdclang CXX=/opt/rocm/bin/amdclang++ cmake -B <build_dir> . -DGPU_TARGETS=gfx908:xnack-``"
|
|
"Debug build", "``CC=/opt/rocm/bin/amdclang CXX=/opt/rocm/bin/amdclang++ cmake -B <build_dir> . -DCMAKE_BUILD_TYPE=Debug``"
|
|
"Build without rocBLAS (default ``on``)", "``CC=/opt/rocm/bin/amdclang CXX=/opt/rocm/bin/amdclang++ cmake -B <build_dir> . -DROCWMMA_VALIDATE_WITH_ROCBLAS=OFF -DROCWMMA_BENCHMARK_WITH_ROCBLAS=OFF``"
|
|
|
|
After configuration, build the library using this command:
|
|
|
|
.. code-block:: bash
|
|
|
|
cmake --build <build_dir> -- -j<nproc>
|
|
|
|
.. note::
|
|
|
|
It's recommended to use a minimum of 16 threads to build rocWMMA with any tests, for example, using ``-j16``.
|
|
|
|
Building the library and samples
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
To build the library and samples, run the following command:
|
|
|
|
.. code-block:: bash
|
|
|
|
CC=/opt/rocm/bin/amdclang CXX=/opt/rocm/bin/amdclang++ cmake -B <build_dir> . -DROCWMMA_BUILD_TESTS=OFF -DROCWMMA_BUILD_SAMPLES=ON
|
|
|
|
After configuration, build using this command:
|
|
|
|
.. code-block:: bash
|
|
|
|
cmake --build <build_dir> -- -j<nproc>
|
|
|
|
The samples folder in ``<build_dir>`` contains the executables in the table below.
|
|
|
|
================ =================================================================================================================================
|
|
Executable name Description
|
|
================ =================================================================================================================================
|
|
``simple_sgemm`` A simple GEMM operation [D = alpha * (A x B) + beta * C] using the rocWMMA API for single-precision floating point types
|
|
``simple_dgemm`` A simple GEMM operation [D = alpha * (A x B) + beta * C] using the rocWMMA API for double-precision floating point types
|
|
``simple_hgemm`` A simple GEMM operation [D = alpha * (A x B) + beta * C] using the rocWMMA API for half-precision floating point types
|
|
|
|
``perf_sgemm`` An optimized GEMM operation [D = alpha * (A x B) + beta * C] using the rocWMMA API for single-precision floating point types
|
|
``perf_dgemm`` An optimized GEMM operation [D = alpha * (A x B) + beta * C] using the rocWMMA API for double-precision floating point types
|
|
``perf_hgemm`` An optimized GEMM operation [D = alpha * (A x B) + beta * C] using the rocWMMA API for half-precision floating point types
|
|
|
|
``simple_sgemv`` A simple GEMV operation [y = alpha * (A) * x + beta * y] using the rocWMMA API for single-precision floating point types
|
|
``simple_dgemv`` A simple GEMV operation [y = alpha * (A) * x + beta * y] using the rocWMMA API for double-precision floating point types
|
|
|
|
``simple-dlrm`` A simple DLRM operation using the rocWMMA API
|
|
|
|
``hipRTC_gemm`` A simple GEMM operation [D = alpha * (A x B) + beta * C] demonstrating runtime compilation (hipRTC) compatibility
|
|
================ =================================================================================================================================
|
|
|
|
Building the library and tests
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
rocWMMA provides the following test suites:
|
|
|
|
* **DLRM tests**: Cover the dot product interactions between embeddings used in the Deep Learning Recommendation Model (DLRM) implemented with rocWMMA.
|
|
* **GEMM tests**: Cover block-wise Generalized Matrix Multiplication (GEMM) implemented with rocWMMA.
|
|
* **Unit tests**: Cover various aspects of the rocWMMA API and internal functionality.
|
|
|
|
rocWMMA can build both validation and benchmark tests. Validation tests verify the rocWMMA
|
|
implementations against a reference model, providing a ``PASS``
|
|
or ``FAIL`` result. Benchmark tests invoke the tests multiple times. They return
|
|
the average compute throughput in teraflops/sec (TFLOPS/sec) and, in some cases, gauge the efficiency
|
|
as a percentage of the expected peak performance. The library uses
|
|
CPU or rocBLAS methods for validation, when available and benchmarks
|
|
comparisons based on the selected project configurations provided.
|
|
By default, the project is linked with rocBLAS to validate results more efficiently.
|
|
|
|
To build the library and tests, run this command:
|
|
|
|
.. code-block:: bash
|
|
|
|
CC=/opt/rocm/bin/amdclang CXX=/opt/rocm/bin/amdclang++ cmake -B <build_dir> . -DROCWMMA_BUILD_TESTS=ON
|
|
|
|
After configuration, build using this command:
|
|
|
|
.. code-block:: bash
|
|
|
|
cmake --build <build_dir> -- -j<nproc>
|
|
|
|
The tests in ``<build_dir>`` contain executables, as shown in the table below.
|
|
|
|
============================================= ====================================================================================================================================================
|
|
Executable name Description
|
|
============================================= ====================================================================================================================================================
|
|
``dlrm/dlrm_dot_test-*`` A DLRM implementation using the rocWMMA API
|
|
``dlrm/dlrm_dot_lds_test-*`` A DLRM implementation using the rocWMMA API with LDS shared memory
|
|
``gemm/gemm_PGR0_LB0_MP0_SB_NC-*`` A simple GEMM operation [D = alpha * (A x B) + beta * C] using the rocWMMA API
|
|
``gemm/gemm_PGR0_LB0_MP0_MB_NC-*`` A modified GEMM operation where each wave targets a sub-grid of output blocks using the rocWMMA API
|
|
``gemm/gemm_PGR1_LB2_MP0_MB_CP_BLK-*`` A modified GEMM operation where each wave targets a sub-grid of output blocks using LDS memory, the rocWMMA API, and block-level collaboration
|
|
``gemm/gemm_PGR1_LB2_MP0_MB_CP_WV-*`` A modified GEMM operation where each wave targets a sub-grid of output blocks using LDS memory, the rocWMMA API, and wave-level collaboration
|
|
``gemm/gemm_PGR1_LB2_MP0_MB_CP_WG-*`` A modified GEMM operation where each wave targets a sub-grid of output blocks using LDS memory, the rocWMMA API, and workgroup-level collaboration
|
|
``gemm/gemm_PGR0_LB0_MP0_SB_NC_ad_hoc-*`` An adhoc version of ``gemm_PGR0_LB0_MP0_SB_NC-*``
|
|
``gemm/gemm_PGR0_LB0_MP0_MB_NC_ad_hoc-*`` An adhoc version of ``gemm_PGR0_LB0_MP0_MB_NC-*``
|
|
``gemm/gemm_PGR1_LB2_MP0_MB_CP_BLK_ad_hoc-*`` An adhoc version of ``gemm_PGR1_LB2_MP0_MB_CP_BLK-*``
|
|
``gemm/gemm_PGR1_LB2_MP0_MB_CP_WV_ad_hoc-*`` An adhoc version of ``gemm_PGR1_LB2_MP0_MB_CP_WV-*``
|
|
``gemm/gemm_PGR1_LB2_MP0_MB_CP_WG_ad_hoc-*`` An adhoc version of ``gemm_PGR1_LB2_MP0_MB_CP_WG-*``
|
|
``unit/contamination_test`` Tests against contamination of pristine data for loads and stores
|
|
``unit/cross_lane_ops_test`` Tests the cross-lane vector operations
|
|
``unit/fill_fragment_test`` Tests the ``fill_fragment`` API function
|
|
``unit/io_shape_test`` Tests input and output shape meta data
|
|
``unit/io_traits_test`` Tests input and output logistical meta data
|
|
``unit/layout_test`` Tests the accuracy of internal matrix layout patterns
|
|
``unit/layout_traits_test`` Tests the accuracy of internal matrix layout traits
|
|
``unit/load_store_matrix_sync_test`` Tests the ``load_matrix_sync`` and ``store_matrix_sync`` API functions
|
|
``unit/load_store_matrix_coop_sync_test`` Tests the ``load_matrix_coop_sync`` and ``store_matrix_coop_sync`` API functions
|
|
``unit/map_util_test`` Tests the mapping utilities used in rocWMMA implementations
|
|
``unit/pack_util_test`` Tests the vector packing utilities used in rocWMMA implementations
|
|
``unit/transforms_test`` Tests the transform utilities used in rocWMMA implementations
|
|
``unit/tuple_test`` Tests the additional transform utilities used in rocWMMA implementations
|
|
``unit/unpack_util_test`` Tests the vector unpacking utilities used in rocWMMA implementations
|
|
``unit/vector_iterator_test`` Tests the internal vector storage iteration implementation
|
|
``unit/vector_test`` Tests the internal vector storage implementation
|
|
``unit/vector_util_test`` Tests the internal vector manipulation utilities implementation
|
|
============================================= ====================================================================================================================================================
|
|
|
|
.. note::
|
|
|
|
\*= validate: Executables that compare outputs for correctness against reference sources such as CPU or rocBLAS calculations.
|
|
|
|
\*= bench: Executables that measure kernel execution speeds, which might be compared against the rocBLAS references.
|
|
|
|
Build the library, tests, and assembly
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
To build the library and tests with assembly code generation, run the following command:
|
|
|
|
.. code-block:: bash
|
|
|
|
CC=/opt/rocm/bin/amdclang CXX=/opt/rocm/bin/amdclang++ cmake -B <build_dir> . -DROCWMMA_BUILD_ASSEMBLY=ON -DROCWMMA_BUILD_TESTS=ON
|
|
|
|
After configuration, build using this command:
|
|
|
|
.. code-block:: bash
|
|
|
|
cmake --build <build_dir> -- -j<nproc>
|
|
|
|
.. note::
|
|
|
|
The ``assembly`` folder within the ``<build_dir>`` contains a hierarchy of assembly files
|
|
generated by the executables in the format ``test_executable_name.s``.
|
|
These files can be viewed in a text editor.
|
|
|
|
Make targets list
|
|
^^^^^^^^^^^^^^^^^
|
|
|
|
When building rocWMMA during the ``make`` step,
|
|
you can specify the Make targets instead of defaulting to ``make all``.
|
|
The following table highlights the relationships between high-level grouped targets and individual targets.
|
|
|
|
.. tabularcolumns::
|
|
|\X{1}{4}|\X{3}{4}|
|
|
|
|
+-----------------------------------+----------------------------------------------+
|
|
| Group target | Individual targets |
|
|
+===================================+==============================================+
|
|
| | ``simple_sgemm`` |
|
|
| +----------------------------------------------+
|
|
| ``rocwmma_samples`` | ``simple_dgemm`` |
|
|
| +----------------------------------------------+
|
|
| | ``simple_hgemm`` |
|
|
| +----------------------------------------------+
|
|
| | ``perf_sgemm`` |
|
|
| +----------------------------------------------+
|
|
| | ``perf_dgemm`` |
|
|
| +----------------------------------------------+
|
|
| | ``perf_hgemm`` |
|
|
| +----------------------------------------------+
|
|
| | ``simple_sgemv`` |
|
|
| +----------------------------------------------+
|
|
| | ``simple_dgemv`` |
|
|
| +----------------------------------------------+
|
|
| | ``simple_dlrm`` |
|
|
| +----------------------------------------------+
|
|
| | ``hipRTC_gemm`` |
|
|
+-----------------------------------+----------------------------------------------+
|
|
| | ``gemm_PGR0_LB0_MP0_SB_NC-validate`` |
|
|
| +----------------------------------------------+
|
|
| | ``gemm_PGR0_LB0_MP0_SB_NC_ad_hoc-validate`` |
|
|
| +----------------------------------------------+
|
|
| | ``gemm_PGR0_LB0_MP0_MB_NC-validate`` |
|
|
| +----------------------------------------------+
|
|
| | ``gemm_PGR0_LB0_MP0_MB_NC_ad_hoc-validate`` |
|
|
| +----------------------------------------------+
|
|
| ``rocwmma_gemm_tests_validate`` | ``gemm_PGR1_LB2_MP0_MB_CP_BLK-validate`` |
|
|
| +----------------------------------------------+
|
|
| | ``gemm_PGR1_LB2_MP0_MB_CP_WV-validate`` |
|
|
| +----------------------------------------------+
|
|
| | ``gemm_PGR1_LB2_MP0_MB_CP_WG-validate`` |
|
|
| +----------------------------------------------+
|
|
| | ``gemm_PGR1_LB2_MP0_MB_CP_ad_hoc-validate`` |
|
|
+-----------------------------------+----------------------------------------------+
|
|
| | ``gemm_PGR0_LB0_MP0_SB_NC-bench`` |
|
|
| +----------------------------------------------+
|
|
| | ``gemm_PGR0_LB0_MP0_SB_NC_ad_hoc-bench`` |
|
|
| +----------------------------------------------+
|
|
| | ``gemm_PGR0_LB0_MP0_MB_NC-bench`` |
|
|
| +----------------------------------------------+
|
|
| | ``gemm_PGR0_LB0_MP0_MB_NC_ad_hoc-bench`` |
|
|
| +----------------------------------------------+
|
|
| ``rocwmma_gemm_tests_bench`` | ``gemm_PGR1_LB2_MP0_MB_CP_BLK-bench`` |
|
|
| +----------------------------------------------+
|
|
| | ``gemm_PGR1_LB2_MP0_MB_CP_WV-bench`` |
|
|
| +----------------------------------------------+
|
|
| | ``gemm_PGR1_LB2_MP0_MB_CP_WG-bench`` |
|
|
| +----------------------------------------------+
|
|
| | ``gemm_PGR1_LB2_MP0_MB_CP_ad_hoc-bench`` |
|
|
+-----------------------------------+----------------------------------------------+
|
|
| | ``dlrm_dot_test-validate`` |
|
|
| ``rocwmma_dlrm_tests_validate`` +----------------------------------------------+
|
|
| | ``dlrm_dot_lds_test-validate`` |
|
|
+-----------------------------------+----------------------------------------------+
|
|
| | ``dlrm_dot_test-bench`` |
|
|
| ``rocwmma_dlrm_tests_bench`` +----------------------------------------------+
|
|
| | ``dlrm_dot_lds_test-bench`` |
|
|
+-----------------------------------+----------------------------------------------+
|
|
| | ``contamination_test`` |
|
|
| +----------------------------------------------+
|
|
| | ``layout_test`` |
|
|
| +----------------------------------------------+
|
|
| | ``layout_traits_test`` |
|
|
| +----------------------------------------------+
|
|
| | ``map_util_test`` |
|
|
| +----------------------------------------------+
|
|
| | ``load_store_matrix_sync_test`` |
|
|
| +----------------------------------------------+
|
|
| ``rocwmma_unit_tests`` | ``load_store_matrix_coop_sync_test`` |
|
|
| +----------------------------------------------+
|
|
| | ``fill_fragment_test`` |
|
|
| +----------------------------------------------+
|
|
| | ``vector_iterator_test`` |
|
|
| +----------------------------------------------+
|
|
| | ``vector_test`` |
|
|
| +----------------------------------------------+
|
|
| | ``vector_util_test`` |
|
|
| +----------------------------------------------+
|
|
| | ``pack_util_test`` |
|
|
| +----------------------------------------------+
|
|
| | ``io_traits_test`` |
|
|
| +----------------------------------------------+
|
|
| | ``cross_lane_ops_test`` |
|
|
| +----------------------------------------------+
|
|
| | ``io_shape_test`` |
|
|
| +----------------------------------------------+
|
|
| | ``tuple_test`` |
|
|
| +----------------------------------------------+
|
|
| | ``transforms_test`` |
|
|
| +----------------------------------------------+
|
|
| | ``unpack_util_test`` |
|
|
+-----------------------------------+----------------------------------------------+
|
|
|
|
Build performance
|
|
-------------------------------------------
|
|
|
|
Depending on the resources available to the build machine and the selected build configuration,
|
|
rocWMMA build times can take an hour or more. Here are some things you can do to reduce build times:
|
|
|
|
* Target a specific GPU, for instance, with ``-D GPU_TARGETS=gfx908:xnack-``.
|
|
* Use a large number of threads, for instance, ``-j32``.
|
|
* Select ``ROCWMMA_BUILD_ASSEMBLY=OFF``.
|
|
* Select ``ROCWMMA_BUILD_DOCS=OFF``.
|
|
* Select ``ROCWMMA_BUILD_EXTENDED_TESTS=OFF``.
|
|
* Specify one of ``ROCWMMA_BUILD_VALIDATION_TESTS`` or ``ROCWMMA_BUILD_BENCHMARK_TESTS`` as ``ON`` and the other as ``OFF`` instead of building both.
|
|
* During the ``make`` command, build a specific target, for instance, ``rocwmma_gemm_tests``.
|
|
|
|
Test runtimes
|
|
-------------------------------------------
|
|
|
|
Depending on the resources available to the machine running the selected tests,
|
|
rocWMMA test runtimes can last an hour or more. Here are some things you can do to reduce test runtimes:
|
|
|
|
* CTest runs the entire test suite, but you can invoke tests individually by name.
|
|
* Use GoogleTest filters to target specific test cases:
|
|
|
|
.. code-block:: bash
|
|
|
|
<test_exe> --gtest_filter=\*name_filter\*
|
|
|
|
* Use ad hoc tests to focus on a specific set of parameters.
|
|
* Manually adjust the test case coverage.
|
|
|
|
Test verbosity and output redirection
|
|
-------------------------------------------
|
|
|
|
GEMM tests support logging arguments to control verbosity and output redirection.
|
|
|
|
.. code-block:: bash
|
|
|
|
<test_exe> --output_stream "output.csv" --omit 1
|
|
|
|
.. tabularcolumns::
|
|
|C|C|C|
|
|
|
|
+---------------------------+---------------------------------------+--------------------------------------------+
|
|
|Compact |Verbose | Description |
|
|
+===========================+=======================================+============================================+
|
|
| ``-os <output_file>.csv`` | ``--output_stream <output_file>.csv`` | redirect GEMM testing output to CSV file |
|
|
+---------------------------+---------------------------------------+--------------------------------------------+
|
|
| | | code = 1: Omit gtest SKIPPED tests |
|
|
| | +--------------------------------------------+
|
|
| | ``--omit <code>`` | code = 2: Omit gtest FAILED tests |
|
|
| | +--------------------------------------------+
|
|
| | | code = 4: Omit gtest PASSED tests |
|
|
| | +--------------------------------------------+
|
|
| | | code = 8: Omit all gtest output |
|
|
| | +--------------------------------------------+
|
|
| | | code = <N>: OR'd combination of 1, 2, 4 |
|
|
+---------------------------+---------------------------------------+--------------------------------------------+
|