diff options
Diffstat (limited to 'src/pyclblast/README.md')
| -rw-r--r-- | src/pyclblast/README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/src/pyclblast/README.md b/src/pyclblast/README.md new file mode 100644 index 00000000..be37af01 --- /dev/null +++ b/src/pyclblast/README.md @@ -0,0 +1,31 @@ + +PyCLBlast: Python wrappers for the tuned OpenCL BLAS library CLBlast +================ + +This Python package provides a straightforward wrapper for CLBast based on PyOpenCL. CLBlast is a modern, lightweight, performant and tunable OpenCL BLAS library written in C++11. It is designed to leverage the full performance potential of a wide variety of OpenCL devices from different vendors, including desktop and laptop GPUs, embedded GPUs, and other accelerators. CLBlast implements BLAS routines: basic linear algebra subprograms operating on vectors and matrices. + +See [the CLBlast repository](https://github.com/CNugteren/CLBlast) and [the CLBlast website](https://cnugteren.github.io/clblast) for more information about CLBlast. + + +Prerequisites +------------- + +Non-Python requirements: + +* OpenCL +* [CLBlast](https://github.com/CNugteren/CLBlast) + +Python requirements: + +* Cython +* [PyOpenCL](https://github.com/pyopencl/pyopencl/) + + +Getting started +------------- + +After installation OpenCL and CLBlast, simply use pip to install PyCLBlast, e.g.: + + pip install --user pyclblast + +To start using the library, browse the [CLBlast](https://github.com/CNugteren/CLBlast) documentation or check out the PyCLBlast samples provides in the `samples` subfolder. |