Please do not send a PR yet

Please see chainer project.

CuPy : NumPy-like API accelerated with CUDA

Requirements

CuPy is tested on Ubuntu 14.04 and CentOS 7. We recommend them to use CuPy, though it may run on other systems as well.

Minimum requirements:

Python 2.7.6+, 3.4.3+, 3.5.1+
NumPy 1.9, 1.10, 1.11
Six 1.9

Requirements for some features:

CUDA support
- CUDA 6.5, 7.0, 7.5
- filelock
- g++ 4.8.4+
cuDNN support
- cuDNN v2, v3, v4, v5
Testing utilities
- Mock
- Nose

Installation

Minimum installation

If you use old setuptools, upgrade it:

pip install -U setuptools

Then, install CuPy via PyPI:

pip install cupy

You can also install CuPy from the source code:

python setup.py install

Installation with CUDA

If you want to enable CUDA, first you have to install CUDA and set the environment variable PATH and LD_LIBRARY_PATH for CUDA executables and libraries. For example, if you are using Ubuntu and CUDA is installed by the official distribution, then CUDA is installed at /usr/local/cuda. In this case, you have to add the following lines to .bashrc or .zshrc (choose which you are using):

export PATH=/usr/local/cuda/bin:$PATH
export LD_LIBRARY_PATH=/usr/local/cuda/lib64:$LD_LIBRARY_PATH

If you want to enable cuDNN, add a directory containing cudnn.h to CPATH, and add a directory containing libcudnn.so to LIBRARY_PATH and LD_LIBRARY_PATH:

export CPATH=/path/to/cudnn/include:$CPATH
export LIBRARY_PATH=/path/to/cudnn/lib:$LIBRARY_PATH
export LD_LIBRARY_PATH=/path/to/cudnn/lib:$LD_LIBRARY_PATH

Do not forget to restart your terminal session (or source it) to enable these changes. And then, reinstall CuPy.

Reference

Tokui, S., Oono, K., Hido, S. and Clayton, J., Chainer: a Next-Generation Open Source Framework for Deep Learning, Proceedings of Workshop on Machine Learning Systems(LearningSys) in The Twenty-ninth Annual Conference on Neural Information Processing Systems (NIPS), (2015) URL, BibTex

More information

Official site: http://cupy-ndarray.org/
Official document: http://docs.cupy-ndarray.org/
github: https://github.com/pfnet/cupy
Forum: https://groups.google.com/forum/#!forum/chainer
Forum (Japanese): https://groups.google.com/forum/#!forum/chainer-jp
Twitter: https://twitter.com/ChainerOfficial
Twitter (Japanese): https://twitter.com/chainerjp

License

MIT License (see LICENSE file).

shashankg7/cupy