derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
61 lines
2.2 KiB
ReStructuredText
61 lines
2.2 KiB
ReStructuredText
.. meta::
|
|
:description: introduction to the rocRAND documentation and API reference library
|
|
:keywords: rocRAND, ROCm, API, documentation
|
|
|
|
.. _rocrand-docs-home:
|
|
|
|
********************************************************************
|
|
rocRAND documentation
|
|
********************************************************************
|
|
|
|
rocRAND provides functions that generate pseudo-random and quasi-random numbers.
|
|
The rocRAND library is implemented in the :doc:`HIP <hip:index>`
|
|
programming language and optimized for the latest discrete AMD GPUs. It is designed to run on top
|
|
of the AMD :doc:`ROCm platform <rocm:what-is-rocm>`.
|
|
|
|
rocRAND integrates with a wrapper library called hipRAND, which you can use to easily port
|
|
NVIDIA CUDA applications that use the CUDA cuRAND library to the
|
|
:doc:`HIP <hip:index>` layer. In a
|
|
ROCm environment, hipRAND uses the rocRAND library.
|
|
|
|
The rocRAND public repository is located at `<https://github.com/ROCm/rocm-libraries/tree/develop/projects/rocrand>`_.
|
|
|
|
.. note::
|
|
|
|
The rocRAND repository for ROCm 6.4 and earlier is located at `<https://github.com/ROCm/rocRAND>`_.
|
|
|
|
.. grid:: 2
|
|
:gutter: 3
|
|
|
|
.. grid-item-card:: Install
|
|
|
|
* :doc:`Install rocRAND <./install/installing>`
|
|
* :doc:`Build from source <./install/build>`
|
|
|
|
.. grid-item-card:: Conceptual
|
|
|
|
* :doc:`Programming guide <./conceptual/programmers-guide>`
|
|
* :ref:`curand-compatibility`
|
|
* :ref:`dynamic-ordering-configuration`
|
|
* :doc:`Random number generators <./conceptual/generator-types>`
|
|
|
|
.. grid-item-card:: How to
|
|
|
|
* :doc:`Use primbench for benchmarking <./how-to/rocRAND-primbench>`
|
|
|
|
.. grid-item-card:: Examples
|
|
|
|
* `Examples <https://github.com/ROCm/rocm-libraries/tree/develop/projects/rocrand/python/rocrand/examples>`_
|
|
|
|
.. grid-item-card:: API reference
|
|
|
|
* :doc:`rocRAND precision support <api-reference/data-type-support>`
|
|
* :ref:`cpp-api`
|
|
* :ref:`python-api`
|
|
* :doc:`Fortran API reference <fortran-api-reference>`
|
|
* :doc:`API library <doxygen/html/index>`
|
|
|
|
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.
|