Repository navigation
Update the HI-VQE Chemistry docs for the 4.0.0 function - #5758
Merged
Merged
Conversation
In 4.0.0 the result no longer carries "states" or "eigenvector". They are written to an HDF5 results file instead, alongside "final_energy", "final_energy_variance" and "energy_history". The result names that file in "results_file_name". - API reference: drop "states" and "eigenvector" from the result table, add "results_file_name", and point "energy_variance" at the states in the results file. - Guide: show the 4.0.0 result, list what the results file holds, and add examples that create a QiskitServerless client, download the file and read it with h5py. Add a Changelog section that starts at 4.0.0. - Tutorial: install h5py, and download and read the results file for each calculation. Co-authored-by: Shane McFarthing <shane.mcfarthing@gmail.com> Co-authored-by: Rowan Pellow-Jarman <rowanpellow@gmail.com> Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The guide downloaded the results file with serverless.file_download(results_file_name, function) and then opened results_file_name. That fails with FileNotFoundError: without target_name, qiskit-serverless saves the file as downloaded_<8 hex>_<name> (qiskit_serverless/core/files.py, 0.36.0). The comment above the call, "saved ... under the same name", was wrong for the same reason. Pass target_name=results_file_name so the file lands under the name the next line opens, and make the comment say what the call does. The tutorial still asks for the path by hand and is left alone for now. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The licensed-use example passed backend_name="ibm_torino". Current qiskit-ibm-catalog checks backend access before it submits a job, so on an instance without ibm_torino the example stops with "Backend 'ibm_torino' is not available or you do not have access to it". It now passes backend_name, as the rest of the guide does, with a comment giving the 14 qubits that H2O in STO-3G needs (7 orbitals). The example also built its catalog from token and instance placeholders, unlike "Get started", which uses the saved account. It now does the same: QiskitFunctionsCatalog(channel="ibm_quantum_platform"). Checked against production 4.0.0 from a test instance. With a placeholder licence token, the job reaches the function and is refused with TokenNotFoundError (1201), as expected. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
|
Contributor
|
Thanks for contributing to Qiskit documentation! Before your PR can be merged, it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. Thanks! 🙌 One or more of the following people are relevant to this code:
|
Seihyun Jeong (seihyun-jeong)
added a commit
to QuNovaComputing/qiskit-documentation
that referenced
this pull request
Oct 7, 2026
Step 3 listed five checks. IBM's Lint job runs more, including check:fmt, check:orphan-pages, check:stale-images and the page and KaTeX render checks. All of them passed on hivqe-4.0.0 before CI was approved on Qiskit#5758. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Junye Huang (HuangJunye)
approved these changes
Oct 22, 2026
Junye Huang (HuangJunye)
left a comment
Junye Huang (HuangJunye)
left a comment
Contributor
There was a problem hiding this comment.
Looks good to me. Thanks for updating the documentation.
Contributor
|
@Qiskit/docs-content-team Can you please review and approve the PR? |
Sanket Panda (pandasa123)
approved these changes
Oct 22, 2026
abbycross
reviewed
Oct 26, 2026
abbycross
reviewed
Oct 26, 2026
abbycross
reviewed
Oct 26, 2026
abbycross
pushed a commit
to abbycross/qiskit-documentation
that referenced
this pull request
Oct 26, 2026
- Step 7: what happens after the IBM PR is opened. A first-time author's CI waits for a maintainer to approve it, so Lint and Execute notebooks sit at "Expected — Waiting for status to be reported". Says whom to ask and what each check should do. - Step 8: when syncing our main with IBM's, choose Update branch, never Discard commits. Our main now carries fork-only commits that IBM does not have. Discarding was fine once, when every extra commit was already upstream under another hash. - Step 2: run any notebook cell whose code you change against the deployed function. Both bugs fixed today read correctly and failed at run time, and nothing else executes these notebooks. - Status: 4.0.0 is at Qiskit#5758 after Qedma#6 was approved, with the two fixes from Qedma#8 and Qedma#9. 5.0.x should wait for a function release that returns 4630. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Collaborator
|
Hi Seihyun Jeong (@seihyun-jeong) and thanks for your updates. I made some edits that I could not write directly to your branch, and so I opened a fork. Please approve and merge them here. Thanks! |
Contributor
Author
|
abbycross Hello abbycross, I approved and merged the fork. Please check and proceed with the next steps. |
Collaborator
|
Thank you Seihyun Jeong (@seihyun-jeong)! To fix the lint check, can you please update your branch by pulling from main? I think that should clear it. |
abbycross
approved these changes
Oct 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In 4.0.0 of
qunova/hivqe-chemistry, the result no longer includes"states"or"eigenvector". They are saved in an HDF5 results file, together with"final_energy","final_energy_variance"and"energy_history", and the result names that file in"results_file_name".QiskitServerlessand read it withh5py. Run the licensing example on the reader's own backend, and add a Changelog section.h5py, and download and read the results file for each calculation.Checked by running the guide against the deployed 4.0.0 function.