From cc0978af753c0dfcceaabacd0542dcc180c33c3a Mon Sep 17 00:00:00 2001 From: Caleb Johnson Date: Fri, 13 Sep 2024 11:55:30 -0500 Subject: [PATCH] Beef up release note to cover the patch release --- .../notes/subsample-hamming-76674dbaf6f411c2.yaml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/releasenotes/notes/subsample-hamming-76674dbaf6f411c2.yaml b/releasenotes/notes/subsample-hamming-76674dbaf6f411c2.yaml index 253e6c1..d192e81 100644 --- a/releasenotes/notes/subsample-hamming-76674dbaf6f411c2.yaml +++ b/releasenotes/notes/subsample-hamming-76674dbaf6f411c2.yaml @@ -1,6 +1,10 @@ --- +prelude: > + This is a patch release which introduces a couple of small, but important, breaking changes to to the API. These changes allow for a more consistent pattern in specifying the number of alpha and beta electrons throughout both the chemistry and non-chemistry functions in the API. + upgrade: - | + The :func:`qiskit_addon_sqd.subsampling.postselect_and_subsample` and :func:`qiskit_addon_sqd.configuration_recovery.post_select_by_hamming_weight` now take the ``hamming_right`` positional argument before the ``hamming_left`` argument to better match the rest of the workflow. To upgrade @@ -10,8 +14,8 @@ upgrade: from qiskit_addon_sqd.configuration_recovery import post_select_by_hamming_weight from qiskit_addon_sqd.subsampling import postselect_and_subsample - bs_mat = post_select_by_hamming_weight(bs_mat_full, num_elec_b, num_elec_a) - + bs_mat = post_select_by_hamming_weight(bs_mat_full, num_elec_b, num_elec_a) + ... batches = postselect_and_subsample(