Skip to content

Commit

Permalink
Prepare for 0.8 release (#828)
Browse files Browse the repository at this point in the history
* Prepare for release

* Prepare docs for release

* Update Slack channel link

* Fix 0.8 numbering

* Update releasenotes/notes/0.8-prelude-3057999fac96bf43.yaml

Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>

* Update releasenotes/notes/0.8-prelude-3057999fac96bf43.yaml

Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>

* Remark Qiskit 1.0+ requirement and move renos

* Move V2 renos and update prelude

---------

Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>
Co-authored-by: M. Emre Sahin <40424147+OkuyanBoga@users.noreply.github.com>
  • Loading branch information
3 people authored Nov 11, 2024
1 parent 2d2a249 commit 512fc44
Show file tree
Hide file tree
Showing 13 changed files with 28 additions and 17 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ Kernels and Quantum Neural Networks, used in various applications including clas
and regression.

This library is part of the Qiskit Community ecosystem, a collection of high-level codes that are based
on the Qiskit software development kit. As of version `0.7.0`, Qiskit Machine Learning is co-maintained
by IBM and the Hartree Center, part of the UK Science and Technologies Facilities Council (STFC).
on the Qiskit software development kit. As of version `0.7`, Qiskit Machine Learning is co-maintained
by IBM and the [Hartree Center](https://www.hartree.stfc.ac.uk/), part of the UK Science and
Technologies Facilities Council (STFC).

The Qiskit Machine Learning framework aims to be:

Expand Down Expand Up @@ -97,7 +98,7 @@ For more details on how to do so and much more, follow the instructions in the
## Migration to Qiskit 1.x
> [!NOTE]
> Qiskit Machine Learning depends on Qiskit, which will be automatically installed as a
> dependency when you install Qiskit Machine Learning. From version `0.8.0` of Qiskit Machine
> dependency when you install Qiskit Machine Learning. From version `0.8` of Qiskit Machine
> Learning, Qiskit `1.0` or above will be required. If you have a pre-`1.0` version of Qiskit
> installed in your environment (however it was installed), you should upgrade to `1.x` to
> continue using the latest features. You may refer to the
Expand Down Expand Up @@ -174,8 +175,10 @@ By participating, you are expected to uphold this code.

We use [GitHub issues](https://github.com/qiskit-community/qiskit-machine-learning/issues) for tracking requests and bugs. Please
[join the Qiskit Slack community](https://qisk.it/join-slack)
and for discussion and simple questions.
For questions that are more suited for a forum, we use the **Qiskit** tag in [Stack Overflow](https://stackoverflow.com/questions/tagged/qiskit).
and use the [`#qiskit-machine-learning`](https://qiskit.enterprise.slack.com/archives/C07JE3V55C1)
channel for discussions and short questions.
For questions that are more suited for a forum, you can use the **Qiskit** tag in [Stack Overflow]
(https://stackoverflow.com/questions/tagged/qiskit).

## Humans behind Qiskit Machine Learning

Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Migration to Qiskit 1.x
.. note::

Qiskit Machine Learning depends on Qiskit, which will be automatically installed as a
dependency when you install Qiskit Machine Learning. From version ``0.8.0`` of Qiskit Machine
dependency when you install Qiskit Machine Learning. From version ``0.8`` of Qiskit Machine
Learning, Qiskit ``1.0`` or above will be required. If you have a pre-``1.0`` version of Qiskit
installed in your environment (however it was installed), you should upgrade to ``1.x`` to
continue using the latest features. You may refer to the
Expand Down
5 changes: 3 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ Kernels and Quantum Neural Networks, used in various applications including clas
and regression.

This library is part of the Qiskit Community ecosystem, a collection of high-level codes that are based
on the Qiskit software development kit. As of version ``0.7.0``, Qiskit Machine Learning is co-maintained
by IBM and the Hartree Center, part of the UK Science and Technologies Facilities Council (STFC).
on the Qiskit software development kit. As of version ``0.7``, Qiskit Machine Learning is co-maintained
by IBM and the `Hartree Center <https://www.hartree.stfc.ac.uk/>`__, part of the UK Science and
Technologies Facilities Council (STFC).

The Qiskit Machine Learning framework aims to be:

Expand Down
8 changes: 8 additions & 0 deletions releasenotes/notes/0.8/0.8-prelude-3057999fac96bf43.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
prelude: >
From this release, Qiskit Machine Learning requires Qiskit `1.0` or above, with important
changes and upgrades, such as the introduction of Quantum Bayesian inference and the migration
of a subset of Qiskit Algorithms features to Qiskit Machine Learning. These changes are
part of the process to build full compatibility with the version-2 (V2) Qiskit primitives
available from version `0.8` of Qiskit Machine Learning. V1 primitives are deprecated and
will be removed from version `0.9` (please find more information below).
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
---
prelude: >
This release includes the migration of a subset of Qiskit Algorithms features to Qiskit Machine
Learning. This ensures continued enhancement of essential features for Qiskit Machine
Learning following the end of official support for Qiskit Algorithms. Therefore, Qiskit
Machine Learning will no longer depend on Qiskit Algorithms, possibly introducing breaking
changes in import structures. Some quick-fixes are described below.
features:
- |
Migrated essential Qiskit Algorithms features to Qiskit Machine Learning:
Expand All @@ -28,10 +21,16 @@ features:
You may be required to upgrade Qiskit Aer accordingly, depending on your set-up.
upgrade:
- |
From version `0.8.0`, Qiskit Machine Learning requires Qiskit `1.0` or higher.
- |
The merge of some of the features of Qiskit Algorithms into Qiskit Machine Learning might lead
to breaking changes. For this reason, caution is advised when updating to version 0.8 during
critical production stages in a project.
to breaking changes. For this reason, caution is advised when updating to version `0.8` during
critical production stages in a project. This change ensures continued
enhancement and maintenance of essential features for Qiskit Machine
Learning following the end of official support for Qiskit Algorithms. Therefore, Qiskit
Machine Learning will no longer depend on Qiskit Algorithms.
- |
Users must update their imports and code references in code that uses Qiskit Machine Leaning
Expand Down

0 comments on commit 512fc44

Please sign in to comment.