This is an experimental feature. We recommend only for advanced users to use this.
We recommend the following Linux distributions.
- Ubuntu 16.04 / 18.04 LTS (64-bit)
You need to have the following components to use CuPy.
And please install ROCm libraries.
$ sudo apt install hipblas hipsparse rocrand rocthrust
Before installing CuPy, we recommend you to upgrade setuptools
and pip
:
$ pip install -U setuptools pip
It is recommended to use wheels whenever possible. However, there is currently no wheels for the ROCm environment, so you have to build it from source.
When installing from source, C++ compiler such as g++
is required.
You need to install it before installing CuPy.
This is typical installation method for each platform:
# Ubuntu 16.04 $ apt-get install g++
Note
If you want to upgrade or downgrade the version of ROCm, you may need to reinstall CuPy after that. See :ref:`rocm_install_reinstall` for details.
You can install CuPy package via pip
.
It builds CuPy from source.
$ export HCC_AMDGPU_TARGET=gfx900 # This value should be changed based on your GPU $ export __HIP_PLATFORM_HCC__ $ export CUPY_INSTALL_USE_HIP=1 $ pip install cupy
The tarball of the source tree is available via pip download cupy
or from the release notes page.
You can install CuPy from the tarball:
$ pip install cupy-x.x.x.tar.gz
You can also install the development version of CuPy from a cloned Git repository:
$ git clone https://github.com/cupy/cupy.git $ cd cupy $ export HCC_AMDGPU_TARGET=gfx900 # This value should be changed based on your GPU $ export __HIP_PLATFORM_HCC__ $ export CUPY_INSTALL_USE_HIP=1 $ pip install .
If you are using the source tree downloaded from GitHub, you need to install Cython 0.28.0 or later (pip install cython
).
Use pip to uninstall CuPy:
$ pip uninstall cupy
Note
When you upgrade Chainer, pip
sometimes installs the new version without removing the old one in site-packages
.
In this case, pip uninstall
only removes the latest one.
To ensure that CuPy is completely removed, run the above command repeatedly until pip
returns an error.
Just use pip install
with -U
option:
$ export HCC_AMDGPU_TARGET=gfx900 # This value should be changed based on your GPU $ export __HIP_PLATFORM_HCC__ $ export CUPY_INSTALL_USE_HIP=1 $ pip install -U cupy
If you want to reinstall CuPy, please uninstall CuPy first, and then install again.
When reinstalling CuPy, we recommend to use --no-cache-dir
option as pip
caches the previously built binaries:
$ pip uninstall cupy $ export HCC_AMDGPU_TARGET=gfx900 # This value should be changed based on your GPU $ export __HIP_PLATFORM_HCC__ $ export CUPY_INSTALL_USE_HIP=1 $ pip install cupy --no-cache-dir
Please make sure that you are using the latest setuptools
and pip
:
$ pip install -U setuptools pip
Use -vvvv
option with pip
command to investigate the details of errors.
This will display all logs of installation:
$ pip install cupy -vvvv
If you are using sudo
to install CuPy, note that sudo
command does not propagate environment variables.
If you need to pass environment variable (e.g., ROCM_HOME
), you need to specify them inside sudo
like this:
$ sudo ROCM_HOME=/opt/rocm pip install cupy
If you are using certain versions of conda, it may fail to build CuPy with error g++: error: unrecognized command line option ‘-R’
.
This is due to a bug in conda (see conda/conda#6030 for details).
If you encounter this problem, please downgrade or upgrade it.