Installing and deploying ROCm Compute Profiler

Installing and deploying ROCm Compute Profiler#

ROCm Compute Profiler consists of two installation components.

ROCm Compute Profiler core installation (client-side)
- Provides the core application profiling capability.
- Allows the collection of performance counters, filtering by hardware block, dispatch, kernel, and more.
- Provides a CLI-based analysis mode.
- Provides a standalone web interface for importing analysis metrics.
Grafana server for ROCm Compute Profiler (server-side) (optional)
- Hosts the MongoDB backend and Grafana instance.
- Is packaged in a Docker container for easy setup.

Determine what you need to install based on how you would like to interact with ROCm Compute Profiler. See the following decision tree to help determine what installation is right for you.

Decision tree for installing and deploying ROCm Compute Profiler

Core installation#

The core ROCm Compute Profiler application requires the following basic software dependencies. As of ROCm 6.2, the core ROCm Compute Profiler is included with your ROCm installation.

Python >= 3.8
CMake >= 3.19
ROCm >= 5.7.1

Note

ROCm Compute Profiler will use the first version of python3 found in your system’s PATH. If the default version of Python is older than 3.8, you may need to update your system’s PATH to point to a newer version.

ROCm Compute Profiler depends on a number of Python packages documented in the top-level requirements.txt file. Install these before configuring ROCm Compute Profiler.

Tip

If looking to build ROCm Compute Profiler as a developer, consider these additional requirements.

`docs/sphinx/requirements.txt`	Python packages required to build this documentation from source.
`requirements-test.txt`	Python packages required to run ROCm Compute Profiler’s CI suite using PyTest.

The recommended procedure for ROCm Compute Profiler usage is to install into a shared file system so that multiple users can access the final installation. The following steps illustrate how to install the necessary Python dependencies using pip and ROCm Compute Profiler into a shared location controlled by the INSTALL_DIR environment variable.

Tip

To always run ROCm Compute Profiler with a particular version of Python, you can create a bash alias. For example, to run ROCm Compute Profiler with Python 3.10, you can run the following command:

alias rocprof-compute-mypython="/usr/bin/python3.10 /opt/rocm/bin/rocprof-compute"

Configuration variables#

The following installation example leverages several CMake project variables defined as follows.

CMake variable	Description
`CMAKE_INSTALL_PREFIX`	Controls the install path for ROCm Compute Profiler files.
`PYTHON_DEPS`	Specifies an optional path to resolve Python package dependencies.
`MOD_INSTALL_PATH`	Specifies an optional path for separate ROCm Compute Profiler modulefile installation.

Install from source#

A typical install begins by downloading the latest release tarball available from ROCm/rocprofiler-compute. From there, untar and navigate into the top-level directory.
```
tar xfz rocprofiler-compute-v3.0.0.tar.gz
cd rocprofiler-compute-v3.0.0
```

Next, install Python dependencies and complete the ROCm Compute Profiler configuration and install process.

# define top-level install path
export INSTALL_DIR=<your-top-level-desired-install-path>

# install python deps
python3 -m pip install -t ${INSTALL_DIR}/python-libs -r requirements.txt

# configure ROCm Compute Profiler for shared install
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR}/3.0.0 \
        -DPYTHON_DEPS=${INSTALL_DIR}/python-libs \
        -DMOD_INSTALL_PATH=${INSTALL_DIR}/modulefiles/rocprofiler-compute ..

# install
make install

Tip

You might need to sudo the final installation step if you don’t have write access for the chosen installation path.

Upon successful installation, your top-level installation directory should look like this.
```
$ ls $INSTALL_DIR
modulefiles  3.0.0  python-libs
```

Execution using modulefiles#

The installation process includes the creation of an environment modulefile for use with Lmod. On systems that support Lmod, you can register the ROCm Compute Profiler modulefile directory and setup your environment for execution of ROCm Compute Profiler as follows.

$ module use $INSTALL_DIR/modulefiles
$ module load rocprofiler-compute
$ which rocprof-compute
/opt/apps/rocprofiler-compute/3.0.0/bin/rocprof-compute

$ rocprof-compute --version
ROC Profiler:   /opt/rocm-5.1.0/bin/rocprof

rocprofiler-compute (v3.0.0)

Tip

If you’re relying on an Lmod Python module locally, you may wish to customize the resulting ROCm Compute Profiler modulefile post-installation to include extra module dependencies.

Execution without modulefiles#

To use ROCm Compute Profiler without the companion modulefile, update your PATH settings to enable access to the command line binary. If you installed Python dependencies in a shared location, also update your PYTHONPATH configuration.

export PATH=$INSTALL_DIR/3.0.0/bin:$PATH
export PYTHONPATH=$INSTALL_DIR/python-libs

Install via package manager#

Once ROCm (minimum version 6.2.0) is installed, you can install ROCm Compute Profiler using your operating system’s native package manager using the following commands. See ROCm installation for Linux for guidance on installing the ROCm software stack.

Ubuntu

$ sudo apt install rocprofiler-compute
# Include rocprofiler-compute in your system PATH
$ sudo update-alternatives --install /usr/bin/rocprofiler-compute rocprof-compute /opt/rocm/bin/rocprofiler-compute 0
# Install Python dependencies
$ python3 -m pip install -r /opt/rocm/libexec/rocprofiler-compute/requirements.txt

Red Hat Enterprise Linux

$ sudo dnf install rocprofiler-compute
# Include rocprofiler-compute in your system PATH
$ sudo update-alternatives --install /usr/bin/rocprofiler-compute rocprof-compute /opt/rocm/bin/rocprofiler-compute 0
# Install Python dependencies
$ python3 -m pip install -r /opt/rocm/libexec/rocprofiler-compute/requirements.txt

SUSE Linux Enterprise Server

$ sudo zypper install rocprofiler-compute
# Include rocprofiler-compute in your system PATH
$ sudo update-alternatives --install /usr/bin/rocprofiler-compute rocprof-compute /opt/rocm/bin/rocprofiler-compute 0
# Install Python dependencies
$ python3 -m pip install -r /opt/rocm/libexec/rocprofiler-compute/requirements.txt

ROCProfiler#

ROCm Compute Profiler relies on ROCProfiler’s rocprof binary during the profiling process. Normally, the path to this binary is detected automatically, but you can override the path by the setting the optional ROCPROF environment variable.