hipSPARSELt User Guide

Contents:

• 1. Introduction
• 2. Installation and Building for Linux
  • 2.1. Prerequisites
  • 2.2. Installing pre-built packages
  • 2.3. Building hipSPARSELt from source
    • 2.3.1. Download hipSPARSELt
    • 2.3.2. Using install.sh to build hipSPARSELt with dependencies
    • 2.3.3. Using install.sh to build hipSPARSELt with dependencies and clients
    • 2.3.4. Using individual commands to build hipSPARSELt
    • 2.3.5. Simple Test
  • 2.4. Supported Targets
• 3. API Reference Guide
  • 3.1. Introduction
  • 3.2. hipSPARSELt API
    • 3.2.1. Device and Stream Management
    • 3.2.2. Asynchronous Execution
    • 3.2.3. HIP Device Management
    • 3.2.4. HIP Stream Management
    • 3.2.5. Multiple Streams and Multiple Devices
    • 3.2.6. Storage Formats
      • 3.2.6.1. Structured sparsity storage format
• 4. Using hipSPARSELt API
  • 4.1. Types
    • 4.1.1. hipsparseLtHandle_t
      • hipsparseLtHandle_t
    • 4.1.2. hipsparseLtMatDescriptor_t
      • hipsparseLtMatDescriptor_t
    • 4.1.3. hipsparseLtMatmulDescriptor_t
      • hipsparseLtMatmulDescriptor_t
    • 4.1.4. hipsparseLtMatmulAlgSelection_t
      • hipsparseLtMatmulAlgSelection_t
    • 4.1.5. hipsparseLtMatmulPlan_t
      • hipsparseLtMatmulPlan_t
    • 4.1.6. hipsparseLtDatatype_t
      • hipsparseLtDatatype_t
        • hipsparseLtDatatype_t::HIPSPARSELT_R_16F
        • hipsparseLtDatatype_t::HIPSPARSELT_R_32F
        • hipsparseLtDatatype_t::HIPSPARSELT_R_8I
        • hipsparseLtDatatype_t::HIPSPARSELT_R_16BF
        • hipsparseLtDatatype_t::HIPSPARSELT_R_8F
        • hipsparseLtDatatype_t::HIPSPARSELT_R_8BF
    • 4.1.7. hipsparseLtSparsity_t
      • hipsparseLtSparsity_t
        • hipsparseLtSparsity_t::HIPSPARSELT_SPARSITY_50_PERCENT
    • 4.1.8. hipsparseLtMatDescAttribute_t
      • hipsparseLtMatDescAttribute_t
        • hipsparseLtMatDescAttribute_t::HIPSPARSELT_MAT_NUM_BATCHES
        • hipsparseLtMatDescAttribute_t::HIPSPARSELT_MAT_BATCH_STRIDE
    • 4.1.9. hipsparseLtComputetype_t
      • hipsparseLtComputetype_t
        • hipsparseLtComputetype_t::HIPSPARSELT_COMPUTE_16F
        • hipsparseLtComputetype_t::HIPSPARSELT_COMPUTE_32I
        • hipsparseLtComputetype_t::HIPSPARSELT_COMPUTE_32F
        • hipsparseLtComputetype_t::HIPSPARSELT_COMPUTE_TF32
        • hipsparseLtComputetype_t::HIPSPARSELT_COMPUTE_TF32_FAST
    • 4.1.10. hipsparseLtMatmulDescAttribute_t
      • hipsparseLtMatmulDescAttribute_t
        • hipsparseLtMatmulDescAttribute_t::HIPSPARSELT_MATMUL_ACTIVATION_RELU
        • hipsparseLtMatmulDescAttribute_t::HIPSPARSELT_MATMUL_ACTIVATION_RELU_UPPERBOUND
        • hipsparseLtMatmulDescAttribute_t::HIPSPARSELT_MATMUL_ACTIVATION_RELU_THRESHOLD
        • hipsparseLtMatmulDescAttribute_t::HIPSPARSELT_MATMUL_ACTIVATION_GELU
        • hipsparseLtMatmulDescAttribute_t::HIPSPARSELT_MATMUL_ACTIVATION_GELU_SCALING
        • hipsparseLtMatmulDescAttribute_t::HIPSPARSELT_MATMUL_ALPHA_VECTOR_SCALING
        • hipsparseLtMatmulDescAttribute_t::HIPSPARSELT_MATMUL_BETA_VECTOR_SCALING
        • hipsparseLtMatmulDescAttribute_t::HIPSPARSELT_MATMUL_BIAS_STRIDE
        • hipsparseLtMatmulDescAttribute_t::HIPSPARSELT_MATMUL_BIAS_POINTER
        • hipsparseLtMatmulDescAttribute_t::HIPSPARSELT_MATMUL_ACTIVATION_ABS
        • hipsparseLtMatmulDescAttribute_t::HIPSPARSELT_MATMUL_ACTIVATION_LEAKYRELU
        • hipsparseLtMatmulDescAttribute_t::HIPSPARSELT_MATMUL_ACTIVATION_LEAKYRELU_ALPHA
        • hipsparseLtMatmulDescAttribute_t::HIPSPARSELT_MATMUL_ACTIVATION_SIGMOID
        • hipsparseLtMatmulDescAttribute_t::HIPSPARSELT_MATMUL_ACTIVATION_TANH
        • hipsparseLtMatmulDescAttribute_t::HIPSPARSELT_MATMUL_ACTIVATION_TANH_ALPHA
        • hipsparseLtMatmulDescAttribute_t::HIPSPARSELT_MATMUL_ACTIVATION_TANH_BETA
        • hipsparseLtMatmulDescAttribute_t::HIPSPARSELT_MATMUL_BIAS_TYPE
    • 4.1.11. hipsparseLtMatmulAlg_t
      • hipsparseLtMatmulAlg_t
        • hipsparseLtMatmulAlg_t::HIPSPARSELT_MATMUL_ALG_DEFAULT
    • 4.1.12. hipsparseLtPruneAlg_t
      • hipsparseLtMatmulAlgAttribute_t
        • hipsparseLtMatmulAlgAttribute_t::HIPSPARSELT_MATMUL_ALG_CONFIG_ID
        • hipsparseLtMatmulAlgAttribute_t::HIPSPARSELT_MATMUL_ALG_CONFIG_MAX_ID
        • hipsparseLtMatmulAlgAttribute_t::HIPSPARSELT_MATMUL_SEARCH_ITERATIONS
        • hipsparseLtMatmulAlgAttribute_t::HIPSPARSELT_MATMUL_SPLIT_K
        • hipsparseLtMatmulAlgAttribute_t::HIPSPARSELT_MATMUL_SPLIT_K_MODE
        • hipsparseLtMatmulAlgAttribute_t::HIPSPARSELT_MATMUL_SPLIT_K_BUFFERS
    • 4.1.13. hipsparseLtMatmulAlgAttribute_t
      • hipsparseLtPruneAlg_t
        • hipsparseLtPruneAlg_t::HIPSPARSELT_PRUNE_SPMMA_TILE
        • hipsparseLtPruneAlg_t::HIPSPARSELT_PRUNE_SPMMA_STRIP
    • 4.1.14. hipsparseLtSplitKMode_t
      • hipsparseLtSplitKMode_t
        • hipsparseLtSplitKMode_t::HIPSPARSELT_SPLIT_K_MODE_ONE_KERNEL
        • hipsparseLtSplitKMode_t::HIPSPARSELT_SPLIT_K_MODE_TWO_KERNELS
  • 4.2. Exported Sparse Functions
    • 4.2.1. Library Management Functions
    • 4.2.2. Matrix Descriptor Functions
    • 4.2.3. Matmul Descriptor Functions
    • 4.2.4. Matmul Algorithm Functions
    • 4.2.5. Matmul Functions
    • 4.2.6. Helper Functions
  • 4.3. Asynchronous API
  • 4.4. Library Management Functions
    • 4.4.1. hipsparseLtInit()
      • hipsparseLtInit()
    • 4.4.2. hipsparseLtDestroy()
      • hipsparseLtDestroy()
    • 4.4.3. hipsparseLtGetVersion()
      • hipsparseLtGetVersion()
    • 4.4.4. hipsparseLtGetProperty()
      • hipsparseLtGetProperty()
  • 4.5. Matrix Descriptor Functions
    • 4.5.1. hipsparseLtDenseDescriptorInit()
      • hipsparseLtDenseDescriptorInit()
    • 4.5.2. hipsparseLtStructuredDescriptorInit()
      • hipsparseLtStructuredDescriptorInit()
    • 4.5.3. hipsparseLtMatDescriptorDestroy()
      • hipsparseLtMatDescriptorDestroy()
    • 4.5.4. hipsparseLtMatDescSetAttribute()
      • hipsparseLtMatDescSetAttribute()
    • 4.5.5. hipsparseLtMatDescGetAttribute()
      • hipsparseLtMatDescGetAttribute()
  • 4.6. Matmul Descriptor Functions
    • 4.6.1. hipsparseLtMatmulDescriptorInit()
      • hipsparseLtMatmulDescriptorInit()
    • 4.6.2. hipsparseLtMatmulDescSetAttribute()
      • hipsparseLtMatmulDescSetAttribute()
    • 4.6.3. hipsparseLtMatmulDescGetAttribute()
      • hipsparseLtMatmulDescGetAttribute()
  • 4.7. Matmul Algorithm Functions
    • 4.7.1. hipsparseLtMatmulAlgSelectionInit()
      • hipsparseLtMatmulAlgSelectionInit()
    • 4.7.2. hipsparseLtMatmulAlgSetAttribute()
      • hipsparseLtMatmulAlgSetAttribute()
    • 4.7.3. hipsparseLtMatmulAlgGetAttribute()
      • hipsparseLtMatmulAlgGetAttribute()
  • 4.8. Matmul Functions
    • 4.8.1. hipsparseLtMatmulGetWorkspace()
      • hipsparseLtMatmulGetWorkspace()
    • 4.8.2. hipsparseLtMatmulPlanInit()
      • hipsparseLtMatmulPlanInit()
    • 4.8.3. hipsparseLtMatmulPlanDestroy()
      • hipsparseLtMatmulPlanDestroy()
    • 4.8.4. hipsparseLtMatmul()
      • hipsparseLtMatmul()
    • 4.8.5. hipsparseLtMatmulSearch()
      • hipsparseLtMatmulSearch()
  • 4.9. Helper Functions
    • 4.9.1. hipsparseLtSpMMAPrune()
      • hipsparseLtSpMMAPrune()
    • 4.9.2. hipsparseLtSpMMAPruneCheck()
      • hipsparseLtSpMMAPruneCheck()
    • 4.9.3. hipsparseLtSpMMAPrune2()
      • hipsparseLtSpMMAPrune2()
    • 4.9.4. hipsparseLtSpMMAPruneCheck2()
      • hipsparseLtSpMMAPruneCheck2()
    • 4.9.5. hipsparseLtSpMMACompressedSize()
      • hipsparseLtSpMMACompressedSize()
    • 4.9.6. hipsparseLtSpMMACompress()
      • hipsparseLtSpMMACompress()
    • 4.9.7. hipsparseLtSpMMACompressedSize2()
      • hipsparseLtSpMMACompressedSize2()
    • 4.9.8. hipsparseLtSpMMACompress2()
      • hipsparseLtSpMMACompress2()