Installing and building hipSPARSELt#
This topic explains how to install and build the hipSPARSELt library.
Prerequisites#
hipSPARSELt requires a ROCm-enabled platform and the hipSPARSE library for the header file.
Installing prebuilt packages#
hipSPARSELt can be installed from the AMD ROCm repository. For detailed instructions on installing ROCm, see ROCm installation.
To install hipSPARSELt on Ubuntu, run these commands:
sudo apt-get update
sudo apt-get install hipsparselt
After hipSPARSELt is installed, it can be used just like any other library with a C API. To call hipSPARSELt, the header file must be included in the user code. This means the hipSPARSELt shared library becomes a link-time and run-time dependency for the user application.
Building hipSPARSELt from source#
It isn’t necessary to build hipSPARSELt from source because it’s ready to use after installing the prebuilt packages, as described above. To build hipSPARSELt from source, follow the instructions in this section.
To compile and run hipSPARSELt, the ROCm platform is required. The build also requires the following compile-time dependencies:
CMake (Version 3.5 or later)
GoogleTest (Optional: only required to build the clients)
Downloading hipSPARSELt#
The hipSPARSELt source code is available from the the hipSPARSELt directory of the rocm-libraries GitHub.
Download the develop branch for hipSPARSELt and all projects in the rocm-libraries repository using these commands:
git clone -b develop https://github.com/ROCm/rocm-libraries.git
cd rocm-libraries/projects/hipsparselt
To limit your local checkout to the hipSPARSELt project, configure sparse-checkout before cloning.
This uses the Git partial clone feature (--filter=blob:none) to reduce how much data is downloaded.
Use the following commands for a sparse checkout:
git clone --no-checkout --filter=blob:none https://github.com/ROCm/rocm-libraries.git
cd rocm-libraries
git sparse-checkout init --cone
git sparse-checkout set projects/hipsparselt
git checkout develop # or use the branch you want to work with
Note
To build ROCm 6.4 and older, use the hipSPARSELt repository at ROCm/hipSPARSELt. For more information, see the documentation associated with the release you want to build.
Building hipSPARSELt using the install script#
It’s recommended to use the install.sh script to install hipSPARSELt.
Here are the steps required to build different packages of the library, including the dependencies and clients.
Note
You can run the install.sh script from the projects/hipsparselt directory.
Using install.sh to build hipSPARSELt with dependencies#
The following table lists the common ways to use install.sh to build the hipSPARSELt dependencies and library.
Command |
Description |
|---|---|
|
Print the help information. |
|
Build the dependencies and library in your local directory. The |
|
Build the library in your local directory. The script assumes the dependencies are available. |
|
Build the library, then build and install the hipSPARSELt package in |
Using install.sh to build hipSPARSELt with dependencies and clients#
The clients contains example code and unit tests. Common uses of install.sh to build them are listed in the table below.
Command |
Description |
|---|---|
|
Print the help information. |
|
Build the dependencies, library, and client in your local directory. The |
|
Build the library and client in your local directory. The script assumes the dependencies are available. |
|
Build the library, dependencies, and client, then build and install the hipSPARSELt package in |
|
Build the library and client, then build and install the hipSPARSELt package in |
Building hipSPARSELt using individual make commands#
You can build hipSPARSELt using the following commands:
Note
Run these commands from the projects/hipsparselt directory.
CMake 3.16.8 or later is required to build hipSPARSELt.
# Create and change the build directory
mkdir -p build/release ; cd build/release
# Change default install path (/opt/rocm); use -DCMAKE_INSTALL_PREFIX=<path> to adjust the path
cmake ../..
# Compile the hipSPARSELt library
make -j$(nproc)
# Install hipSPARSELt to `/opt/rocm`
make install
You can build hipSPARSELt with the dependencies and clients using the following commands:
Note
GoogleTest is required to build the hipSPARSELt clients.
# Install GoogleTest
mkdir -p build/release/deps ; cd build/release/deps
cmake ../../../deps
make -j$(nproc) install
# Change to build directory
cd ..
# Default install path is /opt/rocm, use -DCMAKE_INSTALL_PREFIX=<path> to adjust it
cmake ../.. -DBUILD_CLIENTS_TESTS=ON -DBUILD_CLIENTS_SAMPLES=ON
# Compile hipSPARSELt library
make -j$(nproc)
# Install hipSPARSELt to /opt/rocm
make install
Testing the hipSPARSELt installation#
After successfully compiling the library with the clients, you can test the hipSPARSELt installation by running an example:
Note
Run these commands from the projects/hipsparselt directory.
# Navigate to clients binary directory
cd build/release/clients/staging
# Execute hipSPARSELt example
./example_spmm_strided_batched -m 32 -n 32 -k 32 --batch_count 1
Running the benchmarks and unit tests#
To run the benchmarks, build hipSPARSELt with the -DBUILD_CLIENTS_BENCHMARKS=ON option (or use ./install.sh -c).
# Go to hipSPARSELt build directory
cd build/release
# Run benchmark, e.g.
./clients/staging/hipsparselt-bench -f spmm -i 200 -m 256 -n 256 -k 256
To run the unit tests, build hipSPARSELt with the -DBUILD_CLIENTS_TESTS=ON option (or use ./install.sh -c).
# Go to hipSPARSELt build directory
cd build/release
# Run all tests
./clients/staging/hipsparselt-test