Skip to content

Commit 81d9e58

Browse files
authored
Add readme and metadata info and clarify CUDA references (#567)
1 parent 6ed33d2 commit 81d9e58

File tree

4 files changed

+9
-5
lines changed

4 files changed

+9
-5
lines changed

Diff for: README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ split into a separate library. As of version 6.0, hipRAND can no longer be built
2626

2727
## Documentation
2828

29-
Documentation for rocRAND is available at
30-
[https://rocm.docs.amd.com/projects/rocRAND/en/latest/](https://rocm.docs.amd.com/projects/rocRAND/en/latest/)
29+
> [!NOTE]
30+
> The published rocRAND documentation is available at [rocRAND](https://rocm.docs.amd.com/projects/rocRAND/en/latest/) in an organized, easy-to-read format, with search and a table of contents. The documentation source files reside in the rocRAND/docs folder of this repository. As with all ROCm projects, the documentation is open source. For more information, see [Contribute to ROCm documentation](https://rocm.docs.amd.com/en/latest/contribute/contributing.html).
3131
3232
To build documentation locally, use the following code:
3333

Diff for: docs/conceptual/curand-compatibility.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
cuRAND compatibility
99
====================
1010

11-
The following table shows which rocRAND generators produce the exact same sequence as the equivalent cuRAND generator when using legacy ordering, given the same seed, number of dimensions, and offset.
11+
The following table shows which rocRAND generators produce the exact same sequence as the equivalent NVIDIA CUDA cuRAND generator when using legacy ordering, given the same seed, number of dimensions, and offset.
1212

1313
.. table:: cuRAND Compatibility
1414
:widths: auto

Diff for: docs/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ rocRAND documentation
1010

1111
rocRAND provides functions that generate pseudo-random and quasi-random numbers. The rocRAND library is implemented in the `HIP <https://rocm.docs.amd.com/projects/HIP/en/latest/index.html>`_
1212
programming language and optimized for AMD's latest discrete GPUs. It is designed to run on top
13-
of AMD's `ROCm <https://rocm.docs.amd.com/en/latest/>`_, but it also works on CUDA-enabled GPUs.
13+
of AMD's `ROCm <https://rocm.docs.amd.com/en/latest/>`_, but it also works on NVIDIA CUDA-enabled GPUs.
1414

1515
rocRAND includes a wrapper library called hipRAND, which you can use to easily port
16-
CUDA applications using the cuRAND library to the
16+
NVIDIA CUDA applications using the CUDA cuRAND library to the
1717
`HIP <https://rocm.docs.amd.com/projects/HIP/en/latest/index.html>`_ layer. In the
1818
`ROCm <https://rocm.docs.amd.com/en/latest/>`_ environment, hipRAND uses rocRAND.
1919

Diff for: docs/license.rst

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
.. meta::
2+
:description: rocRAND licensing information
3+
:keywords: rocRAND, ROCm, API, documentation, license
4+
15
License
26
=======
37

0 commit comments

Comments
 (0)