AMD's library for high peformance machine learning primitives. MIOpen supports two programming models -
- A ROCm enabled platform, more info here
- Base software stack, which includes
- OpenCL - OpenCL libraries and header files
- HIP -
- HIP and HCC libraries and header files
- clang-ocl -- required
- MIOpenGEMM to enable various functionalities including transposed and dilated convolutions
- ROCm cmake modules can be installed from here
- Half - IEEE 754-based half-precision floating point library
- OpenSSL or libressl
- Boost at least version 1.58
- MIOpen uses
boost-filesystempackages to enable persistent kernel cache
- MIOpen uses
Installing the dependencies
The dependencies can be installed with the
cmake -P install_deps.cmake
This will install by default to
/usr/local but it can be installed in another location with
cmake -P install_deps.cmake --prefix /some/local/dir
Instructions to manually install all the dependencies on Ubuntu v16 are present in this section.
Installing MIOpen with pre-built packages
MIOpen can be installed on Ubuntu using
For OpenCL backend:
apt-get install miopen-opencl
For HIP backend:
apt-get install miopen-hip
Currently both the backends cannot be installed on the same system simultaneously. If a different backend other than what currently exists on the system is desired, please remove the existing backend completely and then install the new backend.
Building MIOpen from source
Configuring with cmake
First create a build directory:
mkdir build; cd build;
Next configure cmake. The preferred backend for MIOpen can be set using the
-DMIOPEN_BACKEND cmake variable.
For OpenCL, run:
cmake -DMIOPEN_BACKEND=OpenCL ..
The above assumes that OpenCL is installed in one of the standard locations. If not, then manually set these two cmake variables:
cmake -DMIOPEN_BACKEND=OpenCL -DOPENCL_LIBRARIES=<opencl-library-path> -DOPENCL_INCLUDE_DIRS=<opencl-headers-path> ..
For HIP, run:
Set the C++ compiler to
cmake -DMIOPEN_BACKEND=HIP -DCMAKE_PREFIX_PATH="<hip-installed-path>;<hcc-installed-path>;<clang-ocl-installed-path>" ..
An example cmake step can be:
apt-geton Ubuntu v16? Yes.
CXX=/opt/rocm/hcc/bin/hcc cmake -DMIOPEN_BACKEND=HIP -DCMAKE_PREFIX_PATH="/opt/rocm/hcc;/opt/rocm/hip" -DCMAKE_CXX_FLAGS="-isystem /usr/include/x86_64-linux-gnu/" ..
apt-geton Ubuntu v16? No.
CXX=/opt/rocm/hcc/bin/hcc cmake -DMIOPEN_BACKEND=HIP -DCMAKE_PREFIX_PATH="/opt/rocm/hcc;/opt/rocm/hip" ..
Setting up locations
By default the install location is set to '/opt/rocm', this can be set by using
cmake -DMIOPEN_BACKEND=OpenCL -DCMAKE_INSTALL_PREFIX=<miopen-installed-path> ..
The default path to the System PerfDb is
miopen/share/miopen/db/ within install location. The default path to the User PerfDb is
~/.config/miopen/. For development purposes, setting
BUILD_DEV will change default path to both database files to the source directory:
cmake -DMIOPEN_BACKEND=OpenCL -DBUILD_DEV=On ..
Database paths can be explicitly customized by means of
MIOPEN_DB_PATH (System PerfDb) and
MIOPEN_USER_DB_PATH (User PerfDb) cmake variables.
Changing the cmake configuration
The configuration can be changed after running cmake by using
ccmake .. OR
ccmake program is not available on windows.
Building the library
The library can be built, from the
build directory using the 'Release' configuration:
cmake --build . --config Release OR
And can be installed by using the 'install' target:
cmake --build . --config Release --target install OR
This will install the library to the
CMAKE_INSTALL_PREFIX path that was set.
Building the driver
MIOpen provides an application-driver which can be used to execute any one particular layer in isolation and measure performance and verification of the library.
The driver can be built using the
cmake --build . --config Release --target MIOpenDriver OR
Documentation on how to run the driver is here.
Running the tests
The tests can be run by using the 'check' target:
cmake --build . --config Release --target check OR
A single test can be built and ran, by doing:
cmake --build . --config Release --target test_tensor ./bin/test_tensor
Building the documentation
HTML and PDF documentation can be built using:
cmake --build . --config Release --target doc OR
This will build a local searchable web site inside the ./MIOpen/doc/html folder and a PDF document inside the ./MIOpen/doc/pdf folder.
Documentation is built using generated using Doxygen and should be installed separately.
Requirements for both Sphinx, Breathe, and the ReadTheDocs theme can be filled for these in the MIOpen/doc folder:
pip install -r ./requirements.txt
Depending on your setup
sudo may be required for the pip install.
Formatting the code
All the code is formatted using clang-format. To format a file, use:
clang-format-3.8 -style=file -i <path-to-source-file>
Also, githooks can be installed to format the code per-commit:
Installing the dependencies manually
If Ubuntu v16 is used then the
Boost packages can also be installed by:
sudo apt-get install libssl-dev sudo apt-get install libboost-dev sudo apt-get install libboost-system-dev sudo apt-get install libboost-filesystem-dev
half header needs to be installed from here.
The easiest way is to use docker. You can build the top-level docker file:
docker build -t miopen .
Then to enter the developement environment use
docker run --device='/dev/kfd' --device='/dev/dri' -v=`pwd`:/data -w /data --group-add video -it miopen