.. meta::
   :description: Index page for the hipBLASLt library which provides GEMM operations with flexible APIs and extends functionalities beyond the traditional BLAS library
   :keywords: hipBLASLt, ROCm, library, API, tool

.. _index:

===========================
hipBLASLt documentation
===========================

hipBLASLt is a library that provides General Matrix-Matrix (GEMM) operations with flexible APIs and extends functionality beyond the traditional BLAS library.
To learn more, see :doc:`What is hipBLASLt?<./what-is-hipBLASLt>`.

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

.. note::

   The hipBLASLt repository for ROCm release 6.4 and earlier is located at `<https://github.com/ROCm/hipBLASLt>`_.

.. grid:: 2
  :gutter: 3

  .. grid-item-card:: Install

    * :doc:`Install hipBLASLt <./install/install>`
    * :doc:`Build from source <./install/building-installing-hipblaslt>`

.. grid:: 2
  :gutter: 3

  .. grid-item-card:: Conceptual

    * :doc:`hipBLASLt library organization <./conceptual/hipblaslt-library-organization>`
    * :doc:`hipBLASLt clients <./conceptual/hipblaslt-clients>`
    * :doc:`hipBLASLt PCI chip ID predicates <./conceptual/pci-chip-id-predicates-walkthrough>`

  .. grid-item-card:: How to

    * :doc:`Use the hipBLASLt tuning utility <./how-to/how-to-use-hipblaslt-tuning-utility>`
    * :doc:`Use hipBLASLt offline tuning <./how-to/how-to-use-hipblaslt-offline-tuning>`
    * :doc:`Use logging and heuristics <./how-to/use-logging-heuristics>`
    * :doc:`Use Stream-K with hipBLASLt <./how-to/how-to-use-streamk>`
    * :doc:`Detect NaN in GEMM output <./how-to/how-to-detect-nan>`
    * :doc:`Use general batched GEMM <./how-to/how-to-general-batched-gemm>`

  .. grid-item-card:: Examples

    * :doc:`Code Samples <./samples/samples>`
    * `hipBLASLt client examples <https://github.com/ROCm/rocm-libraries/tree/develop/projects/hipblaslt/clients/samples>`_

  .. grid-item-card:: API reference

    * :doc:`hipBLASLt precision support <./reference/data-type-support>`
    * :doc:`hipBLASLt datatypes <./reference/datatypes>`
    * :doc:`hipBLASLt environment variables <./reference/env-variables>`
    * :doc:`hipBLASLt API <./reference/api-reference>`
    * :doc:`hipBLASLtExt API <./reference/ext-reference>`
    * :doc:`hipBLASLtExt operation API <./reference/ext-ops>`

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.