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

Created a more comprehensive installation from the readme information #504

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open
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
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
docs_core.myst_heading_anchors = 6

external_projects_current_project = "rpp"
external_projects_remote_repository=""

for sphinx_var in ROCmDocs.SPHINX_VARS:
globals()[sphinx_var] = getattr(docs_core, sphinx_var)
19 changes: 10 additions & 9 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,31 @@
ROCm Performance Primitives documentation
********************************************************************

AMD ROCm Performance Primitives (RPP) is a comprehensive, high-performance computer vision
library for AMD processors that have HIP, OpenCL, or CPU backends. For more information, refer to
:doc:`./what-is-rpp`
AMD ROCm Performance Primitives (RPP) is a high-performance computer vision
library for AMD processors that have HIP, OpenCL, or CPU backends. RPP provides a way to utilize all the hardware available for training and augmentation.

Our code is open and hosted at `https://github.com/ROCm/rpp <https://github.com/ROCm/rpp>`_.

The RPP documentation is structured as follows:
The RPP public repository is located at `https://github.com/ROCm/rpp <https://github.com/ROCm/rpp>`_.

.. grid:: 2
:gutter: 3

.. grid-item-card:: Install

* :doc:`Install RPP <./install/install>`
* :doc:`RPP prerequisites <./install/rpp-prerequisites>`
* :doc:`Installing RPP <./install/rpp-install>`
* :doc:`Installing RPP with the package installer <./install/rpp-install-with-installer>`
* :doc:`Building and installing RPP from source <./install/rpp-build-and-install>`
* :doc:`Verifying the RPP installation <./install/rpp-verify-install>`

.. grid-item-card:: Reference

* :doc:`Supported RPP functionalities and variants <./reference/rpp-supported-functionalities>`
* :doc:`API library <./doxygen/html/globals>`

* :doc:`Modules <./doxygen/html/files>`
* :doc:`Data structures <./doxygen/html/annotated>`
* :doc:`Deprecated functions <./doxygen/html/deprecated>`

To contribute to the documentation refer to
:doc:`Contributing to ROCm <rocm:contribute/contributing>`.
To contribute to the documentation refer to :doc:`Contributing to ROCm <rocm:contribute/contributing>`.

You can find licensing information on the :doc:`Licensing <rocm:about/license>` page.
192 changes: 0 additions & 192 deletions docs/install/install.rst

This file was deleted.

52 changes: 52 additions & 0 deletions docs/install/rpp-build-and-install.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
.. meta::
:description: Building and installing ROCm Performance Primitives
:keywords: rpp, ROCm Performance Primitives, ROCm, documentation, installing, building, source code

**************************************************************************
Building and installing ROCm Performance Primitives
**************************************************************************

ROCm Performance Primitives (RPP) supports HIP and OpenCL backends running on `accelerators based on the CDNA architecture <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html>`_, and supports CPU-only backends on CPUs that support PCIe™ atomics.

On OpenCL and HIP backends, RPP requires ROCm installed with the `AMDGPU installer <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/how-to/amdgpu-install.html>`_ and the ``rocm`` usecase:

.. code:: shell

sudo amdgpu-install --usecase=rocm

Clone the source code from the `RPP GitHub repository <https://github.com/ROCm/rpp>`_, then use the following commands to build and install RPP:

.. tab-set::

.. tab-item:: HIP

.. code:: shell

mkdir build-hip
cd build-hip
cmake ../
make -j8
sudo make install

.. tab-item:: OpenCL

.. code:: shell

mkdir build-ocl
cd build-ocl
cmake -DBACKEND=OPENCL ../
make -j8
sudo make install

.. tab-item:: CPU-only

.. code:: shell

mkdir build-cpu
cd build-cpu
cmake -DBACKEND=CPU ../
make -j8
sudo make install



67 changes: 67 additions & 0 deletions docs/install/rpp-install-with-installer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
.. meta::
:description: Installing ROCm Performance Primitives with the package installer
:keywords: rpp, ROCm Performance Primitives, ROCm, documentation, installing, package installer

********************************************************************
Installing ROCm Performance Primitives with the package installer
********************************************************************

There are three ROCm Performance Primitives (RPP) packages available:

``rpp``: The RPP runtime package. This is the basic package that only installs the ``librpp.so`` library.

``rpp-dev``: The RPP development package. This package installs the ``librpp.so`` library, the RPP header files, and the RPP samples.

``rpp-test``: A test package that provides CTest to verify the installation.

All the required dependencies are installed when the package installation method is used.

Use the following commands to install only the RPP runtime package:

.. tab-set::

.. tab-item:: Ubuntu

.. code:: shell

sudo apt install rpp


.. tab-item:: RHEL

.. code:: shell

sudo yum install rpp


.. tab-item:: SLES

.. code:: shell

sudo zypper install rpp


Use the following commands to install all three RPP packages:

.. tab-set::

.. tab-item:: Ubuntu

.. code:: shell

sudo apt install rpp rpp-dev rpp-test


.. tab-item:: RHEL

.. code:: shell

sudo yum install rpp rpp-devel rpp-test


.. tab-item:: SLES

.. code:: shell

sudo zypper install rpp rpp-devel rpp-test

15 changes: 15 additions & 0 deletions docs/install/rpp-install.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. meta::
:description: Installing ROCm Performance Primitives
:keywords: rpp, ROCm Performance Primitives, ROCm, documentation, installing

********************************************************************
Installing ROCm Performance Primitives
********************************************************************

ROCm Performance Primitives (RPP) supports HIP, OpenCL, and CPU-only backends.

A :doc:`package installer <./rpp-install-with-installer>` is available for installing either only the RPP runtime, or the RPP runtime and development packages.

RPP can also be :doc:`built from source <./rpp-build-and-install>`.

After installing RPP, :doc:`verify the installation using the test suite <./rpp-verify-install>`.
Loading