rocFFT

rocFFT is a software library for computing Fast Fourier Transforms (FFT) written in HIP. It is part of AMD's software ecosystem based on ROCm. In addition to AMD GPU devices, the library can also be compiled with the CUDA compiler using HIP tools for running on Nvidia GPU devices.

Installing pre-built packages

Download pre-built packages either from ROCm's package servers or by clicking the github releases tab and downloading the source, which could be more recent than the pre-build packages. Release notes are available for each release on the releases tab.

• sudo apt update && sudo apt install rocfft

Building from source

rocFFT is compiled with hipcc and uses cmake. There are a number of options that can be provided to cmake to customize the build, but the following commands will build a shared library for supported AMD GPUs:

mkdir build && cd build
cmake -DCMAKE_CXX_COMPILER=hipcc .. 
make -j

A static library can be compiled by using the option -DBUILD_SHARED_LIBS=off

To use the hip-clang compiler, one must specify -DUSE_HIP_CLANG=ON -DHIP_COMPILER=clang to cmake.

One can use nvcc as a backend compiler by passing the option -DUSE_CUDA=yes and setting HIP_PLATFORM=nvcc in your environment.

There are several clients included with rocFFT:

1. rocfft-rider runs general transforms and is useful for performance analysis;
2. rocfft-test runs various regression tests;
3. rocfft-selftest runs various unit tests; and
4. various small samples are included.

Clients are not built by default. To build them:

To build all of the above clients, use -DBUILD_CLIENTS_ALL=on.

To install the client depencencies on Ubuntu, run sudo apt install libgtest-dev libfftw3-dev libboost-program-options-dev. We use version 1.10 of Google Test (gtest).

install.sh is a bash script that will install dependencies on certain Linux distributions, such as Ubuntu, CentOS, RHEL, Fedora, and SLES and invoke cmake. However, the preferred method for compiling rocFFT is to call cmake directly.

Library and API Documentation

Please refer to the library documentation for current documentation.

Examples

Examples may be found in the clients/samples subdirectory.