.. meta::
   :description: hipCUB is a thin header-only wrapper library on top of rocPRIM or CUB that enables developers to port project
    using CUB library to the HIP layer.
   :keywords: hipCUB, ROCm, library, API

.. _index:

===========================
hipCUB documentation
===========================

hipCUB is a thin header-only wrapper library on top of rocPRIM or CUB. It enables developers to port project
using CUB library to the `HIP <https://github.com/ROCm-Developer-Tools/HIP>`_ layer and to run them
on AMD hardware. To learn more, see :ref:`what-is-hipcub`

You can access hipCUB code on our `GitHub repository <https://github.com/ROCm/hipCUB>`_.

The documentation is structured as follows:

.. grid:: 2

  .. grid-item-card:: API Reference

    * :ref:`data-type-support`
    * :doc:`API library <../doxygen/html/index>`
   
To contribute to the documentation refer to
`Contributing to ROCm  <https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_.

Licensing information can be found on the
`Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.
