Skip to content

Commit

Permalink
Readme - updates (#472)
Browse files Browse the repository at this point in the history
  • Loading branch information
kiritigowda authored Nov 6, 2024
1 parent d69cbae commit 9553971
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 48 deletions.
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@ Spectrogram kernel output represented as a image <br><br>
## Prerequisites

* Linux
* Ubuntu - `20.04` / `22.04`
* Ubuntu - `22.04` / `24.04`
* RedHat - `8` / `9`
* SLES - `15-SP5`

* [ROCm-supported hardware](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html)
> [!IMPORTANT]
> `gfx908` or higher GPU required
* Install ROCm `6.1.0` or later with [amdgpu-install](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/how-to/amdgpu-install.html): Required usecase - rocm
* Install ROCm `6.1.0` or later with [amdgpu-install](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/how-to/amdgpu-install.html): **Required** usecase:`rocm`
> [!IMPORTANT]
> `sudo amdgpu-install --usecase=rocm`
Expand All @@ -70,10 +70,16 @@ Spectrogram kernel output represented as a image <br><br>
sudo apt install half
```

> [!IMPORTANT]
> [!IMPORTANT]
> * Compiler features required
> * C++17
> ```shell
> sudo apt install libstdc++-12-dev
> ```
> * OpenMP
> ```shell
> sudo apt install libomp-dev
> ```
> * Threads
>[!NOTE]
Expand All @@ -87,7 +93,8 @@ The installation process uses the following steps:
* Install ROCm `6.1.0` or later with [amdgpu-install](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/how-to/amdgpu-install.html) with `--usecase=rocm`
* Use **either** [package install](#package-install) **or** [source install](#source-install) as described below.
> [!IMPORTANT]
> Use **either** [package install](#package-install) **or** [source install](#source-install) as described below.
### Package install
Expand Down Expand Up @@ -144,7 +151,7 @@ sudo zypper install rpp rpp-devel rpp-test
make test
```
>[!NOTE]
> [!IMPORTANT]
> `make test` requires [test suite prerequisites](utilities/test_suite/README.md) installed
#### OCL Backend
Expand All @@ -163,12 +170,9 @@ The installer will copy
* Libraries into `/opt/rocm/lib`
* Header files into `/opt/rocm/include/rpp`
* Samples folder into `/opt/rocm/share/rpp`
* Samples, and test folder into `/opt/rocm/share/rpp`
* Documents folder into `/opt/rocm/share/doc/rpp`
>[!NOTE]
> [Test suite prerequisites](utilities/test_suite#prerequisites) install is required to run tests
### Verify with rpp-test package
Test package will install CTest module to test rpp. Follow below steps to test package install
Expand All @@ -178,6 +182,8 @@ mkdir rpp-test && cd rpp-test
cmake /opt/rocm/share/rpp/test/
ctest -VV
```
> [!IMPORTANT]
> [Test suite prerequisites](utilities/test_suite#prerequisites) are required to run tests
## Test Functionalities
Expand Down Expand Up @@ -220,7 +226,7 @@ All notable changes for each release are added to our [changelog](CHANGELOG.md).
## Tested configurations
* Linux distribution
* Ubuntu - `20.04` / `22.04`
* Ubuntu - `22.04` / `24.04`
* RedHat - `8` / `9`
* SLES - `15-SP5`
* ROCm: rocm-core - `6.3.0.60300`
Expand Down
55 changes: 17 additions & 38 deletions docs/install/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,67 +15,49 @@ Prerequisites

* Linux distribution

- Ubuntu 20.04 or 22.04
- CentOS 7
- Ubuntu 22.04 or 24.04
- RedHat 8 or 9
- SLES 15-SP4
- SLES 15-SP5

* `ROCm supported hardware <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html>`_

* Install ROCm with `amdgpu-install <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/how-to/amdgpu-install.html>`_ with ``--usecase=rocm``

* Clang Version `5.0.1` and above

* Ubuntu `20`/`22`
* CMake Version `3.5` and above

.. code-block:: shell
sudo apt-get install clang
sudo apt-get install cmake
* CentOS `7`
* Clang Version `5.0.1` and above

.. code-block:: shell
sudo yum install llvm-toolset-7-clang llvm-toolset-7-clang-analyzer llvm-toolset-7-clang-tools-extra
scl enable llvm-toolset-7 bash
sudo apt-get install clang
* RHEL `8`/`9`
* IEEE 754-based half-precision floating-point library (half.hpp)

.. code-block:: shell
sudo yum install clang
sudo apt-get install half
* SLES `15-SP4` (use `ROCm LLVM Clang`)
* Compiler with support for C++ Version `17` and above

.. code-block:: shell
zypper -n --no-gpg-checks install clang
update-alternatives --install /usr/bin/clang clang /opt/rocm-*/llvm/bin/clang 100
update-alternatives --install /usr/bin/clang++ clang++ /opt/rocm-*/llvm/bin/clang++ 100
* CMake Version `3.5` and above

* IEEE 754-based half-precision floating-point library (half.hpp)
sudo apt-get install libstdc++-12-dev
* `half` package install
* OpenMP

.. code-block:: shell
sudo apt-get install half
sudo apt-get install libomp-dev
* Threads

.. note::
Use appropriate package manager depending on the OS

* Compiler with support for C++ Version `17` and above

* OpenMP

* Threads

Build and install instructions
================================

Expand Down Expand Up @@ -174,9 +156,6 @@ The installer will copy
* Samples folder into `/opt/rocm/share/rpp`
* Documents folder into `/opt/rocm/share/doc/rpp`

.. note::
Installation of `test suite prerequisites <https://github.com/ROCm/rpp/blob/develop/utilities/test_suite/README.md>`_ is required to run tests

Verify with `rpp-test` package
--------------------------------------------

Expand All @@ -188,6 +167,9 @@ Test package will install `ctest` module to test `rpp`. Use the following steps
cmake /opt/rocm/share/rpp/test/
ctest -VV
.. note::
Installation of `test suite prerequisites <https://github.com/ROCm/rpp/blob/develop/utilities/test_suite/README.md>`_ are required to run tests

Test RPP functionalities
--------------------------------------------

Expand Down Expand Up @@ -215,6 +197,3 @@ To test the functionalities of `rpp`, run the code shown for your backend:
cd rpp/utilities/rpp-unittests/HOST_NEW
./testAllScript.sh

0 comments on commit 9553971

Please sign in to comment.