/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hipsparselt/checkouts/docs-6.2.2/library/include/hipsparselt.h Source File

• library
• include

hipsparselt.h

Go to the documentation of this file.

1 /*******************************************************************************

2  *

3  * MIT License

4  *

5  * Copyright (c) 2022-2023 Advanced Micro Devices, Inc.

6  *

7  * Permission is hereby granted, free of charge, to any person obtaining a copy

8  * of this software and associated documentation files (the "Software"), to deal

9  * in the Software without restriction, including without limitation the rights

10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

11  * copies of the Software, and to permit persons to whom the Software is

12  * furnished to do so, subject to the following conditions:

13  *

14  * The above copyright notice and this permission notice shall be included in

15  * all copies or substantial portions of the Software.

16  *

17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

23  * SOFTWARE.

24  *

25  *******************************************************************************/

26 

40 //

41 

42 

68 #pragma once

69 #ifndef _HIPSPARSELT_H_

70 #define _HIPSPARSELT_H_

71 

72 #include <hipsparse/hipsparse.h>

73 #include <hipsparselt/hipsparselt-export.h>

74 #include <hipsparselt/hipsparselt-version.h>

75 

76 #include <hip/hip_complex.h>

77 #include <hip/hip_runtime_api.h>

78 

79 #if defined(__HIP_PLATFORM_AMD__)

80 #include <hip/hip_bfloat16.h>

81 #include <hip/hip_fp16.h>

82 #include <hip/library_types.h>

83 #else

84 #include <cuda_bf16.h>

85 #include <cuda_fp16.h>

86 #endif

87 

88 /* Opaque structures holding information */

89 // clang-format off

90 

91 #if defined(__HIP_PLATFORM_AMD__)

101 typedef struct hipsparseLtHandle_t {uint8_t data[11024];} hipsparseLtHandle_t;

102 

112 typedef struct hipsparseLtMatDescriptor_t {uint8_t data[11024];} hipsparseLtMatDescriptor_t;

113 

122 typedef struct hipsparseLtMatmulDescriptor_t {uint8_t data[11024];} hipsparseLtMatmulDescriptor_t;

123 

130 typedef struct hipsparseLtMatmulAlgSelection_t {uint8_t data[11024];} hipsparseLtMatmulAlgSelection_t;

131 

141 typedef struct hipsparseLtMatmulPlan_t {uint8_t data[11024];} hipsparseLtMatmulPlan_t;

142 #elif defined(__HIP_PLATFORM_NVIDIA__)

143 typedef __nv_bfloat16 hip_bfloat16;

144 typedef struct {uint8_t data[11024];} hipsparseLtHandle_t;

145 typedef struct {uint8_t data[11024];} hipsparseLtMatDescriptor_t;

146 typedef struct {uint8_t data[11024];} hipsparseLtMatmulDescriptor_t;

147 typedef struct {uint8_t data[11024];} hipsparseLtMatmulAlgSelection_t;

148 typedef struct {uint8_t data[11024];} hipsparseLtMatmulPlan_t;

149 #endif

150 

151 

152 /* Types definitions */

160 typedef enum

161 {

162  HIPSPARSELT_R_16F = 150,

163  HIPSPARSELT_R_32F = 151,

164  HIPSPARSELT_R_8I = 160,

165  HIPSPARSELT_R_16BF = 168,

166  HIPSPARSELT_R_8F = 170,

167  HIPSPARSELT_R_8BF = 171,

168 } hipsparseLtDatatype_t;

169 

178 typedef enum {

179  HIPSPARSELT_SPARSITY_50_PERCENT

181 } hipsparseLtSparsity_t;

182 

190 typedef enum {

191  HIPSPARSELT_MAT_NUM_BATCHES,

192  HIPSPARSELT_MAT_BATCH_STRIDE,

193 } hipsparseLtMatDescAttribute_t;

194 

200 typedef enum {

201  HIPSPARSELT_COMPUTE_16F = 0,

202  HIPSPARSELT_COMPUTE_32I,

203  HIPSPARSELT_COMPUTE_32F,

204  HIPSPARSELT_COMPUTE_TF32,

206  HIPSPARSELT_COMPUTE_TF32_FAST

208 } hipsparseLtComputetype_t;

209 

217 typedef enum {

218  HIPSPARSELT_MATMUL_ACTIVATION_RELU = 0,

219  HIPSPARSELT_MATMUL_ACTIVATION_RELU_UPPERBOUND = 1,

220  HIPSPARSELT_MATMUL_ACTIVATION_RELU_THRESHOLD = 2,

221  HIPSPARSELT_MATMUL_ACTIVATION_GELU = 3,

222  HIPSPARSELT_MATMUL_ACTIVATION_GELU_SCALING = 4,

223  HIPSPARSELT_MATMUL_ALPHA_VECTOR_SCALING = 5,

224  HIPSPARSELT_MATMUL_BETA_VECTOR_SCALING = 6,

225  HIPSPARSELT_MATMUL_BIAS_STRIDE = 7,

226  HIPSPARSELT_MATMUL_BIAS_POINTER = 8,

227  HIPSPARSELT_MATMUL_ACTIVATION_ABS = 9,

228  HIPSPARSELT_MATMUL_ACTIVATION_LEAKYRELU = 10,

229  HIPSPARSELT_MATMUL_ACTIVATION_LEAKYRELU_ALPHA = 11,

230  HIPSPARSELT_MATMUL_ACTIVATION_SIGMOID = 12,

231  HIPSPARSELT_MATMUL_ACTIVATION_TANH = 13,

232  HIPSPARSELT_MATMUL_ACTIVATION_TANH_ALPHA = 14,

233  HIPSPARSELT_MATMUL_ACTIVATION_TANH_BETA = 15,

234  HIPSPARSELT_MATMUL_BIAS_TYPE = 16,

238 } hipsparseLtMatmulDescAttribute_t;

239 

246 typedef enum {

247  HIPSPARSELT_MATMUL_ALG_DEFAULT

248 } hipsparseLtMatmulAlg_t;

249 

257 typedef enum {

258  HIPSPARSELT_MATMUL_ALG_CONFIG_ID = 0, // READ/WRITE

259  HIPSPARSELT_MATMUL_ALG_CONFIG_MAX_ID = 1, // READ-ONLY

260  HIPSPARSELT_MATMUL_SEARCH_ITERATIONS = 2, // READ/WRITE

261  HIPSPARSELT_MATMUL_SPLIT_K = 3,

262  HIPSPARSELT_MATMUL_SPLIT_K_MODE = 4,

263  HIPSPARSELT_MATMUL_SPLIT_K_BUFFERS = 5,

264 } hipsparseLtMatmulAlgAttribute_t;

265 

272 typedef enum {

273  HIPSPARSELT_PRUNE_SPMMA_TILE = 0,

274  HIPSPARSELT_PRUNE_SPMMA_STRIP = 1,

275 } hipsparseLtPruneAlg_t;

276 

283 typedef enum {

284  HIPSPARSELT_SPLIT_K_MODE_ONE_KERNEL = 0,

285  HIPSPARSELT_SPLIT_K_MODE_TWO_KERNELS = 1,

286 } hipsparseLtSplitKMode_t;

287 

288 // clang-format on

289 

290 #ifdef __cplusplus

291 extern "C" {

292 #endif

293 

302 HIPSPARSELT_EXPORT

303 void hipsparseLtInitialize();

304 

319 HIPSPARSELT_EXPORT

320 hipsparseStatus_t hipsparseLtGetVersion(const hipsparseLtHandle_t* handle, int* version);

321 

335 HIPSPARSELT_EXPORT

336 hipsparseStatus_t hipsparseLtGetProperty(hipLibraryPropertyType propertyType, int* value);

337 

338 HIPSPARSELT_EXPORT

339 hipsparseStatus_t hipsparseLtGetGitRevision(hipsparseLtHandle_t handle, char* rev);

340 

341 HIPSPARSELT_EXPORT

342 hipsparseStatus_t hipsparseLtGetArchName(char** archName);

343 

359 /* hipSPARSE initialization and management routines */

360 HIPSPARSELT_EXPORT

361 hipsparseStatus_t hipsparseLtInit(hipsparseLtHandle_t* handle);

362 

376 HIPSPARSELT_EXPORT

377 hipsparseStatus_t hipsparseLtDestroy(const hipsparseLtHandle_t* handle);

378 

379 /* matrix descriptor */

407 HIPSPARSELT_EXPORT

408 hipsparseStatus_t hipsparseLtDenseDescriptorInit(const hipsparseLtHandle_t* handle,

409  hipsparseLtMatDescriptor_t* matDescr,

410  int64_t rows,

411  int64_t cols,

412  int64_t ld,

413  uint32_t alignment,

414  hipsparseLtDatatype_t valueType,

415  hipsparseOrder_t order);

416 

447 HIPSPARSELT_EXPORT

448 hipsparseStatus_t hipsparseLtStructuredDescriptorInit(const hipsparseLtHandle_t* handle,

449  hipsparseLtMatDescriptor_t* matDescr,

450  int64_t rows,

451  int64_t cols,

452  int64_t ld,

453  uint32_t alignment,

454  hipsparseLtDatatype_t valueType,

455  hipsparseOrder_t order,

456  hipsparseLtSparsity_t sparsity);

457 

471 HIPSPARSELT_EXPORT

472 hipsparseStatus_t hipsparseLtMatDescriptorDestroy(const hipsparseLtMatDescriptor_t* matDescr);

473 

495 HIPSPARSELT_EXPORT

496 hipsparseStatus_t hipsparseLtMatDescSetAttribute(const hipsparseLtHandle_t* handle,

497  hipsparseLtMatDescriptor_t* matDescr,

498  hipsparseLtMatDescAttribute_t matAttribute,

499  const void* data,

500  size_t dataSize);

501 

523 HIPSPARSELT_EXPORT

524 hipsparseStatus_t hipsparseLtMatDescGetAttribute(const hipsparseLtHandle_t* handle,

525  const hipsparseLtMatDescriptor_t* matDescr,

526  hipsparseLtMatDescAttribute_t matAttribute,

527  void* data,

528  size_t dataSize);

529 

530 /* matmul descriptor */

560 HIPSPARSELT_EXPORT

561 hipsparseStatus_t hipsparseLtMatmulDescriptorInit(const hipsparseLtHandle_t* handle,

562  hipsparseLtMatmulDescriptor_t* matmulDescr,

563  hipsparseOperation_t opA,

564  hipsparseOperation_t opB,

565  const hipsparseLtMatDescriptor_t* matA,

566  const hipsparseLtMatDescriptor_t* matB,

567  const hipsparseLtMatDescriptor_t* matC,

568  const hipsparseLtMatDescriptor_t* matD,

569  hipsparseLtComputetype_t computeType);

570 

593 HIPSPARSELT_EXPORT

594 hipsparseStatus_t

595  hipsparseLtMatmulDescSetAttribute(const hipsparseLtHandle_t* handle,

596  hipsparseLtMatmulDescriptor_t* matmulDescr,

597  hipsparseLtMatmulDescAttribute_t matmulAttribute,

598  const void* data,

599  size_t dataSize);

600 

623 HIPSPARSELT_EXPORT

624 hipsparseStatus_t

625  hipsparseLtMatmulDescGetAttribute(const hipsparseLtHandle_t* handle,

626  const hipsparseLtMatmulDescriptor_t* matmulDescr,

627  hipsparseLtMatmulDescAttribute_t matmulAttribute,

628  void* data,

629  size_t dataSize);

630 

631 /* algorithm selection */

649 HIPSPARSELT_EXPORT

650 hipsparseStatus_t

651  hipsparseLtMatmulAlgSelectionInit(const hipsparseLtHandle_t* handle,

652  hipsparseLtMatmulAlgSelection_t* algSelection,

653  const hipsparseLtMatmulDescriptor_t* matmulDescr,

654  hipsparseLtMatmulAlg_t alg);

655 

678 HIPSPARSELT_EXPORT

679 hipsparseStatus_t hipsparseLtMatmulAlgSetAttribute(const hipsparseLtHandle_t* handle,

680  hipsparseLtMatmulAlgSelection_t* algSelection,

681  hipsparseLtMatmulAlgAttribute_t attribute,

682  const void* data,

683  size_t dataSize);

684 

708 HIPSPARSELT_EXPORT

709 hipsparseStatus_t

710  hipsparseLtMatmulAlgGetAttribute(const hipsparseLtHandle_t* handle,

711  const hipsparseLtMatmulAlgSelection_t* algSelection,

712  hipsparseLtMatmulAlgAttribute_t attribute,

713  void* data,

714  size_t dataSize);

715 

716 /* matmul plan */

733 HIPSPARSELT_EXPORT

734 hipsparseStatus_t hipsparseLtMatmulGetWorkspace(const hipsparseLtHandle_t* handle,

735  const hipsparseLtMatmulPlan_t* plan,

736  size_t* workspaceSize);

737 

756 HIPSPARSELT_EXPORT

757 hipsparseStatus_t hipsparseLtMatmulPlanInit(const hipsparseLtHandle_t* handle,

758  hipsparseLtMatmulPlan_t* plan,

759  const hipsparseLtMatmulDescriptor_t* matmulDescr,

760  const hipsparseLtMatmulAlgSelection_t* algSelection);

761 

775 HIPSPARSELT_EXPORT

776 hipsparseStatus_t hipsparseLtMatmulPlanDestroy(const hipsparseLtMatmulPlan_t* plan);

777 

778 /* matmul execution */

824 HIPSPARSELT_EXPORT

825 hipsparseStatus_t hipsparseLtMatmul(const hipsparseLtHandle_t* handle,

826  const hipsparseLtMatmulPlan_t* plan,

827  const void* alpha,

828  const void* d_A,

829  const void* d_B,

830  const void* beta,

831  const void* d_C,

832  void* d_D,

833  void* workspace,

834  hipStream_t* streams,

835  int32_t numStreams);

836 

891 HIPSPARSELT_EXPORT

892 hipsparseStatus_t hipsparseLtMatmulSearch(const hipsparseLtHandle_t* handle,

893  hipsparseLtMatmulPlan_t* plan,

894  const void* alpha,

895  const void* d_A,

896  const void* d_B,

897  const void* beta,

898  const void* d_C,

899  void* d_D,

900  void* workspace,

901  hipStream_t* streams,

902  int32_t numStreams);

903 

904 /* helper */

905 // prune

935 HIPSPARSELT_EXPORT

936 hipsparseStatus_t hipsparseLtSpMMAPrune(const hipsparseLtHandle_t* handle,

937  const hipsparseLtMatmulDescriptor_t* matmulDescr,

938  const void* d_in,

939  void* d_out,

940  hipsparseLtPruneAlg_t pruneAlg,

941  hipStream_t stream);

942 

965 HIPSPARSELT_EXPORT

966 hipsparseStatus_t hipsparseLtSpMMAPruneCheck(const hipsparseLtHandle_t* handle,

967  const hipsparseLtMatmulDescriptor_t* matmulDescr,

968  const void* d_in,

969  int* d_valid,

970  hipStream_t stream);

971 

1006 HIPSPARSELT_EXPORT

1007 hipsparseStatus_t hipsparseLtSpMMAPrune2(const hipsparseLtHandle_t* handle,

1008  const hipsparseLtMatDescriptor_t* sparseMatDescr,

1009  int isSparseA,

1010  hipsparseOperation_t op,

1011  const void* d_in,

1012  void* d_out,

1013  hipsparseLtPruneAlg_t pruneAlg,

1014  hipStream_t stream);

1015 

1042 HIPSPARSELT_EXPORT

1043 hipsparseStatus_t hipsparseLtSpMMAPruneCheck2(const hipsparseLtHandle_t* handle,

1044  const hipsparseLtMatDescriptor_t* sparseMatDescr,

1045  int isSparseA,

1046  hipsparseOperation_t op,

1047  const void* d_in,

1048  int* d_valid,

1049  hipStream_t stream);

1050 

1051 // compression

1071 HIPSPARSELT_EXPORT

1072 hipsparseStatus_t hipsparseLtSpMMACompressedSize(const hipsparseLtHandle_t* handle,

1073  const hipsparseLtMatmulPlan_t* plan,

1074  size_t* compressedSize,

1075  size_t* compressBufferSize);

1076 

1102 HIPSPARSELT_EXPORT

1103 hipsparseStatus_t hipsparseLtSpMMACompress(const hipsparseLtHandle_t* handle,

1104  const hipsparseLtMatmulPlan_t* plan,

1105  const void* d_dense,

1106  void* d_compressed,

1107  void* d_compressBuffer,

1108  hipStream_t stream);

1109 

1130 HIPSPARSELT_EXPORT

1131 hipsparseStatus_t hipsparseLtSpMMACompressedSize2(const hipsparseLtHandle_t* handle,

1132  const hipsparseLtMatDescriptor_t* sparseMatDescr,

1133  size_t* compressedSize,

1134  size_t* compressBufferSize);

1135 

1165 HIPSPARSELT_EXPORT

1166 hipsparseStatus_t hipsparseLtSpMMACompress2(const hipsparseLtHandle_t* handle,

1167  const hipsparseLtMatDescriptor_t* sparseMatDescr,

1168  int isSparseA,

1169  hipsparseOperation_t op,

1170  const void* d_dense,

1171  void* d_compressed,

1172  void* d_compressBuffer,

1173  hipStream_t stream);

1174 

1175 #ifdef __cplusplus

1176 }

1177 #endif

1178 

1179 #endif // _HIPSPARSELT_H_

hipsparseLtInitialize

void hipsparseLtInitialize()

Initialize hipSPARSELt for the current HIP device.

hipsparseLtSpMMAPrune2

hipsparseStatus_t hipsparseLtSpMMAPrune2(const hipsparseLtHandle_t *handle, const hipsparseLtMatDescriptor_t *sparseMatDescr, int isSparseA, hipsparseOperation_t op, const void *d_in, void *d_out, hipsparseLtPruneAlg_t pruneAlg, hipStream_t stream)

Purnes a dense matrix.

hipsparseLtSpMMACompressedSize2

hipsparseStatus_t hipsparseLtSpMMACompressedSize2(const hipsparseLtHandle_t *handle, const hipsparseLtMatDescriptor_t *sparseMatDescr, size_t *compressedSize, size_t *compressBufferSize)

provide the size of the compressed matrix.

hipsparseLtSpMMACompress2

hipsparseStatus_t hipsparseLtSpMMACompress2(const hipsparseLtHandle_t *handle, const hipsparseLtMatDescriptor_t *sparseMatDescr, int isSparseA, hipsparseOperation_t op, const void *d_dense, void *d_compressed, void *d_compressBuffer, hipStream_t stream)

compresses a dense matrix to structured matrix.

hipsparseLtSpMMAPruneCheck2

hipsparseStatus_t hipsparseLtSpMMAPruneCheck2(const hipsparseLtHandle_t *handle, const hipsparseLtMatDescriptor_t *sparseMatDescr, int isSparseA, hipsparseOperation_t op, const void *d_in, int *d_valid, hipStream_t stream)

checks the correctness of the pruning structure for a given matrix.

hipsparseLtSpMMAPrune

hipsparseStatus_t hipsparseLtSpMMAPrune(const hipsparseLtHandle_t *handle, const hipsparseLtMatmulDescriptor_t *matmulDescr, const void *d_in, void *d_out, hipsparseLtPruneAlg_t pruneAlg, hipStream_t stream)

Purnes a dense matrix.

hipsparseLtSpMMACompressedSize

hipsparseStatus_t hipsparseLtSpMMACompressedSize(const hipsparseLtHandle_t *handle, const hipsparseLtMatmulPlan_t *plan, size_t *compressedSize, size_t *compressBufferSize)

provide the size of the compressed matrix.

hipsparseLtSpMMACompress

hipsparseStatus_t hipsparseLtSpMMACompress(const hipsparseLtHandle_t *handle, const hipsparseLtMatmulPlan_t *plan, const void *d_dense, void *d_compressed, void *d_compressBuffer, hipStream_t stream)

compresses a dense matrix to structured matrix.

hipsparseLtSpMMAPruneCheck

hipsparseStatus_t hipsparseLtSpMMAPruneCheck(const hipsparseLtHandle_t *handle, const hipsparseLtMatmulDescriptor_t *matmulDescr, const void *d_in, int *d_valid, hipStream_t stream)

checks the correctness of the pruning structure for a given matrix.

hipsparseLtInit

hipsparseStatus_t hipsparseLtInit(hipsparseLtHandle_t *handle)

Create a hipsparselt handle.

hipsparseLtGetVersion

hipsparseStatus_t hipsparseLtGetVersion(const hipsparseLtHandle_t *handle, int *version)

Retrive the version number of the hipSPARSELt library.

hipsparseLtDestroy

hipsparseStatus_t hipsparseLtDestroy(const hipsparseLtHandle_t *handle)

Destroy a hipsparselt handle.

hipsparseLtGetProperty

hipsparseStatus_t hipsparseLtGetProperty(hipLibraryPropertyType propertyType, int *value)

Retrive the value of the requested property.

hipsparseLtMatmulAlgSelectionInit

hipsparseStatus_t hipsparseLtMatmulAlgSelectionInit(const hipsparseLtHandle_t *handle, hipsparseLtMatmulAlgSelection_t *algSelection, const hipsparseLtMatmulDescriptor_t *matmulDescr, hipsparseLtMatmulAlg_t alg)

Initializes the algorithm selection descriptor.

hipsparseLtMatmulAlgSetAttribute

hipsparseStatus_t hipsparseLtMatmulAlgSetAttribute(const hipsparseLtHandle_t *handle, hipsparseLtMatmulAlgSelection_t *algSelection, hipsparseLtMatmulAlgAttribute_t attribute, const void *data, size_t dataSize)

Specify the algorithm attribute of a algorithm selection descriptor.

hipsparseLtMatmulAlgGetAttribute

hipsparseStatus_t hipsparseLtMatmulAlgGetAttribute(const hipsparseLtHandle_t *handle, const hipsparseLtMatmulAlgSelection_t *algSelection, hipsparseLtMatmulAlgAttribute_t attribute, void *data, size_t dataSize)

Get the specific algorithm attribute from algorithm selection descriptor.

hipsparseLtMatmulDescGetAttribute

hipsparseStatus_t hipsparseLtMatmulDescGetAttribute(const hipsparseLtHandle_t *handle, const hipsparseLtMatmulDescriptor_t *matmulDescr, hipsparseLtMatmulDescAttribute_t matmulAttribute, void *data, size_t dataSize)

Get the matrix type of a matrix descriptor.

hipsparseLtMatmulDescriptorInit

hipsparseStatus_t hipsparseLtMatmulDescriptorInit(const hipsparseLtHandle_t *handle, hipsparseLtMatmulDescriptor_t *matmulDescr, hipsparseOperation_t opA, hipsparseOperation_t opB, const hipsparseLtMatDescriptor_t *matA, const hipsparseLtMatDescriptor_t *matB, const hipsparseLtMatDescriptor_t *matC, const hipsparseLtMatDescriptor_t *matD, hipsparseLtComputetype_t computeType)

Initializes the matrix multiplication descriptor.

hipsparseLtMatmulDescSetAttribute

hipsparseStatus_t hipsparseLtMatmulDescSetAttribute(const hipsparseLtHandle_t *handle, hipsparseLtMatmulDescriptor_t *matmulDescr, hipsparseLtMatmulDescAttribute_t matmulAttribute, const void *data, size_t dataSize)

Specify the matrix attribute of a matrix descriptor.

hipsparseLtMatmulSearch

hipsparseStatus_t hipsparseLtMatmulSearch(const hipsparseLtHandle_t *handle, hipsparseLtMatmulPlan_t *plan, const void *alpha, const void *d_A, const void *d_B, const void *beta, const void *d_C, void *d_D, void *workspace, hipStream_t *streams, int32_t numStreams)

Sparse matrix dense matrix multiplication.

hipsparseLtMatmul

hipsparseStatus_t hipsparseLtMatmul(const hipsparseLtHandle_t *handle, const hipsparseLtMatmulPlan_t *plan, const void *alpha, const void *d_A, const void *d_B, const void *beta, const void *d_C, void *d_D, void *workspace, hipStream_t *streams, int32_t numStreams)

Sparse matrix dense matrix multiplication.

hipsparseLtMatmulGetWorkspace

hipsparseStatus_t hipsparseLtMatmulGetWorkspace(const hipsparseLtHandle_t *handle, const hipsparseLtMatmulPlan_t *plan, size_t *workspaceSize)

Determines the required workspace size.

hipsparseLtMatmulPlanDestroy

hipsparseStatus_t hipsparseLtMatmulPlanDestroy(const hipsparseLtMatmulPlan_t *plan)

Destroy a matrix multiplication plan descriptor.

hipsparseLtMatmulPlanInit

hipsparseStatus_t hipsparseLtMatmulPlanInit(const hipsparseLtHandle_t *handle, hipsparseLtMatmulPlan_t *plan, const hipsparseLtMatmulDescriptor_t *matmulDescr, const hipsparseLtMatmulAlgSelection_t *algSelection)

Initializes the matrix multiplication plan descriptor.

hipsparseLtStructuredDescriptorInit

hipsparseStatus_t hipsparseLtStructuredDescriptorInit(const hipsparseLtHandle_t *handle, hipsparseLtMatDescriptor_t *matDescr, int64_t rows, int64_t cols, int64_t ld, uint32_t alignment, hipsparseLtDatatype_t valueType, hipsparseOrder_t order, hipsparseLtSparsity_t sparsity)

Create a descriptor for structured matrix.

hipsparseLtMatDescGetAttribute

hipsparseStatus_t hipsparseLtMatDescGetAttribute(const hipsparseLtHandle_t *handle, const hipsparseLtMatDescriptor_t *matDescr, hipsparseLtMatDescAttribute_t matAttribute, void *data, size_t dataSize)

Get the matrix type of a matrix descriptor.

hipsparseLtMatDescSetAttribute

hipsparseStatus_t hipsparseLtMatDescSetAttribute(const hipsparseLtHandle_t *handle, hipsparseLtMatDescriptor_t *matDescr, hipsparseLtMatDescAttribute_t matAttribute, const void *data, size_t dataSize)

Specify the matrix attribute of a matrix descriptor.

hipsparseLtDenseDescriptorInit

hipsparseStatus_t hipsparseLtDenseDescriptorInit(const hipsparseLtHandle_t *handle, hipsparseLtMatDescriptor_t *matDescr, int64_t rows, int64_t cols, int64_t ld, uint32_t alignment, hipsparseLtDatatype_t valueType, hipsparseOrder_t order)

Create a descriptor for dense matrix.

hipsparseLtMatDescriptorDestroy

hipsparseStatus_t hipsparseLtMatDescriptorDestroy(const hipsparseLtMatDescriptor_t *matDescr)

Destroy a matrix descriptor.

hipsparseLtSparsity_t

hipsparseLtSparsity_t

Specify the sparsity of the structured matrix.

Definition: hipsparselt.h:178

hipsparseLtMatmulAlg_t

hipsparseLtMatmulAlg_t

Specify the algorithm for matrix-matrix multiplication.

Definition: hipsparselt.h:246

hipsparseLtMatmulAlgAttribute_t

hipsparseLtMatmulAlgAttribute_t

Specify the matrix multiplication algorithm attributes.

Definition: hipsparselt.h:257

hipsparseLtComputetype_t

hipsparseLtComputetype_t

Specify the compute precision modes of the matrix.

Definition: hipsparselt.h:200

hipsparseLtSplitKMode_t

hipsparseLtSplitKMode_t

Specify the split k mode value.

Definition: hipsparselt.h:283

hipsparseLtMatmulDescAttribute_t

hipsparseLtMatmulDescAttribute_t

Specify the additional attributes of a matrix multiplication descriptor.

Definition: hipsparselt.h:217

hipsparseLtDatatype_t

hipsparseLtDatatype_t

List of hipsparselt data types.

Definition: hipsparselt.h:161

hipsparseLtPruneAlg_t

hipsparseLtPruneAlg_t

Specify the pruning algorithm to apply to the structured matrix before the compression.

Definition: hipsparselt.h:272

hipsparseLtMatDescAttribute_t

hipsparseLtMatDescAttribute_t

Specify the additional attributes of a matrix descriptor.

Definition: hipsparselt.h:190

HIPSPARSELT_SPARSITY_50_PERCENT

@ HIPSPARSELT_SPARSITY_50_PERCENT

Definition: hipsparselt.h:179

HIPSPARSELT_MATMUL_ALG_DEFAULT

@ HIPSPARSELT_MATMUL_ALG_DEFAULT

Definition: hipsparselt.h:247

HIPSPARSELT_MATMUL_SPLIT_K

@ HIPSPARSELT_MATMUL_SPLIT_K

Definition: hipsparselt.h:261

HIPSPARSELT_MATMUL_SPLIT_K_BUFFERS

@ HIPSPARSELT_MATMUL_SPLIT_K_BUFFERS

Definition: hipsparselt.h:263

HIPSPARSELT_MATMUL_SEARCH_ITERATIONS

@ HIPSPARSELT_MATMUL_SEARCH_ITERATIONS

Definition: hipsparselt.h:260

HIPSPARSELT_MATMUL_SPLIT_K_MODE

@ HIPSPARSELT_MATMUL_SPLIT_K_MODE

Definition: hipsparselt.h:262

HIPSPARSELT_MATMUL_ALG_CONFIG_ID

@ HIPSPARSELT_MATMUL_ALG_CONFIG_ID

Definition: hipsparselt.h:258

HIPSPARSELT_MATMUL_ALG_CONFIG_MAX_ID

@ HIPSPARSELT_MATMUL_ALG_CONFIG_MAX_ID

Definition: hipsparselt.h:259

HIPSPARSELT_COMPUTE_32F

@ HIPSPARSELT_COMPUTE_32F

Definition: hipsparselt.h:203

HIPSPARSELT_COMPUTE_TF32_FAST

@ HIPSPARSELT_COMPUTE_TF32_FAST

Definition: hipsparselt.h:206

HIPSPARSELT_COMPUTE_TF32

@ HIPSPARSELT_COMPUTE_TF32

Definition: hipsparselt.h:204

HIPSPARSELT_COMPUTE_32I

@ HIPSPARSELT_COMPUTE_32I

Definition: hipsparselt.h:202

HIPSPARSELT_COMPUTE_16F

@ HIPSPARSELT_COMPUTE_16F

Definition: hipsparselt.h:201

HIPSPARSELT_SPLIT_K_MODE_TWO_KERNELS

@ HIPSPARSELT_SPLIT_K_MODE_TWO_KERNELS

Definition: hipsparselt.h:285

HIPSPARSELT_SPLIT_K_MODE_ONE_KERNEL

@ HIPSPARSELT_SPLIT_K_MODE_ONE_KERNEL

Definition: hipsparselt.h:284

HIPSPARSELT_MATMUL_ACTIVATION_RELU_UPPERBOUND

@ HIPSPARSELT_MATMUL_ACTIVATION_RELU_UPPERBOUND

Definition: hipsparselt.h:219

HIPSPARSELT_MATMUL_BIAS_STRIDE

@ HIPSPARSELT_MATMUL_BIAS_STRIDE

Definition: hipsparselt.h:225

HIPSPARSELT_MATMUL_BIAS_POINTER

@ HIPSPARSELT_MATMUL_BIAS_POINTER

Definition: hipsparselt.h:226

HIPSPARSELT_MATMUL_ACTIVATION_LEAKYRELU

@ HIPSPARSELT_MATMUL_ACTIVATION_LEAKYRELU

Definition: hipsparselt.h:228

HIPSPARSELT_MATMUL_BIAS_TYPE

@ HIPSPARSELT_MATMUL_BIAS_TYPE

Definition: hipsparselt.h:234

HIPSPARSELT_MATMUL_ACTIVATION_LEAKYRELU_ALPHA

@ HIPSPARSELT_MATMUL_ACTIVATION_LEAKYRELU_ALPHA

Definition: hipsparselt.h:229

HIPSPARSELT_MATMUL_ACTIVATION_TANH_BETA

@ HIPSPARSELT_MATMUL_ACTIVATION_TANH_BETA

Definition: hipsparselt.h:233

HIPSPARSELT_MATMUL_ACTIVATION_GELU_SCALING

@ HIPSPARSELT_MATMUL_ACTIVATION_GELU_SCALING

Definition: hipsparselt.h:222

HIPSPARSELT_MATMUL_ALPHA_VECTOR_SCALING

@ HIPSPARSELT_MATMUL_ALPHA_VECTOR_SCALING

Definition: hipsparselt.h:223

HIPSPARSELT_MATMUL_ACTIVATION_TANH

@ HIPSPARSELT_MATMUL_ACTIVATION_TANH

Definition: hipsparselt.h:231

HIPSPARSELT_MATMUL_ACTIVATION_SIGMOID

@ HIPSPARSELT_MATMUL_ACTIVATION_SIGMOID

Definition: hipsparselt.h:230

HIPSPARSELT_MATMUL_ACTIVATION_TANH_ALPHA

@ HIPSPARSELT_MATMUL_ACTIVATION_TANH_ALPHA

Definition: hipsparselt.h:232

HIPSPARSELT_MATMUL_BETA_VECTOR_SCALING

@ HIPSPARSELT_MATMUL_BETA_VECTOR_SCALING

Definition: hipsparselt.h:224

HIPSPARSELT_MATMUL_ACTIVATION_RELU

@ HIPSPARSELT_MATMUL_ACTIVATION_RELU

Definition: hipsparselt.h:218

HIPSPARSELT_MATMUL_ACTIVATION_GELU

@ HIPSPARSELT_MATMUL_ACTIVATION_GELU

Definition: hipsparselt.h:221

HIPSPARSELT_MATMUL_ACTIVATION_ABS

@ HIPSPARSELT_MATMUL_ACTIVATION_ABS

Definition: hipsparselt.h:227

HIPSPARSELT_MATMUL_ACTIVATION_RELU_THRESHOLD

@ HIPSPARSELT_MATMUL_ACTIVATION_RELU_THRESHOLD

Definition: hipsparselt.h:220

HIPSPARSELT_R_8F

@ HIPSPARSELT_R_8F

Definition: hipsparselt.h:166

HIPSPARSELT_R_32F

@ HIPSPARSELT_R_32F

Definition: hipsparselt.h:163

HIPSPARSELT_R_16F

@ HIPSPARSELT_R_16F

Definition: hipsparselt.h:162

HIPSPARSELT_R_16BF

@ HIPSPARSELT_R_16BF

Definition: hipsparselt.h:165

HIPSPARSELT_R_8I

@ HIPSPARSELT_R_8I

Definition: hipsparselt.h:164

HIPSPARSELT_R_8BF

@ HIPSPARSELT_R_8BF

Definition: hipsparselt.h:167

HIPSPARSELT_PRUNE_SPMMA_TILE

@ HIPSPARSELT_PRUNE_SPMMA_TILE

Definition: hipsparselt.h:273

HIPSPARSELT_PRUNE_SPMMA_STRIP

@ HIPSPARSELT_PRUNE_SPMMA_STRIP

Definition: hipsparselt.h:274

HIPSPARSELT_MAT_BATCH_STRIDE

@ HIPSPARSELT_MAT_BATCH_STRIDE

Definition: hipsparselt.h:192

HIPSPARSELT_MAT_NUM_BATCHES

@ HIPSPARSELT_MAT_NUM_BATCHES

Definition: hipsparselt.h:191

hipsparseLtGetGitRevision

hipsparseStatus_t hipsparseLtGetGitRevision(hipsparseLtHandle_t handle, char *rev)

hipsparseLtGetArchName

hipsparseStatus_t hipsparseLtGetArchName(char **archName)

hipsparseLtHandle_t

Handle to the hipSPARSELt library context queue.

Definition: hipsparselt.h:101

hipsparseLtHandle_t::data

uint8_t data[11024]

Definition: hipsparselt.h:101

hipsparseLtMatDescriptor_t

Descriptor of the matrix.

Definition: hipsparselt.h:112

hipsparseLtMatDescriptor_t::data

uint8_t data[11024]

Definition: hipsparselt.h:112

hipsparseLtMatmulAlgSelection_t

Descriptor of the matrix multiplication algorithm.

Definition: hipsparselt.h:130

hipsparseLtMatmulAlgSelection_t::data

uint8_t data[11024]

Definition: hipsparselt.h:130

hipsparseLtMatmulDescriptor_t

Descriptor of the matrix multiplication operation.

Definition: hipsparselt.h:122

hipsparseLtMatmulDescriptor_t::data

uint8_t data[11024]

Definition: hipsparselt.h:122

hipsparseLtMatmulPlan_t

Descriptor of the matrix multiplication execution plan.

Definition: hipsparselt.h:141

hipsparseLtMatmulPlan_t::data

uint8_t data[11024]

Definition: hipsparselt.h:141