Add expectation value measurement error mitigation #500

chriseclectic · 2020-09-18T20:25:52Z

Summary

This replaces #457 by adding expectation value measurement error mitigation using the current Ignis API style.

Co-authored-by: George S. Barron [email protected]

Details and comments

It includes Full A-matrix, tensored A-matrix, and CTMP mitigation methods.

For the CTMP method Numba will be used if it is installed to greatly improve performance.

TODO:

Release Note
Add Numba to setup.py extras
Remove example notebook

…tigation * Allow non-Z diagonal expval operators. * Add function for returning mitigation overhead * Add function for returning std-dev upper bound of estimation * Add function for returning required shots for mitigation accuracy

Co-Authored-By: George S. Barron <[email protected]>

Base class functions that compute properties from A-matrix still need to be overloaded to be computed more efficiently using the rate and generator matrices.

Due to Numba not really working well with Numpy random I had to pregenerate a large array of random samples outside of the compiled Numba functions in advance.

mtreinish

Can you add numba as an extra requirement here: https://github.com/Qiskit/qiskit-ignis/blob/master/setup.py#L79-L82 just add a new dict entry where the key is the name and the value is a list of the requirements. So in this case something like 'expval-measurement': ['numba'] it's also probably worth updating the readme section here: https://github.com/Qiskit/qiskit-ignis/blob/master/README.md#extra-requirements after you add it.

yaelbh · 2020-09-21T10:06:11Z

I'm trying to understand the functionality by reading the example notebook. Could you please update the notebook to work with this code?

yaelbh

I'm still reviewing. I'm submitting, just to let you see the comments that I've made so far. As noted in the conversation, please prepare a usage example (in a notebook, or any other way that sheds a light on the process).

README.md

qiskit/ignis/mitigation/expval/base_meas_mitigator.py

qiskit/ignis/mitigation/expval/mitigation_example.ipynb

qiskit/ignis/mitigation/expval/circuits.py

qiskit/ignis/mitigation/expval/complete_mitigator.py

yaelbh · 2020-09-21T12:51:02Z

I'll try to use the tests as usage examples

yaelbh · 2020-09-21T13:39:11Z

I see now the functions in utils.py, these are the functions that I see in the notebook. So the notebook is probably up-to-date.

yaelbh

OK, I finished to review

qiskit/ignis/mitigation/expval/circuits.py

yaelbh · 2020-09-21T13:30:17Z

qiskit/ignis/mitigation/expval/ctmp_mitigator.py

+            self._noise_strengths[qubits] = gamma
+        return self._noise_strengths[qubits]
+
+    def seed(self, value=None):


Not sure that this is the correct location for this function

This is how seeds are changed on persistent objects in the quantum info module, but i added an option to set fixed seed at init as well.

yaelbh · 2020-09-21T13:59:20Z

As far as I see, there are no usage examples (tests or notebook) for the diagonal other than the default. This is not tested. See also the comment about the diagonal being a numpy array instead of an operator.

yaelbh

Please see the comments.

qiskit/ignis/mitigation/expval/base_meas_mitigator.py

qiskit/ignis/mitigation/expval/complete_mitigator.py

qiskit/ignis/mitigation/expval/base_meas_mitigator.py

qiskit/ignis/mitigation/expval/complete_mitigator.py

In qiskit-community#500 type hints were added for the plotting functions using the optional matplotlib dependencies. This breaks ignis installations without matplotlib present since it's an optional dependency. Since type hints are really just for documentation and not necessary this commit just removes those problematic hints and uses the docstring to document the types. At the same time the testing job verifying ignis works without any optional dependencies that was lost in the migration from travis to github actions is restored to verify that everything works moving forward.

In qiskit-community#500 type hints were added for the plotting functions using the optional matplotlib dependencies. This breaks ignis installations without matplotlib present since it's an optional dependency. Since type hints are really just for documentation and not necessary this commit just removes those problematic hints and uses the docstring to document the types. At the same time the testing job verifying ignis works without any optional dependencies that was lost in the migration from travis to github actions is restored to verify that everything works moving forward. Fixes qiskit-community#532

* Fix ignis without optional requirements installed In #500 type hints were added for the plotting functions using the optional matplotlib dependencies. This breaks ignis installations without matplotlib present since it's an optional dependency. Since type hints are really just for documentation and not necessary this commit just removes those problematic hints and uses the docstring to document the types. At the same time the testing job verifying ignis works without any optional dependencies that was lost in the migration from travis to github actions is restored to verify that everything works moving forward.

* Fix ignis without optional requirements installed In qiskit-community#500 type hints were added for the plotting functions using the optional matplotlib dependencies. This breaks ignis installations without matplotlib present since it's an optional dependency. Since type hints are really just for documentation and not necessary this commit just removes those problematic hints and uses the docstring to document the types. At the same time the testing job verifying ignis works without any optional dependencies that was lost in the migration from travis to github actions is restored to verify that everything works moving forward. (cherry picked from commit d9fe8f9)

chriseclectic and others added 28 commits September 18, 2020 16:13

Move existing measurement error mitigation to legacy folder

54ea9f9

Add CTMP error mitigation for operator expectation values

4480d6d

Co-Authored-By: George S. Barron <[email protected]>

Move most CTMP functions to Mitigator class and fitter function

89dd6e7

Add example notebook

3289c09

Add assignment fidelity and plotting function to mitigator classes

0f87ae5

Add mitigation matrix and assignment matrix functions to CTMP method

bf042ae

Base class functions that compute properties from A-matrix still need to be overloaded to be computed more efficiently using the rate and generator matrices.

Update example

55eecc7

Fix edge case where CTMP method failed if no measurement errors

55274ae

Improve performance of local A-matrix function for CTMP method

38da161

Add optional Numba compiling to A-matrix fitting from calibration data

d9a3afd

Combine fitters

d94726f

Update notebook

f76e802

Improve performance of CTMP sampling, add option to set RNG seed.

044c4dc

Due to Numba not really working well with Numpy random I had to pregenerate a large array of random samples outside of the compiled Numba functions in advance.

CTMP tests

ebe7fa2

Add expectation_value function, return standard deviation of expval

1f92578

update notebook

1012670

Update tests and inits

ec3d4aa

Remove old files

b6472d9

linting

c1e0933

Add support for qubits kwarg to CTMP method

aeb43e8

Update notebook

59b5ff0

Fix error

2bb3149

More efficient assignment fidelity for tensored mitigator

ba1214f

fix bug

b75e642

Move expval mitigation folder

83c70b1

Rename files and change to current ignis API style

a56eed6

Remove subdirectories

9a916fb

mtreinish reviewed Sep 18, 2020

View reviewed changes

Infer default method automatically from metadata

a632ed5

chriseclectic added 5 commits September 18, 2020 16:55

Add release note and numba optional dependency

3117f05

fixup

3abd213

Update readme

eb915bc

Linting

5f0a267

More linting

4fee3d3

yaelbh reviewed Sep 21, 2020

View reviewed changes

yaelbh suggested changes Sep 21, 2020

View reviewed changes

chriseclectic added 3 commits September 22, 2020 17:29

update mitigation API docs

fb8a3ba

Add additional tests of diagonal

f0137d0

remove example notebook

fd91d1a

chriseclectic added the Changelog: New Feature Include in the Added section of the changelog label Sep 22, 2020

Fix docs and tests

f47cb7b

yaelbh previously approved these changes Sep 23, 2020

View reviewed changes

Explain default behavior of clibts and qubits kwargs

eca0cb3

chriseclectic dismissed yaelbh’s stale review via eca0cb3 September 23, 2020 14:02

chriseclectic merged commit 2d940c3 into qiskit-community:master Sep 23, 2020

chriseclectic mentioned this pull request Sep 24, 2020

[WIP] Measurement error mitigation for expectation values #457

Closed

8 tasks

mtreinish mentioned this pull request Nov 4, 2020

Fix ignis without optional requirements installed #533

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add expectation value measurement error mitigation #500

Add expectation value measurement error mitigation #500

chriseclectic commented Sep 18, 2020 •

edited

Loading

mtreinish left a comment

yaelbh commented Sep 21, 2020

yaelbh left a comment

yaelbh commented Sep 21, 2020

yaelbh commented Sep 21, 2020

yaelbh left a comment

yaelbh Sep 21, 2020

chriseclectic Sep 22, 2020

yaelbh commented Sep 21, 2020

yaelbh left a comment

Add expectation value measurement error mitigation #500

Add expectation value measurement error mitigation #500

Conversation

chriseclectic commented Sep 18, 2020 • edited Loading

Summary

Details and comments

TODO:

mtreinish left a comment

Choose a reason for hiding this comment

yaelbh commented Sep 21, 2020

yaelbh left a comment

Choose a reason for hiding this comment

yaelbh commented Sep 21, 2020

yaelbh commented Sep 21, 2020

yaelbh left a comment

Choose a reason for hiding this comment

yaelbh Sep 21, 2020

Choose a reason for hiding this comment

chriseclectic Sep 22, 2020

Choose a reason for hiding this comment

yaelbh commented Sep 21, 2020

yaelbh left a comment

Choose a reason for hiding this comment

chriseclectic commented Sep 18, 2020 •

edited

Loading