From ce82fd3e75645dc65ef72b7f6088c8fb62bddf88 Mon Sep 17 00:00:00 2001 From: spolifroni-amd Date: Thu, 30 Apr 2026 14:01:55 -0400 Subject: [PATCH 1/3] removed the pypackage install option --- docs/install/rocAL-build-and-install.rst | 34 +++++------------------- docs/install/rocAL-prerequisites.rst | 12 +-------- 2 files changed, 8 insertions(+), 38 deletions(-) diff --git a/docs/install/rocAL-build-and-install.rst b/docs/install/rocAL-build-and-install.rst index 42fb5157d..32765f916 100644 --- a/docs/install/rocAL-build-and-install.rst +++ b/docs/install/rocAL-build-and-install.rst @@ -6,16 +6,13 @@ Building and installing rocAL from source code ******************************************************************** -Before building and installing rocAL, ensure ROCm has been installed with the `AMDGPU installer `_ and the ``rocm`` usecase. +Before building and installing rocAL, ensure ROCm is installed. -The rocAL source code is available from `https://github.com/ROCm/rocAL `_. Use the rocAL version that corresponds to the installed version of ROCm. +The rocAL source code is available from https://github.com/ROCm/rocAL. The default develop branch is intended for developers who want to contribute to the rocAL project or who want to preview new features. rocAL supports the HIP backend. -rocAL is installed in the ROCm installation directory by default. If rocAL for both HIP and OpenCL backends will be installed on the system, each version must be installed in its own custom directory and not in the default directory. - - -You can choose to use the |setup| setup script to install most :doc:`prerequisites <./rocAL-prerequisites>` +You can choose to use the |setup|_ setup script to install most :doc:`prerequisites <./rocAL-prerequisites>` .. note:: @@ -29,36 +26,19 @@ To build and install rocAL, create the ``build`` directory under the ``rocAL`` r mkdir build cd build -Use ``cmake`` to generate a makefile: - -.. code:: shell - - cmake ../ - -Use the ``-DCMAKE_INSTALL_PREFIX`` directive to set the installation directory. For example: +Use ``cmake`` to generate a makefile. Use the ``-DCMAKE_INSTALL_PREFIX`` directive to set the installation directory. For example: .. code:: shell cmake -DCMAKE_INSTALL_PREFIX=/opt/rocAL/ -Run make: +Run make to build and install: .. code:: shell - make - -Run ``cmake`` again to generate Python bindings for ``rocal_pybind`` then install: - -.. code:: shell - - sudo cmake --build . --target PyPackageInstall + make -j8 sudo make install - -After the installation, the rocAL files will be installed under ``/opt/rocm/`` unless ``-DCMAKE_INSTALL_PREFIX`` was specified. If ``-DCMAKE_INSTALL_PREFIX`` was specified, the rocAL files will be installed under the specified directory. - -To make and run the tests, use ``make test``. - .. |setup| replace:: ``rocAL-setup.py`` -.. _openvx: https://github.com/ROCm/rocAL/blob/develop/rocAL-setup.py +.. _setup: https://github.com/ROCm/rocAL/blob/develop/rocAL-setup.py diff --git a/docs/install/rocAL-prerequisites.rst b/docs/install/rocAL-prerequisites.rst index 1b325d491..69d750cd8 100644 --- a/docs/install/rocAL-prerequisites.rst +++ b/docs/install/rocAL-prerequisites.rst @@ -8,16 +8,6 @@ rocAL prerequisites ******************************************************************** -rocAL requires ROCm running on `GPUs based on the CDNA architecture `_ installed with the `AMDGPU installer `_. - -rocAL has been tested on the following Linux environments: - -* Ubuntu 22.04 and 24.04 -* RHEL 8 and 9 -* SLES 15 SP7 - -See `Supported operating systems `_ for the complete list of ROCm supported Linux environments. - :doc:`Building rocAL from source <./rocAL-build-and-install>` requires CMake Version 3.10 or later, AMD Clang++ Version 18.0.0 or later, and the following compiler support: * C++17 @@ -26,7 +16,7 @@ See `Supported operating systems `. -When building rocAL from source, the |setup| setup script can be used to install prerequisites: +When building rocAL from source, the |setup|_ setup script can be used to install prerequisites: .. code:: shell From de7d1c028c35e2779f0456e9bd955d18f8cd6072 Mon Sep 17 00:00:00 2001 From: spolifroni-amd Date: Thu, 30 Apr 2026 15:11:27 -0400 Subject: [PATCH 2/3] Update docs/install/rocAL-build-and-install.rst Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com> --- docs/install/rocAL-build-and-install.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install/rocAL-build-and-install.rst b/docs/install/rocAL-build-and-install.rst index 32765f916..8cd9e38e8 100644 --- a/docs/install/rocAL-build-and-install.rst +++ b/docs/install/rocAL-build-and-install.rst @@ -12,7 +12,7 @@ The rocAL source code is available from https://github.com/ROCm/rocAL. The defau rocAL supports the HIP backend. -You can choose to use the |setup|_ setup script to install most :doc:`prerequisites <./rocAL-prerequisites>` +You can choose to use the |setup|_ setup script to install most :doc:`prerequisites <./rocAL-prerequisites>`. .. note:: From 52cbd69db362bd86f74aaf96dbbf273bea2b8b94 Mon Sep 17 00:00:00 2001 From: spolifroni-amd Date: Thu, 30 Apr 2026 15:29:13 -0400 Subject: [PATCH 3/3] updated based on review comments --- docs/install/rocAL-build-and-install.rst | 2 +- docs/install/rocAL-prerequisites.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/install/rocAL-build-and-install.rst b/docs/install/rocAL-build-and-install.rst index 8cd9e38e8..a97229a15 100644 --- a/docs/install/rocAL-build-and-install.rst +++ b/docs/install/rocAL-build-and-install.rst @@ -10,7 +10,7 @@ Before building and installing rocAL, ensure ROCm is installed. The rocAL source code is available from https://github.com/ROCm/rocAL. The default develop branch is intended for developers who want to contribute to the rocAL project or who want to preview new features. -rocAL supports the HIP backend. +rocAL supports the `HIP backend `_. You can choose to use the |setup|_ setup script to install most :doc:`prerequisites <./rocAL-prerequisites>`. diff --git a/docs/install/rocAL-prerequisites.rst b/docs/install/rocAL-prerequisites.rst index 69d750cd8..0e5400f6c 100644 --- a/docs/install/rocAL-prerequisites.rst +++ b/docs/install/rocAL-prerequisites.rst @@ -8,7 +8,7 @@ rocAL prerequisites ******************************************************************** -:doc:`Building rocAL from source <./rocAL-build-and-install>` requires CMake Version 3.10 or later, AMD Clang++ Version 18.0.0 or later, and the following compiler support: +:doc:`Building rocAL from source <./rocAL-build-and-install>` requires CMake 3.10 or later, ``amdclang++`` 18.0.0 or later, and the following compiler support: * C++17 * OpenMP