.. meta::
  :description: Introduction to  the hipSPARSELt documentation and API reference library
  :keywords: hipSPARSELt, ROCm, API, documentation, introduction

.. _hipsparselt-docs-home:

********************************************************************
hipSPARSELt documentation
********************************************************************

hipSPARSELt is a SPARSE marshalling library that presents a common interface for multiple supported backends.
For more information, see :doc:`What is hipSPARSELt? <./what-is-hipsparselt>`

The hipSPARSELt public repository is located at `<https://github.com/ROCm/rocm-libraries/tree/develop/projects/hipsparselt>`_.

.. note::

   The hipSPARSELt repository for ROCm 6.4.3 and earlier is located at `<https://github.com/ROCm/hipSPARSELt>`_.

.. grid:: 2
  :gutter: 3

  .. grid-item-card:: Install

    * :doc:`Quick start installation guide <./install/quick-start-install>`
    * :doc:`Detailed installation guide <./install/install-hipsparselt>`

.. grid:: 2
  :gutter: 3

  .. grid-item-card:: Conceptual

    * :doc:`Storage formats <./conceptual/storage-format>`
    * :doc:`Features for the Instinct MI300 series <./conceptual/mi300-features>`

  .. grid-item-card:: How to

    * :doc:`Manage devices and streams <./how-to/device-stream-management>`
    * :doc:`Port from NVIDIA CUDA <./how-to/porting>`

  .. grid-item-card:: Examples

    * `Client samples <https://github.com/ROCm/rocm-libraries/tree/develop/projects/hipsparselt/clients/samples>`_

  .. grid-item-card:: API Reference

    * :doc:`Supported functions <./reference/supported-functions>`
    * :doc:`Data type support <./reference/data-type-support>`
    * :doc:`Environment variables <./reference/env-variables>`
    * :doc:`API library <../doxygen/html/index>`

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.
