.. 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>`_ and `CUB <https://docs.nvidia.com/cuda/cub/index.html>`_. It enables developers to port projects
using the CUB library to the `HIP <https://rocm.docs.amd.com/projects/HIP/en/latest/index.html>`_ layer and run on AMD hardware. To learn more, see :ref:`what-is-hipcub`

The hipCUB repository is located at `https://github.com/ROCm/hipCUB <https://github.com/ROCm/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:: 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.
