-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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.0.0 release #11760
Prepare 1.0.0 release #11760
Conversation
One or more of the the following people are requested to review this:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've taken a look and left some suggestions, hopefully they make sense. I still need to take a look at the release highlights section and last paragraph.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Part 2
* The :class:`.QuantumCircuit` class's internal :attr:`~.QuantumCircuit.data` | ||
structure has been rewritten in Rust to greatly improve the memory efficiency | ||
of the :class:`.QuantumCircuit` objects by caching the arguments of the | ||
instructions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe link to the rust docs or project repo too?
* The :class:`.QuantumCircuit` class's internal :attr:`~.QuantumCircuit.data` | |
structure has been rewritten in Rust to greatly improve the memory efficiency | |
of the :class:`.QuantumCircuit` objects by caching the arguments of the | |
instructions. | |
* The :class:`.QuantumCircuit` class' internal :attr:`~.QuantumCircuit.data` | |
structure has been rewritten in Rust to greatly improve the memory efficiency | |
of the :class:`.QuantumCircuit` objects by caching the arguments of the | |
instructions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So I think the apostrophe usage here is actually correct as class
isn't plural.
As for the rust docs we don't actually publish any documentation about the rust code in Qiskit as it's all explicitly internal. Or did you mean link to the rust language documentation (like: https://doc.rust-lang.org/book/)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There seems to be more than one convention on this, and sometimes non-plurals get s instead of '. Even so, none of the conventions I found favor class' over class's.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, I wonder whether we should include one "flashy" sentence along the lines of: Only the new major version (Qiskit 1.x series) will continue to receive performance improvements such as highlighted in (LINK) and new functionality that increases the productivity in working with quantum computers
release relate to the stability policy, release cycles, and versioning. | ||
Qiskit is now formally using `semantic versioning <https://semver.org/>`__ , | ||
and this means that, for the entire lifecycle of the 1.x release series, the project | ||
is commited to maintaining backwards compatibility. We're also now starting |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think one more sentence about backwards compatibility would be nice here: do we commit to only reading the output (e.g. quantum circuits) written by earlier Qiskit versions or do we commit to some API, i.e. guarantee that user code will run correctly for the entire lifecycle of a major release?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll come up with something. I was trying to avoid rehashing the entire contents of the documentation on this topic (which is what I ended up doing in my initial draft), but I definitely can see the value in explaining a bit more about what backwards compatibility means here.
7c8e73a
to
e011174
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would remove the This page contains the release notes for Qiskit, starting from Qiskit 0.45, the first time that Qiskit and Qiskit Terra had the same versions.
in docs/release_notes.rst:7
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've only read over the prelude of the release - I think we've already got enough people looking through everything else as well.
I agree with the top-level features that have been highlighted, and I couldn't think of anything else I'd want to promote up to those top-level bullets either.
This commit prepares the repo for the 1.0.0 release. It migrates all the release notes to a dedicated directory to differentiate those notes from future notes (this will need to be forward ported to the main branch), updates the version numbers to indicate it is the final 1.0.0 release, and updates the release notes to prepare them for publishing. Once this merges this commit should be used to tag the 1.0.0 release.
Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>
Co-authored-by: Sebastian Brandhofer <148463728+sbrandhsn@users.noreply.github.com>
* InverseModifier * add-commutation-library * Update add-commutation-library-88b7ff65b3d35f9a.yaml --------- Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
* InverseModifier * add-commutation-library * Update add-commutation-library-88b7ff65b3d35f9a.yaml * add-commutation-library * . * . * . * . * Use iso8601 for dates --------- Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
Co-authored-by: Luciano Bello <bel@zurich.ibm.com>
Co-authored-by: Jake Lishman <jake@binhbar.com>
Co-authored-by: Sebastian Brandhofer <148463728+sbrandhsn@users.noreply.github.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
ec1d934
to
674ed7d
Compare
releasenotes/notes/1.0/deprecate_aquire_alignment-28f64480ed838328.yaml
Outdated
Show resolved
Hide resolved
releasenotes/notes/1.0/deprecate_aquire_alignment-28f64480ed838328.yaml
Outdated
Show resolved
Hide resolved
releasenotes/notes/1.0/fix-v2-conversion-with-defective-backend-6d9cebe55b06b797.yaml
Outdated
Show resolved
Hide resolved
releasenotes/notes/1.0/remove-deprecated-visualization-pulse-8adf40ff1a69df63.yaml
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, assuming this passes the docs build, I think this is it for Qiskit 1.0.0.
Summary
This commit prepares the repo for the 1.0.0 release. It migrates all the release notes to a dedicated directory to differentiate those notes from future notes (this will need to be forward ported to the main branch), updates the version numbers to indicate it is the final 1.0.0 release, and updates the release notes to prepare them for publishing. Once this merges this commit should be used to tag the 1.0.0 release.
Details and comments
TODO: