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
78 lines
3.0 KiB
ReStructuredText
78 lines
3.0 KiB
ReStructuredText
.. meta::
|
|
:description: introduction to the rocSPARSE library and API reference library
|
|
:keywords: rocSPARSE, ROCm, API, documentation, intro
|
|
|
|
.. _rocsparse:
|
|
|
|
********************************************************************
|
|
rocSPARSE documentation
|
|
********************************************************************
|
|
|
|
rocSPARSE is a library that provides basic linear algebra subroutines for sparse matrices and vectors.
|
|
It's created using the HIP programming language, implemented on top of the ROCm runtime and toolchains,
|
|
and optimized for AMD discrete GPUs.
|
|
|
|
The rocSPARSE public repository is located at `<https://github.com/ROCm/rocm-libraries/tree/develop/projects/rocsparse>`_.
|
|
|
|
.. note::
|
|
|
|
The rocSPARSE repository for ROCm 6.4.3 and earlier is located at `<https://github.com/ROCm/rocSPARSE>`_.
|
|
|
|
.. note::
|
|
For portability, ROCm provides the `hipSPARSE <https://github.com/ROCm/rocm-libraries/tree/develop/projects/hipsparse>`_ library.
|
|
hipSPARSE includes a comprehensive, portable interface that supports multiple backends (including rocSPARSE and cuSPARSE).
|
|
For documentation and examples, see the `hipSPARSE documentation <https://rocm.docs.amd.com/projects/hipSPARSE/en/latest/>`_.
|
|
|
|
For ROCm code examples, see `<https://github.com/ROCm/rocm-examples>`_.
|
|
|
|
.. grid:: 2
|
|
:gutter: 3
|
|
|
|
.. grid-item-card:: Install
|
|
|
|
* :doc:`Install rocSPARSE <./install/install>`
|
|
* :doc:`Build from source on Linux <./install/Linux_Install_Guide>`
|
|
* :doc:`Build from source on Windows <./install/Windows_Install_Guide>`
|
|
|
|
.. grid:: 2
|
|
:gutter: 3
|
|
|
|
.. grid-item-card:: Conceptual
|
|
|
|
* :doc:`rocSPARSE design <./conceptual/rocsparse-design>`
|
|
* :doc:`Storage formats <./conceptual/storage-formats-sparse>`
|
|
|
|
.. grid-item-card:: How to
|
|
|
|
* :doc:`Use rocSPARSE <./how-to/using-rocsparse>`
|
|
|
|
.. grid-item-card:: Examples
|
|
|
|
* `Client samples <https://github.com/ROCm/rocm-libraries/tree/develop/projects/rocsparse/clients/samples>`_
|
|
|
|
.. grid-item-card:: API reference
|
|
|
|
* :ref:`api`
|
|
* :ref:`debugging_`
|
|
* :ref:`rocsparse_types_`
|
|
* :ref:`rocsparse_precision_support_`
|
|
* :ref:`rocsparse_environment_variables_`
|
|
* :ref:`rocsparse_roctx_`
|
|
* :ref:`rocsparse_enumerations_`
|
|
* :ref:`rocsparse_auxiliary_functions_`
|
|
* :ref:`rocsparse_level1_functions_`
|
|
* :ref:`rocsparse_level2_functions_`
|
|
* :ref:`rocsparse_level3_functions_`
|
|
* :ref:`rocsparse_extra_functions_`
|
|
* :ref:`rocsparse_precond_functions_`
|
|
* :ref:`rocsparse_conversion_functions_`
|
|
* :ref:`rocsparse_reordering_functions_`
|
|
* :ref:`rocsparse_utility_functions_`
|
|
* :ref:`rocsparse_generic_functions_`
|
|
* :ref:`reproducibility`
|
|
|
|
To contribute to the documentation, see `Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_.
|
|
For information on contributing to the rocSPARSE code base, see :doc:`Contribute to rocSPARSE <./contribute>`.
|
|
|
|
You can find licensing information on the `Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.
|