.. 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 for `rocPRIM <https://rocm.docs.amd.com/projects/rocPRIM/en/latest/index.html>`_.

The hipCUB project is located in https://github.com/ROCm/rocm-libraries/tree/develop/projects/hipcub.

.. grid:: 2

  .. grid-item-card:: Installation

    * :doc:`Prerequisites <install/hipCUB-prerequisites>`
    * :doc:`Installation overview <install/hipCUB-install-overview>`
    * :doc:`Installing on Windows <install/hipCUB-install-on-Windows>`
    * :doc:`Installing on Linux and Windows with CMake <install/hipCUB-install-with-cmake>`

  .. grid-item-card:: Reference

    * :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.
