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
61 lines
2.5 KiB
ReStructuredText
61 lines
2.5 KiB
ReStructuredText
.. meta::
|
|
:description: introduction to the hipSPARSE documentation and API reference library
|
|
:keywords: hipSPARSE, rocSPARSE, ROCm, API, documentation
|
|
|
|
.. _hipsparse:
|
|
|
|
********************************************************************
|
|
hipSPARSE documentation
|
|
********************************************************************
|
|
|
|
hipSPARSE presents a common interface for
|
|
supporting both :doc:`rocSPARSE <rocsparse:index>` and NVIDIA CUDA cuSPARSE as backends.
|
|
It's a SPARSE marshalling library that provides basic linear algebra subroutines
|
|
for sparse computation. hipSPARSE uses the :doc:`HIP <hip:index>` library and is implemented on top
|
|
of the AMD ROCm runtime and toolchains and optimized for AMD discrete GPUs.
|
|
|
|
For more information, see :doc:`What is hipSPARSE? <./what-is-hipsparse>`
|
|
|
|
The hipSPARSE public repository is located at `<https://github.com/ROCm/rocm-libraries/tree/develop/projects/hipsparse>`_.
|
|
|
|
|
|
.. note::
|
|
|
|
The hipSPARSE repository for ROCm 6.4.2 and earlier is located at `<https://github.com/ROCm/hipSPARSE>`_.
|
|
|
|
.. grid:: 2
|
|
:gutter: 3
|
|
|
|
.. grid-item-card:: Install
|
|
|
|
* :doc:`Install hipSPARSE <./install/install>`
|
|
* :doc:`Build from source on Linux <./install/build-linux>`
|
|
* :doc:`Build from source on Windows <./install/build-windows>`
|
|
|
|
.. grid-item-card:: How to
|
|
|
|
* :doc:`Use hipSPARSE <./howto/using-hipsparse>`
|
|
|
|
.. grid-item-card:: Examples
|
|
|
|
* `Client samples <https://github.com/ROCm/rocm-libraries/tree/develop/projects/hipsparse/clients/samples>`_
|
|
|
|
.. grid-item-card:: API reference
|
|
|
|
* :doc:`Exported functions <./reference/api>`
|
|
* :doc:`hipSPARSE data types <./reference/types>`
|
|
* :doc:`hipSPARSE precision support <./reference/data-type-support>`
|
|
* :doc:`Sparse auxiliary functions <./reference/auxiliary>`
|
|
* :doc:`Sparse level 1 functions <./reference/level1>`
|
|
* :doc:`Sparse level 2 functions <./reference/level2>`
|
|
* :doc:`Sparse level 3 functions <./reference/level3>`
|
|
* :doc:`Sparse extra functions <./reference/extra>`
|
|
* :doc:`Preconditioner functions <./reference/precond>`
|
|
* :doc:`Sparse conversion functions <./reference/conversion>`
|
|
* :doc:`Sparse reordering functions <./reference/reorder>`
|
|
* :doc:`Sparse generic functions <./reference/generic>`
|
|
|
|
To contribute to the documentation, see `Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_.
|
|
|
|
You can find licensing information on the `Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.
|