diff --git a/LICENSE.txt b/LICENSE.txt index ec8cfdd2..976ca2ab 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2017-2022 Advanced Micro Devices, Inc. All rights reserved. +Copyright (c) 2017-2024 Advanced Micro Devices, Inc. All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/docs/api-reference-home.rst b/docs/api-reference-home.rst deleted file mode 100644 index f1e4b32c..00000000 --- a/docs/api-reference-home.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. meta:: - :description: rocRAND documentation and API reference library - :keywords: rocRAND, ROCm, API, documentation - -.. _api-reference-home: - -=================== -rocRAND API reference -=================== - -rocRAND APIs are available in the following programming languages: - -* :ref:`C/C++` -* :ref:`Python` - -Here is the :ref:`genindex` for all rocRAND APIs. diff --git a/docs/cpp-api.rst b/docs/api-reference/cpp-api.rst similarity index 85% rename from docs/cpp-api.rst rename to docs/api-reference/cpp-api.rst index 23f05fa5..9474b642 100644 --- a/docs/cpp-api.rst +++ b/docs/api-reference/cpp-api.rst @@ -10,6 +10,11 @@ C/C++ API reference This chapter describes the rocRAND C and C++ API. +API index +=========== + +To search an API, refer to the API :ref:`genindex`. + Device functions ================ .. doxygengroup:: rocranddevice diff --git a/docs/python-api.rst b/docs/api-reference/python-api.rst similarity index 83% rename from docs/python-api.rst rename to docs/api-reference/python-api.rst index ae7b4c9c..189f9b04 100644 --- a/docs/python-api.rst +++ b/docs/api-reference/python-api.rst @@ -10,6 +10,11 @@ Python API reference This chapter describes the rocRAND Python module API. +API index +------------ + +To search an API, refer to the API :ref:`genindex`. + .. default-domain:: py .. py:currentmodule:: rocrand @@ -45,3 +50,5 @@ Utilities .. autofunction:: rocrand.empty .. autofunction:: rocrand.get_version + +To search an API, refer to the :ref:`genindex` for all rocRAND APIs. diff --git a/docs/curand-compatibility.rst b/docs/conceptual/curand-compatibility.rst similarity index 100% rename from docs/curand-compatibility.rst rename to docs/conceptual/curand-compatibility.rst diff --git a/docs/dynamic_ordering_configuration.rst b/docs/conceptual/dynamic_ordering_configuration.rst similarity index 97% rename from docs/dynamic_ordering_configuration.rst rename to docs/conceptual/dynamic_ordering_configuration.rst index 4c619439..e0bac59a 100644 --- a/docs/dynamic_ordering_configuration.rst +++ b/docs/conceptual/dynamic_ordering_configuration.rst @@ -1,5 +1,11 @@ +.. meta:: + :description: rocRAND documentation and API reference library + :keywords: rocRAND, ROCm, API, documentation + +.. _dynamic-ordering-configuration: + ============================================================= -Generating optimal kernel configurations for dynamic ordering +Kernel configurations for dynamic ordering ============================================================= Overview diff --git a/docs/programmers-guide.rst b/docs/conceptual/programmers-guide.rst similarity index 100% rename from docs/programmers-guide.rst rename to docs/conceptual/programmers-guide.rst diff --git a/docs/index.rst b/docs/index.rst index c155d09a..72565566 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,30 +8,39 @@ rocRAND documentation ******************************************************************** -Welcome to the rocRAND docs home page! To learn more, see :ref:`what-is-rocrand` +rocRAND provides functions that generate pseudo-random and quasi-random numbers. The rocRAND library is implemented in the `HIP `_ +programming language and optimized for AMD's latest discrete GPUs. It is designed to run on top +of AMD's `ROCm `_, but it also works on CUDA-enabled GPUs. -Our documentation is structured as follows: +rocRAND includes a wrapper library called hipRAND, which you can use to easily port +CUDA applications using the cuRAND library to the +`HIP `_ layer. In the +`ROCm `_ environment, hipRAND uses rocRAND. + +You can access rocRAND code on our `GitHub repository `_. + +The documentation is structured as follows: .. grid:: 2 :gutter: 3 - .. grid-item-card:: API reference + .. grid-item-card:: Install - * :ref:`cpp-api` - * :ref:`python-api` - * :ref:`curand-compatibility` - * :doc:`API library ` + * :ref:`installing` .. grid-item-card:: Conceptual - * :ref:`programmers-guide` + * :ref:`programmers-guide` + * :ref:`curand-compatibility` + * :ref:`dynamic-ordering-configuration` - .. grid-item-card:: Tutorial + .. grid-item-card:: API reference - * :ref:`installing` + * :ref:`cpp-api` + * :ref:`python-api` + * :doc:`API library ` -Contributing to this documentation -======================================================= +To contribute to the documentation, refer to +`Contributing to ROCm `_. -We welcome collaboration! If you'd like to contribute to our documentation, you can find instructions on our `Contribute to ROCm docs `_ page. Known issues are listed on `GitHub `_. -Licensing information for all ROCm components is listed on our `Licensing `_ page. +You can find licensing information on the `Licensing `_ page. diff --git a/docs/installing.rst b/docs/install/installing.rst similarity index 100% rename from docs/installing.rst rename to docs/install/installing.rst diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index bcb61ca2..826bc67f 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -2,19 +2,19 @@ # These comments will also be removed. root: index subtrees: - - entries: - - file: what-is-rocrand - - file: installing - - file: programmers-guide - - file: dynamic_ordering_configuration - - file: api-reference-home - title: API reference - subtrees: - - entries: - - file: cpp-api - - file: python-api - - file: curand-compatibility - - file: doxygen/html/index + - caption: Install + entries: + - file: install/installing + - caption: Conceptual + entries: + - file: conceptual/programmers-guide + - file: conceptual/curand-compatibility + - file: conceptual/dynamic_ordering_configuration + - caption: API reference + entries: + - file: api-reference/cpp-api + - file: api-reference/python-api + - file: doxygen/html/index - caption: About entries: - file: license diff --git a/docs/what-is-rocrand.rst b/docs/what-is-rocrand.rst deleted file mode 100644 index 37b73128..00000000 --- a/docs/what-is-rocrand.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. meta:: - :description: rocRAND provides functions that generate pseudo-random and quasi-random numbers - :keywords: rocRAND, ROCm, library, API, HIP - -.. _what-is-rocrand: - -================== -What is rocRAND? -================== - -rocRAND provides functions that generate pseudo-random and quasi-random numbers. - -The rocRAND library is implemented in the `HIP `_ -programming language and optimized for AMD's latest discrete GPUs. It is designed to run on top -of AMD's `ROCm `_, but it also works on CUDA-enabled GPUs. - -rocRAND includes a wrapper library called hipRAND, which you can use to easily port -CUDA applications using the cuRAND library to the -`HIP `_ layer. In the -`ROCm `_ environment, hipRAND uses rocRAND.