Skip to content

Added circuit start table to the QPY file header #14571

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 23 commits into from
Jun 24, 2025
Merged

Added circuit start table to the QPY file header #14571

merged 23 commits into from
Jun 24, 2025
+70 −3

Conversation

velocityraptor7085
Copy link
Contributor

@velocityraptor7085 velocityraptor7085 commented Jun 11, 2025 •
edited
Loading

Summary

Details and comments

The approach used includes the following changes:

  • Defining a CIRCUIT_TABLE_ENTRY_PACK and CIRCUIT_TABLE_ENTRY_SIZE to represent an uint64_t (in the formats.py file).
  • Bumping the QPY_VERSION to 16 (in common.py).
  • Modifying the dump function to do the following (if the version is >= 16):
    1. Skip past number_of_circuits * CIRCUIT_TABLE_ENTRY_SIZE bytes initially.
    2. Append the byte_offsets for each circuit before serializing them (via binary_io.write_circuit()).
    3. Seek back and write the byte_offsets for each circuit after serializing every circuit.
  • Modifying the load function to do the following (if the version is >= 16):
    1. Obtain the program_offsets after reading the header.
    2. Seek to the start of each circuit in a sequential manner (this would happen in a multithreaded manner in the future) and deserialize them (via binary_io.read_circuit()).

@velocityraptor7085 velocityraptor7085 requested a review from a team as a code owner June 11, 2025 06:53
@qiskit-bot qiskit-bot added the Community PR PRs from contributors that are not 'members' of the Qiskit repo label Jun 11, 2025
@qiskit-bot
Copy link
Collaborator

Thank you for opening a new pull request.

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.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

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

  • @Qiskit/terra-core
  • @mtreinish
  • @nkanazawa1989

@coveralls
Copy link

coveralls commented Jun 11, 2025 •
edited
Loading

Pull Request Test Coverage Report for Build 15735763409

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 23 of 23 (100.0%) changed or added relevant lines in 3 files are covered.
  • 957 unchanged lines in 25 files lost coverage.
  • Overall coverage increased (+0.02%) to 88.009%
Files with Coverage Reduction New Missed Lines %
crates/qasm2/src/expr.rs 1 94.23%
qiskit/circuit/_classical_resource_map.py 1 75.0%
crates/transpiler/src/passes/elide_permutations.rs 2 96.88%
qiskit/circuit/annotation.py 2 95.56%
qiskit/circuit/library/pauli_evolution.py 2 96.88%
qiskit/circuit/library/quantum_volume.py 2 95.74%
qiskit/circuit/library/phase_oracle.py 4 86.67%
crates/circuit/src/lib.rs 6 95.0%
qiskit/circuit/library/arithmetic/linear_amplitude_function.py 6 92.45%
qiskit/providers/backend.py 6 91.43%
Totals Coverage Status
Change from base Build 15535109536: 0.02%
Covered Lines: 83688
Relevant Lines: 95090
💛 - Coveralls

kevinhartman
kevinhartman reviewed Jun 11, 2025
View reviewed changes
Copy link
Contributor

@kevinhartman kevinhartman left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for doing this work!

Can you also update the format description in qiskit/qpy/__init__.py?

@velocityraptor7085
Copy link
Contributor Author

Thank you @kevinhartman for the suggestions.
Please let me know if the changes are good to go.

kevinhartman
kevinhartman reviewed Jun 12, 2025
View reviewed changes
Copy link
Contributor

@kevinhartman kevinhartman left a comment

Choose a reason for hiding this comment

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

Looks good, just a few more small comments.

velocityraptor7085 and others added 4 commits June 13, 2025 11:03
@velocityraptor7085
Updated __init__.py
3dfb4ad
@velocityraptor7085 @kevinhartman
Use formats for writing the offsets.
45dd856 
Co-authored-by: Kevin Hartman <kevin@hart.mn>
@velocityraptor7085 @kevinhartman
Update __init__.py
6c80065 
Co-authored-by: Kevin Hartman <kevin@hart.mn>
@velocityraptor7085
Fixed linting
16e80b4
@velocityraptor7085
Copy link
Contributor Author

Thanks a lot @kevinhartman. Please let me know if any other changes are required from my end 🙂.

kevinhartman
kevinhartman reviewed Jun 16, 2025
View reviewed changes
Copy link
Contributor

@kevinhartman kevinhartman left a comment

Choose a reason for hiding this comment

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

Just a few minor suggestions/tweaks.

velocityraptor7085 and others added 3 commits June 17, 2025 08:35
@velocityraptor7085 @kevinhartman
Updated __init__.py to explicitly describe older formats.
92d02f9 
Co-authored-by: Kevin Hartman <kevin@hart.mn>
@velocityraptor7085 @kevinhartman
Removed redundant description from __init__.py
a80e1f9 
Co-authored-by: Kevin Hartman <kevin@hart.mn>
@velocityraptor7085 @kevinhartman
Update __init__.py to capitalize "Rust"
c737721 
Co-authored-by: Kevin Hartman <kevin@hart.mn>
@velocityraptor7085
Copy link
Contributor Author

Thank you so much @kevinhartman for all of your suggestions.

@raynelfss raynelfss added Intern PR PR submitted by IBM Quantum interns and removed Community PR PRs from contributors that are not 'members' of the Qiskit repo labels Jun 17, 2025
kevinhartman
kevinhartman reviewed Jun 18, 2025
View reviewed changes
kevinhartman
kevinhartman approved these changes Jun 24, 2025
View reviewed changes
Copy link
Contributor

@kevinhartman kevinhartman left a comment

Choose a reason for hiding this comment

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

This looks good to me.

Thanks for working on this and for the updates, @velocityraptor7085!

@kevinhartman kevinhartman added this pull request to the merge queue Jun 24, 2025
Merged via the queue into Qiskit:main with commit f59779d Jun 24, 2025
26 checks passed
@1ucian0 1ucian0 added the Changelog: New Feature Include in the "Added" section of the changelog label Jul 7, 2025
@jakelishman jakelishman mentioned this pull request Jul 21, 2025
Open
@jakelishman jakelishman added this to the 2.2.0 milestone Jul 21, 2025
@kevinhartman kevinhartman mentioned this pull request Aug 26, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kevinhartman kevinhartman kevinhartman approved these changes

Assignees
No one assigned
Labels
Changelog: New Feature Include in the "Added" section of the changelog Intern PR PR submitted by IBM Quantum interns
Projects
Contributor Monitoring
Status: Done
Milestone
2.2.0
Development

Successfully merging this pull request may close these issues.

Add circuit start table to QPY file header
7 participants
@velocityraptor7085 @qiskit-bot @coveralls @kevinhartman @1ucian0 @jakelishman @raynelfss