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

Update metadata of Primitives V2 (backport #12784) #12857

Merged
merged 1 commit into from
Jul 30, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Jul 30, 2024

Summary

This PR updates the metadata of Primitives V2 to be compatible with that of real devices.

  • Added "version" and "circuit_metadata" to all classes
  • StatevectorEstimator
    • Replace precision -> target_precision
  • BackendEstimatorV2
    • Added shots
  • BackendSamplerV2
    • Added shots

If I need to keep the compatibility of the metadata within Qiskit 1.*, I will revert the rename and removal.

I'm wondering StatevectorEstimator because it does not compute expectation values directly from the state vector not based on shots. So, there is not relevant information about shots and I did not add shots to StatevectorEstimator yet. If necessary, I can add something like shots=inf, for example.

Addresses Qiskit/qiskit-ibm-runtime#1724

Summary of discussion:

  1. Update all metadata to match that of IBM devices.
    1-a. Shall we add shots=inf to StatevectorEstimator or not add shots?
  2. Do not remove any existing metadata, i.e., precision of StatevectorEstimator and shots of StatevectorSampler.

TODO

  • discussion
  • reno

Details and comments

SamplerV2 of qiskit-ibm-runtime returns the following metadata

result.metadata = {'version': 2}
result[i].metadata = {'circuit_metadata': {}}

EstimatorV2 of qiskit-ibm-runtime returns the following metadata

result.metadata = {'dynamical_decoupling': {'enable': False, 'sequence_type': 'XX', 'extra_slack_distribution': 'middle', 'scheduling_method': 'alap'}, 'twirling': {'enable_gates': False, 'enable_measure': True, 'num_randomizations': 'auto', 'shots_per_randomization': 'auto', 'interleave_randomizations': True, 'strategy': 'active-accum'}, 'resilience': {'measure_mitigation': True, 'zne_mitigation': False, 'pec_mitigation': False}, 'version': 2}
result[i].metadata = {'shots': 128, 'target_precision': 0.1, 'circuit_metadata': {}, 'resilience': {}, 'num_randomizations': 2}

This is an automatic backport of pull request #12784 done by [Mergify](https://mergify.com).

* update metadata of primitives v2

* remove `shots` and add reno

* add version

* add shots to SamplerV2 metadata

* udpate reno

---------

Co-authored-by: Elena Peña Tapia <[email protected]>
(cherry picked from commit 68687d3)
@mergify mergify bot requested review from a team as code owners July 30, 2024 18:07
@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
  • @ajavadia
  • @levbishop
  • @t-imamichi

@github-actions github-actions bot added Changelog: API Change Include in the "Changed" section of the changelog mod: primitives Related to the Primitives module labels Jul 30, 2024
@github-actions github-actions bot added this to the 1.2.0 milestone Jul 30, 2024
@coveralls
Copy link

Pull Request Test Coverage Report for Build 10167490233

Details

  • 8 of 8 (100.0%) changed or added relevant lines in 4 files are covered.
  • 11 unchanged lines in 2 files lost coverage.
  • Overall coverage decreased (-0.008%) to 89.976%

Files with Coverage Reduction New Missed Lines %
crates/qasm2/src/lex.rs 5 92.23%
crates/qasm2/src/parse.rs 6 97.61%
Totals Coverage Status
Change from base Build 10167409225: -0.008%
Covered Lines: 66366
Relevant Lines: 73760

💛 - Coveralls

@ElePT ElePT added this pull request to the merge queue Jul 30, 2024
Merged via the queue into stable/1.2 with commit e28aec4 Jul 30, 2024
18 checks passed
@mergify mergify bot deleted the mergify/bp/stable/1.2/pr-12784 branch July 30, 2024 20:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changelog: API Change Include in the "Changed" section of the changelog mod: primitives Related to the Primitives module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants