Building and Installing#
Prerequisites#
If using the rocBLAS backend on an AMD machine:
A ROCm enabled platform, more information ROCm Documentation.
A compatible version of rocBLAS
A compatible version of rocSOLVER for full functionality
If using the cuBLAS backend on a Nvidia machine:
A HIP enabled platform, more information HIP installation.
A working CUDA toolkit, including cuBLAS, see CUDA toolkit.
Installing pre-built packages#
Download pre-built packages either from ROCm’s package servers or by clicking the GitHub releases tab and manually downloading, which could be newer. Release notes are available for each release on the releases tab.
hipBLAS build#
Build library dependencies + library#
The root of this repository has a helper bash script install.sh to build and install hipBLAS with a single command. It does take a lot of options and hard-codes configuration that can be specified through invoking cmake directly, but it’s a great way to get started quickly and can serve as an example of how to build/install. A few commands in the script need sudo access so that it may prompt you for a password.
Typical uses of install.sh to build (library dependencies + library) are in the table below.
Command |
Description |
|---|---|
|
Help information. |
|
Build library dependencies and library in your local directory. The -d flag only needs to be used once. For subsequent invocations of install.sh it is not necessary to rebuild the dependencies. |
|
Build library in your local directory. It is assumed dependencies have been built. |
|
Build library, then build and install hipBLAS package in /opt/rocm/hipblas. You will be prompted for sudo access. This will install for all users. If you want to keep hipBLAS in your local directory, you do not need the -i flag. |
Build library dependencies + client dependencies + library + client#
The client contains executables in the table below.
executable name |
description |
|---|---|
hipblas-test |
runs Google Tests to test the library |
hipblas-bench |
executable to benchmark or test individual functions |
example-sscal |
example C code calling hipblas_sscal function |
Common uses of install.sh to build (dependencies + library + client) are in the table below.
Command |
Description |
|---|---|
|
Help information. |
|
Build library dependencies, client dependencies, library, and client in your local directory. The -d flag only needs to be used once. For subsequent invocations of install.sh it is not necessary to rebuild the dependencies. |
|
Build library and client in your local directory. It is assumed the dependencies have been built. |
|
Build library dependencies, client dependencies, library, client, then build and install the hipBLAS package. You will be prompted for sudo access. It is expected that if you want to install for all users you use the -i flag. If you want to keep hipBLAS in your local directory, you do not need the -i flag. |
|
Build and install hipBLAS package, and build the client. You will be prompted for sudo access. This will install for all users. If you want to keep hipBLAS in your local directory, you do not need the -i flag. |
Dependencies#
Dependencies are listed in the script install.sh. Use install.sh with -d option to install dependencies.
CMake has a minimum version requirement listed in the file install.sh. See –cmake_install flag in install.sh to upgrade automatically.
Manual build (all supported platforms)#
This section has useful information on how to configure cmake and manually build.
Dependencies For Building Library#
Build Library Using Individual Commands#
Build Library + Tests + Benchmarks + Samples Using Individual Commands#
The repository contains source for clients that serve as samples, tests and benchmarks. Clients source can be found in the clients subdir.
Dependencies (only necessary for hipBLAS clients)#
The hipBLAS samples have no external dependencies, but our unit test and benchmarking applications do. These clients introduce the following dependencies:
lapack, lapack itself brings a dependency on a fortran compiler
Unfortunately, googletest and lapack are not as easy to install. Many distros do not provide a googletest package with pre-compiled libraries, and the lapack packages do not have the necessary cmake config files for cmake to configure linking the cblas library. hipBLAS provide a cmake script that builds the above dependencies from source. This is an optional step; users can provide their own builds of these dependencies and help cmake find them by setting the CMAKE_PREFIX_PATH definition. The following is a sequence of steps to build dependencies and install them to the cmake default /usr/local.
(optional, one time only)#
Once dependencies are available on the system, it is possible to configure the clients to build. This requires a few extra cmake flags to the library cmake configure script. If the dependencies are not installed into system defaults (like /usr/local ), you should pass the CMAKE_PREFIX_PATH to cmake to help find them.