From 90bb3ee5728e554eb8f39c25d1bc0d627976c2c9 Mon Sep 17 00:00:00 2001 From: Will Shanks Date: Mon, 3 Nov 2025 16:30:37 -0500 Subject: [PATCH] Prepare 0.13 release notes --- docs/release_notes.rst | 64 +++++++++++++++++++ ...add-benchmark-suffix-c3ab8c14c89edb33.yaml | 12 ---- .../average-pub-params-f24fd73f817051ac.yaml | 6 +- .../notes/fix_hgp_bug-e131e03f71459029.yaml | 21 ------ .../from-config-dict-6629c37d2572cfbc.yaml | 6 -- .../prepare-0.13.0-167e9b7befc25c7f.yaml | 3 + 6 files changed, 72 insertions(+), 40 deletions(-) delete mode 100644 releasenotes/notes/add-benchmark-suffix-c3ab8c14c89edb33.yaml delete mode 100644 releasenotes/notes/fix_hgp_bug-e131e03f71459029.yaml delete mode 100644 releasenotes/notes/from-config-dict-6629c37d2572cfbc.yaml create mode 100644 releasenotes/notes/prepare-0.13.0-167e9b7befc25c7f.yaml diff --git a/docs/release_notes.rst b/docs/release_notes.rst index 5b7b0f3c52..0e7a8f3640 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -5,6 +5,70 @@ Release Notes .. release-notes:: :earliest-version: 0.12.0 +.. _Release Notes_0.12.0: + +0.12.0 +====== + +.. _Release Notes_0.12.0_New Features: + +Prelude +------- + +.. releasenotes/notes/add-benchmark-suffix-c3ab8c14c89edb33.yaml @ b'08dcd543ef9082c3dcf2d643a73585b18cacc829' + +Qiskit Experiments 0.12 introduces a new option for labeling results of layer fidelity experiments. Additionally, it addresses an incompatibility with :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` version 0.41 that prevents experiments from running. + + +New Features +------------ + +.. releasenotes/notes/add-benchmark-suffix-c3ab8c14c89edb33.yaml @ b'08dcd543ef9082c3dcf2d643a73585b18cacc829' + +- A new ``benchmark_suffix`` argument for the :class:`~.LayerFidelity` + and :class:`~.LayerFidelityUnitary` classes has been added which enables + users to append a descriptive suffix to the names of the analysis results in + these experiments, which makes bookkeeping for different types of gates easier. + + +.. _Release Notes_0.12.0_Upgrade Notes: + +Upgrade Notes +------------- + +.. releasenotes/notes/fix_hgp_bug-e131e03f71459029.yaml @ b'f321b6c5749ef0ebfb66dd762c9a8dc09360c5f6' + +- The automatic retrieval of hub, group, and project information from a + backend for storage in an :class:`~.ExperimentData` instance has been + removed as these properties are no longer a part of the access model in + the new IBM Quantum Platform on IBM Cloud. The new model has instances with + "plans" and "names" but these do not map directly to the hub, group, and + project information. Currently, no attempt is made to capture this + information in an equivalent way. + + +.. _Release Notes_0.12.0_Bug Fixes: + +Bug Fixes +--------- + +.. releasenotes/notes/fix_hgp_bug-e131e03f71459029.yaml @ b'f321b6c5749ef0ebfb66dd762c9a8dc09360c5f6' + +- As described in the Upgrade Notes, automatic retrieval of hub, group, and + project information is no longer attempted when the backend is set on an + :class:`~.ExperimentData` instance. Avoiding this retrieval avoids an + exception being raised when working with + :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` version 0.41 + which changed the behavior of the interface that had been used for + accessing the hub, group, and project information. + +.. releasenotes/notes/from-config-dict-6629c37d2572cfbc.yaml @ b'5eb4b5bc8b71eb271ebf19023d948fa0943ed7ec' + +- A bug that prevented passing a ``dict`` to + :meth:`.BaseExperiment.from_config` from working has been fixed (`#1577 + `__). + + .. _Release Notes_0.11.0: 0.11.0 diff --git a/releasenotes/notes/add-benchmark-suffix-c3ab8c14c89edb33.yaml b/releasenotes/notes/add-benchmark-suffix-c3ab8c14c89edb33.yaml deleted file mode 100644 index 38729f9c09..0000000000 --- a/releasenotes/notes/add-benchmark-suffix-c3ab8c14c89edb33.yaml +++ /dev/null @@ -1,12 +0,0 @@ ---- -prelude: > - Qiskit Experiments 0.12 introduces a new option for labeling results of - layer fidelity experiments. Additionally, it addresses an incompatibility - with :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` version - 0.41 that prevents experiments from running. -features: - - | - A new ``benchmark_suffix`` argument for the :class:`~.LayerFidelity` - and :class:`~.LayerFidelityUnitary` classes has been added which enables - users to append a descriptive suffix to the names of the analysis results in - these experiments, which makes bookkeeping for different types of gates easier. diff --git a/releasenotes/notes/average-pub-params-f24fd73f817051ac.yaml b/releasenotes/notes/average-pub-params-f24fd73f817051ac.yaml index b2ff896d2b..b4dbba2d20 100644 --- a/releasenotes/notes/average-pub-params-f24fd73f817051ac.yaml +++ b/releasenotes/notes/average-pub-params-f24fd73f817051ac.yaml @@ -3,4 +3,8 @@ features: - | Enable averaging PUB parameters in :class:`~.ExperimentData` when - the circuit metadata contain "average_params". + the circuit metadata contain "average_params". This feature is undocumented + for now since it is niche. It requires the user to submit parameterized + circuits to a sampler outside of an experiment and then add the results to + an :class:`.ExperimentData` object since Qiskit Experiments does not + currently support running parameterized PUBs directly. diff --git a/releasenotes/notes/fix_hgp_bug-e131e03f71459029.yaml b/releasenotes/notes/fix_hgp_bug-e131e03f71459029.yaml deleted file mode 100644 index b3cf2ee61c..0000000000 --- a/releasenotes/notes/fix_hgp_bug-e131e03f71459029.yaml +++ /dev/null @@ -1,21 +0,0 @@ ---- - -upgrade: - - | - The automatic retrieval of hub, group, and project information from a - backend for storage in an :class:`~.ExperimentData` instance has been - removed as these properties are no longer a part of the access model in - the new IBM Quantum Platform on IBM Cloud. The new model has instances with - "plans" and "names" but these do not map directly to the hub, group, and - project information. Currently, no attempt is made to capture this - information in an equivalent way. - -fixes: - - | - As described in the Upgrade Notes, automatic retrieval of hub, group, and - project information is no longer attempted when the backend is set on an - :class:`~.ExperimentData` instance. Avoiding this retrieval avoids an - exception being raised when working with - :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` version 0.41 - which changed the behavior of the interface that had been used for - accessing the hub, group, and project information. diff --git a/releasenotes/notes/from-config-dict-6629c37d2572cfbc.yaml b/releasenotes/notes/from-config-dict-6629c37d2572cfbc.yaml deleted file mode 100644 index 3ff95b2858..0000000000 --- a/releasenotes/notes/from-config-dict-6629c37d2572cfbc.yaml +++ /dev/null @@ -1,6 +0,0 @@ ---- -fixes: - - | - A bug that prevented passing a ``dict`` to - :meth:`.BaseExperiment.from_config` from working has been fixed (`#1577 - `__). diff --git a/releasenotes/notes/prepare-0.13.0-167e9b7befc25c7f.yaml b/releasenotes/notes/prepare-0.13.0-167e9b7befc25c7f.yaml new file mode 100644 index 0000000000..d0cb7f5768 --- /dev/null +++ b/releasenotes/notes/prepare-0.13.0-167e9b7befc25c7f.yaml @@ -0,0 +1,3 @@ +--- +prelude: > + Qiskit Experiments 0.13.0 is a small update with a fix for long randomized benchmarking sequences and a new niche feature for averaging parameterized PUBs.