Update metadata of Primitives V2 #12784

t-imamichi · 2024-07-18T11:35:00Z

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:

Update all metadata to match that of IBM devices.
1-a. Shall we add shots=inf to StatevectorEstimator or not add shots?
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}

qiskit-bot · 2024-07-18T11:35:05Z

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

@Qiskit/terra-core
@ajavadia
@levbishop
@t-imamichi

coveralls · 2024-07-18T11:59:14Z

Pull Request Test Coverage Report for Build 10164614695

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.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

8 of 8 (100.0%) changed or added relevant lines in 4 files are covered.
3 unchanged lines in 1 file lost coverage.
Overall coverage increased (+0.02%) to 89.77%

Files with Coverage Reduction	New Missed Lines	%
crates/qasm2/src/lex.rs	3	92.48%

Totals
Change from base Build 10164137701:	0.02%
Covered Lines:	66965
Relevant Lines:	74596

💛 - Coveralls

t-imamichi · 2024-07-29T08:25:05Z

qiskit/primitives/backend_estimator_v2.py

@@ -238,7 +238,6 @@ def _preprocess_pub(self, pub: EstimatorPub) -> _PreprocessedData:
        param_indices = np.fromiter(np.ndindex(param_shape), dtype=object).reshape(param_shape)
        bc_param_ind, bc_obs = np.broadcast_arrays(param_indices, observables)

-        # calculate expectation values for each pair of parameter value set and pauli


Removed a wrong and unnecessary comment

t-imamichi · 2024-07-29T08:59:12Z

FYI: neko is failing due to #12833

jyu00

1 small comment but not a blocker.

jyu00 · 2024-07-29T22:02:45Z

qiskit/primitives/backend_sampler_v2.py

@@ -213,7 +219,9 @@ def _postprocess_pub(
        meas = {
            item.creg_name: BitArray(arrays[item.creg_name], item.num_bits) for item in meas_info
        }
-        return SamplerPubResult(DataBin(**meas, shape=shape), metadata={})
+        return SamplerPubResult(
+            DataBin(**meas, shape=shape), metadata={"circuit_metadata": circuit_metadata}


Shouldn't this have shots too? Given EstimatorPubResult has target_precision. We should update the QRT Sampler to also return shots.

Thank you for reviewing this PR.

Qiskit Runtime Sampler V2 does not have shots in the metadata because it can be obtained by result[i].data.{creg}.num_shots. I removed shots from the metadata of StatevectorSampler in this PR because of the same reason.
On the other hand, Estimator V2 has shots in the metadata.

SamplerV2 of qiskit-ibm-runtime returns the following metadata with the default option.

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}

ElePT · 2024-07-30T12:35:45Z

Adding PR to the queue after approval and offline confirmation from @jyu00

ElePT

LGTM (also based on offline discussion with @t-imamichi and @jyu00)

* 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 <57907331+ElePT@users.noreply.github.com> (cherry picked from commit 68687d3)

* 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 <57907331+ElePT@users.noreply.github.com> (cherry picked from commit 68687d3) Co-authored-by: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.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 <57907331+ElePT@users.noreply.github.com>

t-imamichi added the mod: primitives Related to the Primitives module label Jul 18, 2024

t-imamichi requested review from a team as code owners July 18, 2024 11:35

t-imamichi added the Changelog: API Change Include in the "Changed" section of the changelog label Jul 18, 2024

ElePT added this to the 1.2.0 milestone Jul 18, 2024

t-imamichi requested a review from jyu00 July 26, 2024 08:45

t-imamichi added 2 commits July 29, 2024 16:37

update metadata of primitives v2

b6e77d3

remove shots and add reno

deee983

t-imamichi force-pushed the primitives-metadata branch from 989e4f6 to deee983 Compare July 29, 2024 08:24

t-imamichi commented Jul 29, 2024

View reviewed changes

add version

c3449f1

Merge branch 'main' into primitives-metadata

1e71a43

jyu00 previously approved these changes Jul 29, 2024

View reviewed changes

ElePT requested a review from jyu00 July 30, 2024 12:02

ElePT enabled auto-merge July 30, 2024 12:35

ElePT previously approved these changes Jul 30, 2024

View reviewed changes

ElePT added this pull request to the merge queue Jul 30, 2024

ElePT removed this pull request from the merge queue due to a manual request Jul 30, 2024

ElePT added the stable backport potential The bug might be minimal and/or import enough to be port to stable label Jul 30, 2024

add shots to SamplerV2 metadata

57e5ed4

t-imamichi dismissed stale reviews from ElePT and jyu00 via 099189b July 30, 2024 14:41

ElePT previously approved these changes Jul 30, 2024

View reviewed changes

ElePT enabled auto-merge July 30, 2024 14:47

udpate reno

f29a067

t-imamichi dismissed ElePT’s stale review via f29a067 July 30, 2024 14:47

t-imamichi force-pushed the primitives-metadata branch from 099189b to f29a067 Compare July 30, 2024 14:47

ElePT approved these changes Jul 30, 2024

View reviewed changes

ElePT added this pull request to the merge queue Jul 30, 2024

Merged via the queue into Qiskit:main with commit 68687d3 Jul 30, 2024
15 checks passed

mergify bot mentioned this pull request Jul 30, 2024

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

Merged

2 tasks

t-imamichi deleted the primitives-metadata branch July 31, 2024 01:35

This was referenced Aug 5, 2024

Update unit tests for Qiskit 1.2 Qiskit/qiskit-ibm-runtime#1840

Merged

Metadata handling of SamplerV2 with fake backend does not match behaviour with real backend Qiskit/qiskit-ibm-runtime#1724

Closed

t-imamichi mentioned this pull request Aug 15, 2024

Update metadata of Primitives V2 Qiskit/qiskit-aer#2206

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update metadata of Primitives V2 #12784

Update metadata of Primitives V2 #12784

t-imamichi commented Jul 18, 2024 •

edited

Loading

qiskit-bot commented Jul 18, 2024

coveralls commented Jul 18, 2024 •

edited

Loading

t-imamichi Jul 29, 2024

t-imamichi commented Jul 29, 2024 •

edited

Loading

jyu00 left a comment

jyu00 Jul 29, 2024

t-imamichi Jul 30, 2024

ElePT commented Jul 30, 2024 •

edited

Loading

ElePT left a comment

Update metadata of Primitives V2 #12784

Update metadata of Primitives V2 #12784

Conversation

t-imamichi commented Jul 18, 2024 • edited Loading

Summary

Details and comments

qiskit-bot commented Jul 18, 2024

coveralls commented Jul 18, 2024 • edited Loading

Pull Request Test Coverage Report for Build 10164614695

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

t-imamichi Jul 29, 2024

Choose a reason for hiding this comment

t-imamichi commented Jul 29, 2024 • edited Loading

jyu00 left a comment

Choose a reason for hiding this comment

jyu00 Jul 29, 2024

Choose a reason for hiding this comment

t-imamichi Jul 30, 2024

Choose a reason for hiding this comment

ElePT commented Jul 30, 2024 • edited Loading

ElePT left a comment

Choose a reason for hiding this comment

t-imamichi commented Jul 18, 2024 •

edited

Loading

coveralls commented Jul 18, 2024 •

edited

Loading

t-imamichi commented Jul 29, 2024 •

edited

Loading

ElePT commented Jul 30, 2024 •

edited

Loading