Skip to content

Commit

Permalink
Beef up release note to cover the patch release
Browse files Browse the repository at this point in the history
  • Loading branch information
caleb-johnson committed Sep 13, 2024
1 parent 0b76fd5 commit cc0978a
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions releasenotes/notes/subsample-hamming-76674dbaf6f411c2.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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(
Expand Down

0 comments on commit cc0978a

Please sign in to comment.