.. meta::
  :description: rocSPARSE documentation and API reference library
  :keywords: rocSPARSE, ROCm, API, documentation

.. _rocsparse:

********************************************************************
rocSPARSE documentation
********************************************************************

rocSPARSE is a library that provides basic linear algebra subroutines for sparse matrices and vectors written in HIP and implemented on top of AMD's Radeon Open Compute (ROCm) runtime and toolchains.
rocSPARSE is created using the HIP programming language and optimized for AMD's latest discrete GPUs.

The code is open and hosted at: https://github.com/ROCmSoftwarePlatform/rocSPARSE

The rocSPARSE documentation is structured as follows:

.. grid:: 2
  :gutter: 3

  .. grid-item-card:: Installation

    * :ref:`linux-install`
    * :ref:`windows-install`

  .. grid-item-card:: How to

    * :ref:`rocsparse_docs`
    * :ref:`rocsparse_logging`
    * :ref:`design`
    * :ref:`contributing-to`

  .. grid-item-card:: API reference

    * :ref:`api`
    * :ref:`rocsparse_types_`
    * :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 refer to `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.
