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

Add "Save and retrieve Qiskit objects" page #1099

Merged
merged 23 commits into from
Apr 10, 2024
Merged

Conversation

frankharkins
Copy link
Member

@frankharkins frankharkins commented Mar 27, 2024

Continuation of #956

Link to preview.

@qiskit-bot
Copy link
Contributor

One or more of the the following people are requested to review this:

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@frankharkins frankharkins changed the title Add "Saving circuits and retrieving jobs" page Add "Saving circuits and retrieving Qiskit objects" page Mar 27, 2024
@frankharkins frankharkins changed the title Add "Saving circuits and retrieving Qiskit objects" page Add "Saving and retrieving Qiskit objects" page Mar 27, 2024
@frankharkins frankharkins changed the title Add "Saving and retrieving Qiskit objects" page Add "Save and retrieve Qiskit objects" page Mar 27, 2024
Copy link
Collaborator

@abbycross abbycross left a comment

Choose a reason for hiding this comment

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

Reads very well!! Couple of tweaks in my suggestions, but approving overall.

Co-authored-by: abbycross <across@us.ibm.com>
@jyu00
Copy link
Collaborator

jyu00 commented Mar 28, 2024

It may be worth noting that QPY only provides backward compatibility but not forward. So it may not work if you are trying to use Qiskit version N-1 to load a payload dumped from version N.

@frankharkins
Copy link
Member Author

@jyu00 does this sentence describe it correctly?

QPY files save the full Qiskit circuit object and are forward-compatible, meaning they'll be compatible with newer versions of Qiskit.

@jyu00
Copy link
Collaborator

jyu00 commented Apr 3, 2024

@jyu00 does this sentence describe it correctly?

QPY files save the full Qiskit circuit object and are forward-compatible, meaning they'll be compatible with newer versions of Qiskit.

Yes, but the goal here is to warn users they cannot load a QPY file using a down level Qiskit. So I think the sentence would better worded as QPY being backward compatible but not forward compatible (since it cannot predict the future).

Also Qiskit 1.0 added versions to QPY. So one can look up the version of a QPY file and compare that to the QPY versions support by their Qiskit. @mtreinish can give you more details if needed.

@frankharkins
Copy link
Member Author

frankharkins commented Apr 4, 2024

I think the confusion comes from the file type vs. the QPY program. Does this remove the ambiguity?

QPY files store the full Qiskit circuit object and will be compatible with newer versions of Qiskit (although not necessarily with older versions of Qiskit).

It removes mention of forward/backwards compatibility and makes it clearer that older versions of Qiskit might not understand the file.

EDIT: Approved by Jessie via Slack

@frankharkins frankharkins added this pull request to the merge queue Apr 10, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 10, 2024
@frankharkins frankharkins added this pull request to the merge queue Apr 10, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 10, 2024
@frankharkins frankharkins added this pull request to the merge queue Apr 10, 2024
Merged via the queue into main with commit c4c4a8c Apr 10, 2024
5 checks passed
@frankharkins frankharkins deleted the add/save-and-retrieve branch April 10, 2024 10:02
github-merge-queue bot pushed a commit that referenced this pull request Apr 18, 2024
PRs #977 and #1099 added some new pages in anticipation of a restructure
which has since been postponed. This PR fits those pages into our
current content structure.
frankharkins added a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
Continuation of Qiskit#956

[Link to
preview](https://qiskit-docs-preview-pr-1099.1799mxdls7qz.us-south.codeengine.appdomain.cloud/analyze/save-and-retrieve).

---------

Co-authored-by: nick bronn <ntbronn@us.ibm.com>
Co-authored-by: abbycross <across@us.ibm.com>
frankharkins added a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
PRs Qiskit#977 and Qiskit#1099 added some new pages in anticipation of a restructure
which has since been postponed. This PR fits those pages into our
current content structure.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[ NEW PAGE ] Retrieving and saving results [ NEW PAGE ] Serialising job results
5 participants