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

==================
cuTensorNet v1.0.0
==================

* Functionality/performance improvements:

  * Greatly reduced the workspace memory size required.
  * Reduced the execution time of the pathfinder with multithreading and internal optimization.
  * Support for hyperedges in tensor networks.
  * Support for tensor networks described by generalized Einstein summation expressions.

* Add new APIs and functionalities for:

  * Managing workspace (see :ref:`cuTensorNet workspace management API` for details).
  * Binding a user-provided, *stream-ordered* memory pool to the library (see :ref:`cuTensorNet memory management API` for details).
  * Query of the output tensor details (see `cutensornetGetOutputTensorDetails`).
  * Set the number of threads for the hyperoptimizer (see :ref:`hyperoptimizer` for details).
  * Setting a logger callback with user-provided data (see `cutensornetLoggerSetCallbackData`).

* API changes:

  * Replaced `cutensornetContractionGetWorkspaceSize` with `cutensornetWorkspaceComputeSizes`.
  * `cutensornetCreateContractionPlan`, `cutensornetContractionAutotune`, and `cutensornetContraction` receive a workspace descriptor instead of workspace pointer and size params.
  * Renamed `cutensornetGraphAlgo_t` and `cutensornetMemoryModel_t` enumerations' options.

*Compatibility notes*:

* *cuTensorNet* requires CUDA 11.x.
* *cuTensorNet* requires cuTENSOR 1.5.0 or above.
* *cuTensorNet* requires OpenMP runtime (GOMP).
* *cuTensorNet* no longer requires NVIDIA HPC SDK.

==================
cuTensorNet v0.1.0
==================

* Initial public release
* Add support for ``Linux ppc64le``
* Add new APIs and functionalities for:

  * Fine-tuning the slicing algorithm
  * Reconfiguring a tensor network
  * Simplifying a tensor network
  * Optimizing pathfinder parameters using the hyperoptimizer
  * Retrieving the optimizer config parameters

* API changes:

  * ``cutensornetContractionGetWorkspace`` is renamed to `cutensornetContractionGetWorkspaceSize`
  * `cutensornetContractionAutotune`'s function signature has changed

*Compatibility notes*:

* *cuTensorNet* requires cuTENSOR 1.4.0 or above
* *cuTensorNet* requires NVIDIA HPC SDK 21.11 or above

==================
cuTensorNet v0.0.1
==================

* Initial release
* Support ``Linux x86_64`` and ``Linux Arm64``
* Support Volta and Ampere architectures (compute capability 7.0+)

*Compatibility notes*:

* *cuTensorNet* requires CUDA 11.4 or above
* *cuTensorNet* requires cuTENSOR 1.3.3 or above
* *cuTensorNet* supports NVIDIA HPC SDK 21.7 or above

*Limitation notes*:

* This release is optimized for NVIDIA A100 and V100 GPUs.