*************
Release Notes
*************

=========================
cuQuantum Python v22.05.0
=========================

* Bugs fixed:

  * Make ``typing_extensions`` a required dependency (`NVIDIA/cuQuantum#3 <https://github.com/NVIDIA/cuQuantum/issues/3>`_)
  * Fix issues in the test suite

* Other changes:

  * The Python sample (`python/samples/tensornet_example.py <https://github.com/NVIDIA/cuQuantum/blob/main/python/samples/tensornet_example.py>`_) is updated to include a correctness check

=========================
cuQuantum Python v22.03.0
=========================

* Stable release:

  * Starting this release, cuQuantum Python switches to the CalVer versioning scheme, following cuQuantum SDK
  * ``pip`` wheels are released on PyPI: ``pip install cuquantum-python``

* Functionality/performance improvements:

  * High-level tensor network APIs are now fully NumPy compliant:

    - Support generalized einsum expressions
    - Support ellipsis
    - Support broadcasting

* Add new APIs and functionalities for:

  * For low-level APIs, please refer to the release notes of :ref:`cuStateVec v1.0.0 <custatevec/release_notes:cuStateVec v1.0.0>`
    and :ref:`cuTensorNet v1.0.0 <cutensornet/release_notes:cuTensorNet v1.0.0>`.
  * The high-level APIs support an EMM-like memory plugin interface (see :ref:`high-level memory management`).

* API changes:

  * For low-level APIs, please refer to the release notes of :ref:`cuStateVec v1.0.0 <custatevec/release_notes:cuStateVec v1.0.0>`
    and :ref:`cuTensorNet v1.0.0 <cutensornet/release_notes:cuTensorNet v1.0.0>`.
  * No API breaking changes for the high-level APIs.

*Compatibility notes*:

* cuQuantum Python requires cuQuantum v22.03
* cuQuantum Python requires Python 3.7+

  - In the next release, Python 3.7 will be dropped to follow `NEP-29`_.

* cuQuantum Python requires NumPy v1.17+

  - In the next release, NumPy 1.17 & 1.18 will be dropped to follow `NEP-29`_.

* cuQuantum Python requires CuPy v9.5+
* cuQuantum Python supports PyTorch v1.10+

.. _NEP-29: https://numpy.org/neps/nep-0029-deprecation_policy.html

*Known issues*:

* If you install cuQuantum Python from PyPI (``pip install cuquantum-python``), make sure you also install ``typing_extensions`` (via ``pip`` or ``conda``). This only affects the wheel installation and will be fixed in the next release. (`NVIDIA/cuQuantum#3 <https://github.com/NVIDIA/cuQuantum/issues/3>`_)

=========================
cuQuantum Python v0.1.0.1
=========================

* Patch release:

  - Add a ``__version__`` string

=========================
cuQuantum Python v0.1.0.0
=========================

* Initial release (beta 2)

*Compatibility notes*:

* cuQuantum Python requires cuQuantum v0.1.0
* cuQuantum Python requires NumPy v1.17+
* cuQuantum Python requires CuPy v9.5+
* cuQuantum Python supports PyTorch v1.10+

*Limitation notes*:

* In certain environments, if PyTorch is installed ``import cuquantum`` could fail (with a segmentation fault). It is currently under investigation and a temporary workaround is to import ``torch`` before importing ``cuquantum``.