.. meta::
   :description: A wrapper library that allows you to easily port CUDA applications that use the cuRAND library to the HIP layer
   :keywords: hipRAND, ROCm, library, API, tool

.. _index:

===========================
hipRAND documentation
===========================

The hipRAND library is a wrapper library that allows you to easily port CUDA applications that use the cuRAND library to the HIP layer. hipRAND uses rocRAND in a ROCm environment and cuRAND in a CUDA environment.

hipRAND provides C, C++, and Python API wrappers.

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

The documentation is structured as follows:

.. grid:: 2
  :gutter: 3

  .. grid-item-card:: Install

    * :ref:`installation`
    
  .. grid-item-card:: API reference

    * :ref:`data-type`
    * :ref:`cpp-api`
    * :ref:`python-api`
     
To contribute to the documentation, refer to
`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.
