diff --git a/releasenotes/notes/0.2/0.2-summary-734dd5eb5f550189.yaml b/releasenotes/notes/0.2/0.2-summary-734dd5eb5f550189.yaml new file mode 100644 index 000000000..a582df5dd --- /dev/null +++ b/releasenotes/notes/0.2/0.2-summary-734dd5eb5f550189.yaml @@ -0,0 +1,56 @@ +--- +prelude: > + The Qiskit Dynamics 0.2 release adds support for sparse JAX arrays when building + solvers and models, and adds new fixed-step and parallelized JAX solvers. +features: + - | + Adds JAX sparse evaluation mode to models and + :class:`qiskit_dynamics.Solver`. + This mode can be enabled by setting the ``evaluation_mode`` to + ``'sparse'`` while :meth:`~qiskit_dynamics.array.Array.default_backend` is set to ``'jax'`` + This evaluation mode is only recommended for use on CPU unless + the arrays are extremely sparse. + - | + Adds additional fixed-step solvers implemented with JAX. New solvers are + ``'jax_RK4'``, available through :func:`qiskit_dynamics.solve_ode` + and parallelized solvers ``'jax_RK4_parallel'`` and ``'jax_expm_parallel'`` available + via :func:`qiskit_dynamics.solve_lmde`. The parallelized solvers + are only recommended for use with GPU. + - | + Adds new :class:`~qiskit_dynamics.array.Array` class methods + :meth:`~qiskit_dynamics.array.Array.default_backend`, + :meth:`~qiskit_dynamics.array.Array.set_default_backend`, + :meth:`~qiskit_dynamics.array.Array.available_backends` which implement + the functionality of the previous methods of the same name from the + dispatch module. +upgrade: + - | + The :class:`~qiskit_dynamics.array.Array` class and + :func:`~qiskit_dynamics.array.wrap` function have been moved from the + :mod:`qiskit_dynamics.dispatch` module to a separate + :mod:`qiskit_dynamics.array` module to separate the ``Array`` class + from the underlying dispatch system it uses internally. +deprecations: + - | + The :func:`qiskit_dynamics.dispatch.default_backend` function has been + deprecated and will be removed in 0.3.0 release. It has been replaced by + the :meth:`qiskit_dynamics.array.Array.default_backend` class method. + - | + The :func:`qiskit_dynamics.dispatch.set_default_backend` function has been + deprecated and will be removed in 0.3.0 release. It has been replaced by + the :meth:`qiskit_dynamics.array.Array.set_default_backend` class method. + - | + The :func:`qiskit_dynamics.dispatch.available_backends` function has been + deprecatedand will be removed in 0.3.0 release. It has been replaced by + the :meth:`qiskit_dynamics.array.Array.available_backends` class method. + - | + The :func:`qiskit_dynamics.dispatch.backend_types` function has been + deprecated as it is no longer needed. + - | + Importing the :class:`~qiskit_dynamics.array.Array` class for the + :mod:`qiskit_dynamics.dispatch` module has been deprecated. It should now + be imported from the :mod:`qiskit_dynamics.array` module instead. + - | + Importing the :class:`~qiskit_dynamics.array.wrap` function for the + :mod:`qiskit_dynamics.dispatch` module has been deprecated. It should now + be imported from the :mod:`qiskit_dynamics.array` module instead. diff --git a/releasenotes/notes/array-methods-67a41ffdba2e86c3.yaml b/releasenotes/notes/array-methods-67a41ffdba2e86c3.yaml deleted file mode 100644 index b0984aebf..000000000 --- a/releasenotes/notes/array-methods-67a41ffdba2e86c3.yaml +++ /dev/null @@ -1,25 +0,0 @@ ---- -features: - - | - Adds new :class:`~qiskit_dynamics.array.Array` class methods - :meth:`~qiskit_dynamics.array.Array.default_backend`, - :meth:`~qiskit_dynamics.array.Array.set_default_backend`, - :meth:`~qiskit_dynamics.array.Array.available_backends` which implement - the functionality of the previous methods of the same name from the - dispatch module. -deprecations: - - | - The :func:`qiskit_dynamics.dispatch.default_backend` function has been - deprecated and will be removed in 0.3.0 release. It has been replaced by - the :meth:`qiskit_dynamics.array.Array.default_backend` class method. - - | - The :func:`qiskit_dynamics.dispatch.set_default_backend` function has been - deprecated and will be removed in 0.3.0 release. It has been replaced by - the :meth:`qiskit_dynamics.array.Array.set_default_backend` class method. - - | - The :func:`qiskit_dynamics.dispatch.available_backends` function has been - deprecatedand will be removed in 0.3.0 release. It has been replaced by - the :meth:`qiskit_dynamics.array.Array.available_backends` class method. - - | - The :func:`qiskit_dynamics.dispatch.backend_types` function has been - deprecated as it is no longer needed. diff --git a/releasenotes/notes/array-module-4ecd2d682c2fb2af.yaml b/releasenotes/notes/array-module-4ecd2d682c2fb2af.yaml deleted file mode 100644 index 81a3eae2d..000000000 --- a/releasenotes/notes/array-module-4ecd2d682c2fb2af.yaml +++ /dev/null @@ -1,17 +0,0 @@ ---- -upgrade: - - | - The :class:`~qiskit_dynamics.array.Array` class and - :func:`~qiskit_dynamics.array.wrap` function have been moved from the - :mod:`qiskit_dynamics.dispatch` module to a separate - :mod:`qiskit_dynamics.array` module to separate the ``Array`` class - from the underlying dispatch system it uses internally. -deprecations: - - | - Importing the :class:`~qiskit_dynamics.array.Array` class for the - :mod:`qiskit_dynamics.dispatch` module has been deprecated. It should now - be imported from the :mod:`qiskit_dynamics.array` module instead. - - | - Importing the :class:`~qiskit_dynamics.array.wrap` function for the - :mod:`qiskit_dynamics.dispatch` module has been deprecated. It should now - be imported from the :mod:`qiskit_dynamics.array` module instead. diff --git a/releasenotes/notes/jax-sparse-solvers-8d469991f71466b0.yaml b/releasenotes/notes/jax-sparse-solvers-8d469991f71466b0.yaml deleted file mode 100644 index 1455e529c..000000000 --- a/releasenotes/notes/jax-sparse-solvers-8d469991f71466b0.yaml +++ /dev/null @@ -1,15 +0,0 @@ ---- -features: - - | - Adds JAX sparse evaluation mode to models and - :class:`qiskit_dynamics.Solver`. - This mode can be enabled by setting the ``evaluation_mode`` to - ``'sparse'`` while :meth:`~qiskit_dynamics.array.Array.default_backend` is set to ``'jax'`` - This evaluation mode is only recommended for use on CPU unless - the arrays are extremely sparse. - - | - Adds additional fixed-step solvers implemented with JAX. New solvers are - ``'jax_RK4'``, available through :func:`qiskit_dynamics.solve_ode` - and parallelized solvers ``'jax_RK4_parallel'`` and ``'jax_expm_parallel'`` available - via :func:`qiskit_dynamics.solve_lmde`. The parallelized solvers - are only recommended for use with GPU.