diff --git a/README.md b/README.md index 5ad034ec5f8..58289e1b1a9 100644 --- a/README.md +++ b/README.md @@ -5,23 +5,26 @@ In other words, ClPy enables softwares written in CuPy to work also on OpenCL de ## Current status -Current ClPy is beta version, forked from [CuPy v2.1.0](https://github.com/cupy/cupy/releases/tag/v2.1.0). -ClPy is still under development and works on only limited APIs. - -* Most of [ndarray](https://docs-cupy.chainer.org/en/v2.5.0/reference/ndarray.html) are supported, but not perfectly -* Most of [universal functions](https://docs-cupy.chainer.org/en/v2.5.0/reference/ufunc.html) are supported, but not perfectly -* All [custom kernel](https://docs-cupy.chainer.org/en/v2.5.0/reference/kernel.html)s are supported. -* All BLAS APIs used by ClPy itself are supported. Other types are currently not. -* Sparse matrix, dnn, rand libraries are not supported +Current ClPy is release-candidate version, forked from [CuPy v2.1.0](https://github.com/cupy/cupy/releases/tag/v2.1.0). +ClPy support most of CuPy's functions. + +* All [ndarray](https://docs-cupy.chainer.org/en/v2.5.0/reference/ndarray.html) core +* All [universal functions](https://docs-cupy.chainer.org/en/v2.5.0/reference/ufunc.html) core +* All [custom kernel](https://docs-cupy.chainer.org/en/v2.5.0/reference/kernel.html)s core +* BLAS library compatible with cuBLAS +* Multiple device (thus ChainerMN) + +ClPy is still under development and has limitations as followings. + +* Other CUDA libraries (cuSPARSE, cuSOLVER, cuDnn, cuRAND, thrust) are not supported * half and complex are not supported -* Works on only a single device * No multiple command queue (Stream on CUDA) * Dockerfile and some other files are just neglected thus don't work well -Many original CuPy's tests are passed but not perfectly. See current [CuPy's test and example results](https://github.com/fixstars/ClPy/wiki/cupy_test_example_results). +Therefore, almost all original CuPy's tests are passed excluding unsupported libraries. See current [CuPy's test and example results](https://github.com/fixstars/ClPy/wiki/cupy_test_example_results). -[Chainer](https://chainer.org/) works with limited situation. -Some examples are confirmed to work. See current [Chainer's test and example results](https://github.com/fixstars/ClPy/wiki/chainer_test_example_results). +Almost all [Chainer](https://chainer.org/) works. +See current [Chainer's test and example results](https://github.com/fixstars/ClPy/wiki/chainer_test_example_results). ## Recommended system @@ -119,17 +122,16 @@ $ python -m pytest test_you_want.py ## Future plan -We are developing v0.2.1beta2 for next release. +We are developing v2.1.0rc2 for next release. -* Support all BLAS APIs * Accelerate chainer's example performance -* Multiple devices * Multiple CommandQueue (Stream) +* Support sorting algorithm * -- and other functions and/or bug fixes that someone develops and/or requests.. We also plan to update CuPy's base version to v4 or v5 after beta release. -Check [github's issues and pull requests ](https://github.com/fixstars/clpy/issues) to get latest status. +Check [github's issues and pull requests](https://github.com/fixstars/clpy/issues) to get latest status. ## License diff --git a/clpy/_version.py b/clpy/_version.py index 3ec699a31d8..1aab64cb38c 100644 --- a/clpy/_version.py +++ b/clpy/_version.py @@ -1 +1 @@ -__version__ = '2.1.0b1' +__version__ = '2.1.0rc1'