Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use rocm-docs-core for linting #370

Closed
wants to merge 11 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/workflows/linting.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Linting

on:
push:
branches: [develop, master]
pull_request:
branches: [develop, master]

jobs:
call-workflow-passing-data:
name: Documentation
uses: RadeonOpenCompute/rocm-docs-core/.github/workflows/linting.yml@develop

32 changes: 32 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
DeviceNDArray
Enum
FindHIP
HipError
LFSR
MRG
MTGP
Mersenne
PRNGs
Philox
QRNG
QRNGs
RocRandError
SVG
Sobol
ThreeFry
Threefry
XORWOW
autoclass
autoexception
autofunction
benchmarked
currentmodule
doxygengroup
enum
poisson
reproducibility
rocranddevice
rocrandhost
rocrandhostcpp
sanitization
sobol
4 changes: 2 additions & 2 deletions docs/dynamic_ordering_configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Multiples of the number of multiprocessors of the GPU at hand are good candidate
Running the tuning benchmarks
=============================

When the `benchmark_rocrand_tuning` target is built, the benchmarks can be run and the results can be collected for further processing. Since the benchmarks run for a longer time period, it is crucial that the GPU in use is thermally stable, i.e. the cooling must be adequate enough to keep the GPU at the preset clock rates without throttling. Additionally, make sure that no other workload is dispatched on the GPU concurrently. Otherwise the resulting dynamic ordering configs might not be the optimal ones. The full benchmark suite can be run with the following command: ::
When the `benchmark_rocrand_tuning` target is built, the benchmarks can be run and the results can be collected for further processing. Since the benchmarks run for a longer time period, it is crucial that the GPU in use is thermally stable, i.e. the cooling must be adequate enough to keep the GPU at the preset clock rates without throttling. Additionally, make sure that no other workload is dispatched on the GPU concurrently. Otherwise the resulting dynamic ordering configurations might not be the optimal ones. The full benchmark suite can be run with the following command: ::

$ cd ./build/benchmark/tuning
$ ./benchmark_rocrand_tuning --benchmark_out_format=json --benchmark_out=rocrand_tuning_gfx908.json
Expand All @@ -60,7 +60,7 @@ This executes the benchmarks and saves the benchmark results into the JSON file
Processing the benchmark results
================================

Once the benchmark results in JSON format from all architectures are present, the best configs are selected using the `rocRAND/scripts/config-tuning/select_best_config.py` script. Make sure that the prerequisite libraries are installed, by running ``pip install -r rocRAND/scripts/config-tuning/requirements.txt``.
Once the benchmark results in JSON format from all architectures are present, the best configurations are selected using the `rocRAND/scripts/config-tuning/select_best_config.py` script. Make sure that the prerequisite libraries are installed, by running ``pip install -r rocRAND/scripts/config-tuning/requirements.txt``.

Each rocRAND generator is capable of generating a multitude of output types and distributions. However, a single configuration is selected for each GPU architecture, which applies uniformly to all types and distributions. It is possible that the configuration that performs the best for one distribution is not the fastest for another. `select_best_config.py` selects the configuration that performs best **on average**. If, under the selected configuration, any type/distribution performs worse than ``ROCRAND_ORDERING_PSEUDO_DEFAULT``, a warning is printed to the standard output. The eventual decision about applying the configuration or not have to be made by the library's maintainers.

Expand Down
2 changes: 1 addition & 1 deletion docs/programmers-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ The following table shows which rocRAND generators produce the exact same sequen
:widths: auto

================= =====================
Generator Compatibile
Generator Compatible
================= =====================
XORWOW No
MRG32K3A No
Expand Down
Loading