Skip to content

Add release note for nalgebra 2q synthesis changes#16129

Merged
Cryoris merged 6 commits into
Qiskit:mainfrom
mtreinish:add-performance-release-note
May 27, 2026
Merged

Add release note for nalgebra 2q synthesis changes#16129
Cryoris merged 6 commits into
Qiskit:mainfrom
mtreinish:add-performance-release-note

Conversation

@mtreinish

Copy link
Copy Markdown
Member

In the recently merged #16065 we added a new release note section to highlight performance changes that weren't additions. Since that has merged for the 2.5 release the PR series migrating our internal 2q synthesis code to use nalgebra should be documented under this section for the 2.5.0 release notes. Since those PRs (#15960 and #15928) merged before #16065 did there was no release note documenting this change. This commit corrects that oversight and adds the release note so we're documenting this improvement in the performance section.

AI/LLM disclosure

  • I didn't use LLM tooling, or only used it privately.
  • I used the following tool to help write this PR description:
  • I used the following tool to generate or modify code:

In the recently merged Qiskit#16065 we added a new release note section to
highlight performance changes that weren't additions. Since that has
merged for the 2.5 release the PR series migrating our internal 2q
synthesis code to use nalgebra should be documented under this section
for the 2.5.0 release notes. Since those PRs (Qiskit#15960 and Qiskit#15928) merged
before Qiskit#16065 did there was no release note documenting this change.
This commit corrects that oversight and adds the release note so we're
documenting this improvement in the performance section.
@mtreinish mtreinish added this to the 2.5.0 milestone May 4, 2026
@mtreinish mtreinish added documentation Something is not clear or an error documentation Changelog: None Do not include in the GitHub Release changelog. labels May 4, 2026
@github-project-automation github-project-automation Bot moved this to Ready in Qiskit 2.5 May 4, 2026
@qiskit-bot

Copy link
Copy Markdown
Collaborator

One or more of the following people are relevant to this code:

  • @Qiskit/terra-core

@ShellyGarion ShellyGarion self-requested a review May 4, 2026 13:25
@coveralls

coveralls commented May 4, 2026

Copy link
Copy Markdown

Coverage Report for CI Build 26493870714

Coverage decreased (-0.003%) to 87.602%

Details

  • Coverage decreased (-0.003%) from the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • 19 coverage regressions across 4 files.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

19 previously-covered lines in 4 files lost coverage.

File Lines Losing Coverage Coverage
crates/qasm2/src/parse.rs 12 97.15%
crates/circuit/src/parameter/symbol_expr.rs 4 74.09%
crates/qasm2/src/lex.rs 2 92.03%
crates/circuit/src/parameter/parameter_expression.rs 1 91.04%

Coverage Stats

Coverage Status
Relevant Lines: 123981
Covered Lines: 108610
Line Coverage: 87.6%
Coverage Strength: 960746.53 hits per line

💛 - Coveralls

@ShellyGarion ShellyGarion left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding the performance release notes!

  1. Do you think it's worth also adding PR #15871?

  2. In PR #16024, you've added features_misc saying that "This improves the runtime performance of Qiskit and also should reduce the resident set size when running Qiskit."
    whould you like to change it to "performance" ?

Comment thread releasenotes/notes/2q_decomposer_nalgebra-reno-9e5074c7673e9c4d.yaml Outdated
Comment thread releasenotes/notes/2q_decomposer_nalgebra-reno-9e5074c7673e9c4d.yaml Outdated
Co-authored-by: Shelly Garion <46566946+ShellyGarion@users.noreply.github.com>
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
@mtreinish

Copy link
Copy Markdown
Member Author

Do you think it's worth also adding PR #15871?

I didn't since it wasn't really about performance on it's own. It was in service of the note I added here. On it's own changing the internal return type doesn't do much because it would just use an ndarray for the synthesis. But when combined with the later PRs we get the performance improvement by doing all the matrix storage with nalgebra

In PR #16024, you've added features_misc saying that "This improves the runtime performance of Qiskit and also should reduce the resident set size when running Qiskit."
whould you like to change it to "performance" ?

I think it probably should be a performance release note. But it's kind of independent from this release note PR (which is adding the missing one for the nalgebra migration). I think that it's something we can do in the release note roundup when we prepare the final 2.5.0 release.

@ShellyGarion ShellyGarion left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor fix and it's ready to go :)

I think it probably should be a performance release note. But it's kind of independent from this release note PR (which is adding the missing one for the nalgebra migration). I think that it's something we can do in the release note roundup when we prepare the final 2.5.0 release.

I'll try to remind the release manager of Qiskit 2.5 about this when preparing the release PR :)

Comment thread releasenotes/notes/2q_decomposer_nalgebra-reno-9e5074c7673e9c4d.yaml Outdated
mtreinish and others added 2 commits May 26, 2026 16:14
…d.yaml

Co-authored-by: Shelly Garion <46566946+ShellyGarion@users.noreply.github.com>
Comment thread releasenotes/notes/2q_decomposer_nalgebra-reno-9e5074c7673e9c4d.yaml Outdated
@Cryoris Cryoris enabled auto-merge May 27, 2026 06:03
@Cryoris Cryoris added this pull request to the merge queue May 27, 2026
Merged via the queue into Qiskit:main with commit 8b1b6a8 May 27, 2026
47 of 49 checks passed
@github-project-automation github-project-automation Bot moved this from Ready to Done in Qiskit 2.5 May 27, 2026
@ShellyGarion

Copy link
Copy Markdown
Member

I think it probably should be a performance release note. But it's kind of independent from this release note PR (which is adding the missing one for the nalgebra migration). I think that it's something we can do in the release note roundup when we prepare the final 2.5.0 release.

done as part of #16454

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Changelog: None Do not include in the GitHub Release changelog. documentation Something is not clear or an error documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants