rocBLAS User Guide

Contents:

• 1. Getting Started Guide
  • 1.1. Introduction
    • 1.1.1. Documentation Roadmap
    • 1.1.2. Use of Tensile
• 2. Installation and Building for Linux
  • 2.1. Prerequisites
  • 2.2. Installing Prebuilt Packages
  • 2.3. Building and Installing rocBLAS
    • 2.3.1. Requirements
    • 2.3.2. Download rocBLAS
    • 2.3.3. Library Dependencies
    • 2.3.4. Build Library dependencies + Library
    • 2.3.5. Build Library Dependencies + Client Dependencies + Library + Client
    • 2.3.6. Build Clients without Library
• 3. Installation and Building for Windows
  • 3.1. Prerequisites
  • 3.2. Installing Prebuilt Packages
  • 3.3. Building and Installing rocBLAS
    • 3.3.1. Requirements
    • 3.3.2. Download rocBLAS
    • 3.3.3. Building
    • 3.3.4. Library Dependencies
    • 3.3.5. Build Library dependencies + Library
    • 3.3.6. Build Library Dependencies + Client Dependencies + Library + Client
    • 3.3.7. Build Clients without Library
• 4. API Reference Guide
  • 4.1. Introduction
  • 4.2. rocBLAS API and Legacy BLAS Functions
    • 4.2.1. Rules for Obtaining rocBLAS API from Legacy BLAS
    • 4.2.2. Example Code
    • 4.2.3. LP64 Interface
    • 4.2.4. Column-major Storage and 1 Based Indexing
    • 4.2.5. Pointer Mode
    • 4.2.6. Asynchronous API
    • 4.2.7. Complex Number Data Types
    • 4.2.8. MI100 (gfx908) Considerations
    • 4.2.9. MI200 (gfx90a) Considerations
  • 4.3. Deprecations by version
    • 4.3.1. Announced in rocBLAS 2.45
      • 4.3.1.1. Replace is_complex by rocblas_is_complex
      • 4.3.1.2. Replace truncate with rocblas_truncate
    • 4.3.2. Announced in rocBLAS 2.46
      • 4.3.2.1. Remove ability for hipBLAS to set rocblas_int8_type_for_hipblas
• 5. Using rocBLAS API
  • 5.1. rocBLAS Datatypes
    • 5.1.1. rocblas_handle
    • 5.1.2. rocblas_int
    • 5.1.3. rocblas_stride
    • 5.1.4. rocblas_half
    • 5.1.5. rocblas_bfloat16
    • 5.1.6. rocblas_float_complex
    • 5.1.7. rocblas_double_complex
  • 5.2. rocBLAS Enumeration
    • 5.2.1. rocblas_operation
    • 5.2.2. rocblas_fill
    • 5.2.3. rocblas_diagonal
    • 5.2.4. rocblas_side
    • 5.2.5. rocblas_status
    • 5.2.6. rocblas_datatype
    • 5.2.7. rocblas_pointer_mode
    • 5.2.8. rocblas_atomics_mode
    • 5.2.9. rocblas_layer_mode
    • 5.2.10. rocblas_gemm_algo
    • 5.2.11. rocblas_gemm_flags
  • 5.3. rocBLAS Helper functions
    • 5.3.1. Auxiliary Functions
    • 5.3.2. Device Memory Allocation Functions
    • 5.3.3. Build Information Functions
  • 5.4. rocBLAS Level-1 functions
    • 5.4.1. rocblas_iXamax + batched, strided_batched
    • 5.4.2. rocblas_iXamin + batched, strided_batched
    • 5.4.3. rocblas_Xasum + batched, strided_batched
    • 5.4.4. rocblas_Xaxpy + batched, strided_batched
    • 5.4.5. rocblas_Xcopy + batched, strided_batched
    • 5.4.6. rocblas_Xdot + batched, strided_batched
    • 5.4.7. rocblas_Xnrm2 + batched, strided_batched
    • 5.4.8. rocblas_Xrot + batched, strided_batched
    • 5.4.9. rocblas_Xrotg + batched, strided_batched
    • 5.4.10. rocblas_Xrotm + batched, strided_batched
    • 5.4.11. rocblas_Xrotmg + batched, strided_batched
    • 5.4.12. rocblas_Xscal + batched, strided_batched
    • 5.4.13. rocblas_Xswap + batched, strided_batched
  • 5.5. rocBLAS Level-2 functions
    • 5.5.1. rocblas_Xgbmv + batched, strided_batched
    • 5.5.2. rocblas_Xgemv + batched, strided_batched
    • 5.5.3. rocblas_Xger + batched, strided_batched
    • 5.5.4. rocblas_Xsbmv + batched, strided_batched
    • 5.5.5. rocblas_Xspmv + batched, strided_batched
    • 5.5.6. rocblas_Xspr + batched, strided_batched
    • 5.5.7. rocblas_Xspr2 + batched, strided_batched
    • 5.5.8. rocblas_Xsymv + batched, strided_batched
    • 5.5.9. rocblas_Xsyr + batched, strided_batched
    • 5.5.10. rocblas_Xsyr2 + batched, strided_batched
    • 5.5.11. rocblas_Xtbmv + batched, strided_batched
    • 5.5.12. rocblas_Xtbsv + batched, strided_batched
    • 5.5.13. rocblas_Xtpmv + batched, strided_batched
    • 5.5.14. rocblas_Xtpsv + batched, strided_batched
    • 5.5.15. rocblas_Xtrmv + batched, strided_batched
    • 5.5.16. rocblas_Xtrsv + batched, strided_batched
    • 5.5.17. rocblas_Xhemv + batched, strided_batched
    • 5.5.18. rocblas_Xhbmv + batched, strided_batched
    • 5.5.19. rocblas_Xhpmv + batched, strided_batched
    • 5.5.20. rocblas_Xher + batched, strided_batched
    • 5.5.21. rocblas_Xher2 + batched, strided_batched
    • 5.5.22. rocblas_Xhpr + batched, strided_batched
    • 5.5.23. rocblas_Xhpr2 + batched, strided_batched
  • 5.6. rocBLAS Level-3 functions
    • 5.6.1. rocblas_Xgemm + batched, strided_batched
    • 5.6.2. rocblas_Xsymm + batched, strided_batched
    • 5.6.3. rocblas_Xsyrk + batched, strided_batched
    • 5.6.4. rocblas_Xsyr2k + batched, strided_batched
    • 5.6.5. rocblas_Xsyrkx + batched, strided_batched
    • 5.6.6. rocblas_Xtrmm + batched, strided_batched
    • 5.6.7. rocblas_Xtrsm + batched, strided_batched
    • 5.6.8. rocblas_Xhemm + batched, strided_batched
    • 5.6.9. rocblas_Xherk + batched, strided_batched
    • 5.6.10. rocblas_Xher2k + batched, strided_batched
    • 5.6.11. rocblas_Xherkx + batched, strided_batched
    • 5.6.12. rocblas_Xtrtri + batched, strided_batched
  • 5.7. rocBLAS Extension
    • 5.7.1. rocblas_axpy_ex + batched, strided_batched
    • 5.7.2. rocblas_dot_ex + batched, strided_batched
    • 5.7.3. rocblas_dotc_ex + batched, strided_batched
    • 5.7.4. rocblas_nrm2_ex + batched, strided_batched
    • 5.7.5. rocblas_rot_ex + batched, strided_batched
    • 5.7.6. rocblas_scal_ex + batched, strided_batched
    • 5.7.7. rocblas_gemm_ex + batched, strided_batched
    • 5.7.8. rocblas_gemm_ext2
    • 5.7.9. rocblas_trsm_ex + batched, strided_batched
    • 5.7.10. rocblas_Xgeam + batched, strided_batched
    • 5.7.11. rocblas_Xdgmm + batched, strided_batched
  • 5.8. rocBLAS Beta Features
    • 5.8.1. rocblas_gemm_ex_get_solutions + batched, strided_batched
  • 5.9. Graph Support for rocBLAS
    • 5.9.1. Functions Unsupported with Graph Capture
  • 5.10. Device Memory Allocation in rocBLAS
    • 5.10.1. Environment Variable for Preallocating
    • 5.10.2. Functions for Manually Setting Memory Size
    • 5.10.3. Function for Setting User Owned Workspace
    • 5.10.4. Functions for Finding How Much Memory Is Required
    • 5.10.5. rocBLAS Function Return Values for Insufficient Device Memory
    • 5.10.6. Stream-Ordered Memory Allocation
      • 5.10.6.1. Environment Variable to Enable Stream-Ordered Memory Allocation
      • 5.10.6.2. Supports Switching Streams Without Any Synchronization
  • 5.11. Logging in rocBLAS
• 6. Programmer’s Guide
  • 6.1. Library Source Code Organization
    • 6.1.1. The library Directory
      • 6.1.1.1. library/include
      • 6.1.1.2. library/src/blas[1,2,3]
      • 6.1.1.3. library/src/blas3/Tensile
      • 6.1.1.4. library/src/blas_ex
      • 6.1.1.5. library/src/include
    • 6.1.2. The clients Directory
      • 6.1.2.1. clients/gtest
      • 6.1.2.2. clients/benchmarks
      • 6.1.2.3. clients/include
      • 6.1.2.4. clients/common
      • 6.1.2.5. clients/samples
    • 6.1.3. Infrastructure
  • 6.2. Handle, Stream, and Device Management
    • 6.2.1. Handle
    • 6.2.2. Stream and Device Management
    • 6.2.3. Multiple Streams and Multiple Devices
  • 6.3. Device Memory Allocation
    • 6.3.1. Requirements
    • 6.3.2. Design
    • 6.3.3. Answering Device Memory Size Queries in Function That Needs Memory
      • 6.3.3.1. Example
      • 6.3.3.2. Function
      • 6.3.3.3. Function
      • 6.3.3.4. Function
    • 6.3.4. Answering Device Memory Size Queries in Function That Does Not Need Memory
      • 6.3.4.1. Example
      • 6.3.4.2. Macro
    • 6.3.5. rocBLAS Kernel Device Memory Allocation
      • 6.3.5.1. Example
      • 6.3.5.2. Example
      • 6.3.5.3. Function
    • 6.3.6. Performance Degrade
      • 6.3.6.1. Example
  • 6.4. Thread Safe Logging
  • 6.5. rocBLAS Numerical Checking
  • 6.6. rocBLAS Order of Argument Checking and Logging
    • 6.6.1. Legacy BLAS
    • 6.6.2. rocBLAS
    • 6.6.3. rocBLAS has the Following Differences When Compared To Legacy BLAS
    • 6.6.4. To Accommodate the Additions
    • 6.6.5. Device Memory Size Queries
      • 6.6.5.1. Logging
    • 6.6.6. rocBLAS Control Flow
    • 6.6.7. Legacy L1 BLAS “single vector”
    • 6.6.8. Legacy L1 BLAS “two vector”
    • 6.6.9. Legacy L2 BLAS
    • 6.6.10. Legacy L3 BLAS
  • 6.7. rocBLAS Benchmarking and Testing
    • 6.7.1. rocblas-bench
    • 6.7.2. rocblas-test
    • 6.7.3. Add New rocBLAS Unit Test
• 7. Contributor’s Guide
  • 7.1. Pull-request guidelines
  • 7.2. Coding Guidelines
    • 7.2.1. Format
  • 7.3. Static Code Analysis
• 8. Acknowledgement
• 9. Disclaimer
  • 9.1. AMD’s standard legal Disclaimer
  • 9.2. Third Party Disclaimer