Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare 1.3.0 release #13447

Open
wants to merge 5 commits into
base: stable/1.3
Choose a base branch
from
Open

Conversation

raynelfss
Copy link
Contributor

  • Move loose release notes.

Summary

The following commits set the version number on stable/1.3 to 1.3.0 in preparation for the 1.3.0 final release.

Details and comments

The following commits will:

  • Set the version number to 1.3.0.
  • Consolidate any loose release notes into the releasenotes/notes/1.3/ folder.
  • Update the cargo dependencies.
  • Fix any typos, broken links, and bad references in the folder releasenotes/notes/1.3/.
  • Include a prelude release note for the release.

@raynelfss raynelfss added on hold Can not fix yet Changelog: None Do not include in changelog labels Nov 15, 2024
@raynelfss raynelfss added this to the 1.3.0 milestone Nov 15, 2024
@raynelfss raynelfss requested a review from a team as a code owner November 15, 2024 20:11
@qiskit-bot
Copy link
Collaborator

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

Copy link
Collaborator

@beckykd beckykd left a comment

Choose a reason for hiding this comment

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

Lots of good stuff! let me know if you have any questions!

Copy link
Collaborator

Choose a reason for hiding this comment

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

For some reason, I can't add comments until line 23 of this file. Here are some comments on the earlier lines:

I don't understand this whole thing:
"When using QPY formats 10, 11, or 12 there is a dependency on the version
of symengine installed in the payload for serialized
:class:.ParamerExpression if there is mismatched version of the installed
symengine package between the environment that generated the payload with
:func:.qpy.dump and the installed version that is trying to load the payload
with :func:.qpy.load."

Would one of these rewrites work?

When using QPY formats 10, 11, or 12, if the version of the symengine package installed in the environment that generated the payload by using :func:.qpy.dump does not match the version of the symengine package that is trying to use :func:.qpy.load to load the payload, you will get an error. If you encounter this error, install the symengine package version from the error message to load the payload.

Or more simply:

When using QPY formats 10, 11, or 12, if the version of the symengine package installed in the environment that generated the payload does not match the version of the symengine package that is trying to load the payload, you will get an error. (I'm not sure we need to tell them how to fix that error, but maybe.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe the original is a valid explanation, although a bit too technical so it can lead to confusion. Option 1 is a good rewrite in my opinion.

Copy link
Contributor

Choose a reason for hiding this comment

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

We could re-add the point about parameter expressions, because that's what essentially causes the issue. What about:

When using QPY formats 10, 11, or 12 with circuits that contain :class:.ParamerExpressions, if the version of the symengine package installed in the environment that generated the payload (:func:.qpy.dump) does not match the version of symengine installed in the enviroment where the payload is loaded (:func:.qpy.load), you will get an error. If you encounter this error, install the symengine package version from the error message before calling :func:.qpy.load.

Copy link
Collaborator

Choose a reason for hiding this comment

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

"QPY format version >= 13 (or < 10) will not have this issue and it is recommended
if you're serializing :class:.ParameterExpression objects as part of your
circuit or any :class:.ScheduleBlock objects you use version 13 to avoid
this issue in the future."

Suggestion:
"QPY format versions 13 or later (or prior to 10) will not have this issue. Therefore, if you're serializing :class:.ParameterExpression objects as part of your
circuit or any :class:.ScheduleBlock objects, it is recommended that you use version 13 to avoid
this issue in the future.

Copy link
Collaborator

Choose a reason for hiding this comment

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

"The :func:.qpy.dump function will now emit format version 13 by default." -> "The :func:.qpy.dump function now emits format version 13 by default.

@@ -1,7 +1,7 @@
---
features_transpiler:
- |
Add an argument ``matrix_based`` to the :class:`.CollectCliffords()` transpiler pass.
Add argument ``matrix_based`` to the :class:`.CollectCliffords()` transpiler pass.
Copy link
Contributor

Choose a reason for hiding this comment

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

Just a comment for consistency: I think we mostly write in past-tense, right? I.e. Fixed something or Added something in case you'd like to change this 🙂

@@ -17,7 +17,7 @@ features_transpiler:
* :class:`.MCXSynthesisNoAuxV24`, based on :func:`.synth_mcx_noaux_v24`.
* :class:`.MCXSynthesisGrayCode`, based on :func:`.synth_mcx_gray_code`.
As well:
As well as:
* :class:`.MCXSynthesisDefault`, choosing the most efficient synthesis
method based on the number of clean and dirty ancilla qubits available.
Copy link
Contributor

Choose a reason for hiding this comment

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

I can't comment there but on the line below there's a typo:

"As an example, consider how the transpilation of the following circuit"

Copy link
Contributor

Choose a reason for hiding this comment

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

AdderGate should be HalfAdderGate -- we changed this naming in the PR and apparently forgot the reno 🙈 (there's two occurrences of this here)

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 changelog on hold Can not fix yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants