M3: Matrix-free measurement mitigation

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for nonhermitian from gravatar.com nonhermitian

Unverified details

These details have not been verified by PyPI
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: Apache Software License (Apache 2.0)

Author: Paul Nation

Requires: Python >=3.8

Classifiers

Project description

mthree

License PyPI version pypi workflow

Matrix-free Measurement Mitigation (M3).

M3 is a measurement mitigation technique that solves for corrected measurement probabilities using a dimensionality reduction step followed by either direct LU factorization or a preconditioned iterative method that nominally converges in O(1) steps, and can be computed in parallel. For example, M3 can compute corrections on 42 qubit GHZ problems in under two seconds on a quad-core machine (depending on the number of unique bitstrings in the output).

Documentation

Online Documentation @ Qiskit.org

Installation

You can pip install M3 in serial mode using PyPi via:

pip install mthree

Alternatively, one can install from source:

python setup.py install

To enable openmp one must have an openmp 3.0+ enabled compiler and install with:

python setup.py install --openmp

OpenMP on OSX

On OSX one must install LLVM using homebrew (You cannot use GCC):

brew install llvm

after which the following (or the like) must be executed in the terminal:

export PATH="/usr/local/opt/llvm/bin:$PATH"

and

export LDFLAGS="-L/usr/local/opt/llvm/lib -Wl,-rpath,/usr/local/opt/llvm/lib"
export CPPFLAGS="-I/usr/local/opt/llvm/include"

Then installation with openmp can be accomplished using:

CC=clang CXX=clang python setup.py install --openmp

Usage

Basic usage

M3 is simple to use:

import mthree
# Specify a mitigator object targeting a given backend
mit = mthree.M3Mitigation(backend)

# Compute the 1Q calibration matrices for the given qubits and given number of shots
# By default it is over all backend qubits at 10000 shots.
mit.cals_from_system(qubits, shots)

# Apply mitigation to a given dict of raw counts over the specified qubits
m3_quasi = mit.apply_correction(raw_counts, qubits)

Note that here qubits is a list of which qubits are measured to yield the bits in the output. For example the list [4,3,1,2,0] indicates that a measurement on physical qubit 4 was written to classical bit zero in the output bit-strings, physical qubit 3 maps to classical bit 1, etc. The fact that the zeroth bit is right-most in the bitstring is handled internally.

Error bounds

It is possible to compute error bounds in a similarly efficient manner. This is not done by default, but rather turned on using:

m3_quasi = mit.apply_correction(raw_counts, qubits, return_mitigation_overhead=True)

Then the distribution itself can be called to return things like the expectation value and the standard deviation:

expval, stddev = quasi.expval_and_stddev()

Closest probability distribution

The results of M3 mitigation are quasi-probabilities that nominally contain small negative values. This is suitable for use in computing corrected expectation values or sampling problems where one is interested in the highest probability bit-string. However, if one needs a true probability distribution then it is possible to convert from quasi-probabilites to the closest true probability distribution in L2-norm using:

closest_probs = m3_quasi.nearest_probability_distribution()

License

License

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for nonhermitian from gravatar.com nonhermitian

Unverified details

These details have not been verified by PyPI
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: Apache Software License (Apache 2.0)

Author: Paul Nation

Requires: Python >=3.8

Classifiers

Release history Release notifications | RSS feed

This version

2.6.3

2.6.1

2.5.1

2.5.0

2.4.0

2.3.0

2.2.0

2.1.0

2.0.0

1.1.0

1.0.0

0.24.0

0.23.0

0.22.0

0.21.0

0.20.0

0.19.0

0.18.0

0.17.2

0.17.0

0.16.2

0.16.0

0.15.0

0.14.0

0.13.0

0.12.1

0.12.0

0.11.0

0.10.0

0.9.2

0.9.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mthree-2.6.3.tar.gz (974.0 kB view hashes)

Uploaded Source

Built Distributions

mthree-2.6.3-cp312-cp312-win_amd64.whl (1.5 MB view hashes)

Uploaded CPython 3.12 Windows x86-64

mthree-2.6.3-cp312-cp312-win32.whl (1.4 MB view hashes)

Uploaded CPython 3.12 Windows x86

mthree-2.6.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.2 MB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

mthree-2.6.3-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl (4.1 MB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ i686

mthree-2.6.3-cp312-cp312-macosx_10_15_x86_64.whl (1.5 MB view hashes)

Uploaded CPython 3.12 macOS 10.15+ x86-64

mthree-2.6.3-cp312-cp312-macosx_10_15_universal2.whl (2.0 MB view hashes)

Uploaded CPython 3.12 macOS 10.15+ universal2 (ARM64, x86-64)

mthree-2.6.3-cp311-cp311-win_amd64.whl (1.5 MB view hashes)

Uploaded CPython 3.11 Windows x86-64

mthree-2.6.3-cp311-cp311-win32.whl (1.4 MB view hashes)

Uploaded CPython 3.11 Windows x86

mthree-2.6.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.3 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

mthree-2.6.3-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl (4.2 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ i686

mthree-2.6.3-cp311-cp311-macosx_10_15_x86_64.whl (1.5 MB view hashes)

Uploaded CPython 3.11 macOS 10.15+ x86-64

mthree-2.6.3-cp311-cp311-macosx_10_15_universal2.whl (2.0 MB view hashes)

Uploaded CPython 3.11 macOS 10.15+ universal2 (ARM64, x86-64)

mthree-2.6.3-cp310-cp310-win_amd64.whl (1.5 MB view hashes)

Uploaded CPython 3.10 Windows x86-64

mthree-2.6.3-cp310-cp310-win32.whl (1.4 MB view hashes)

Uploaded CPython 3.10 Windows x86

mthree-2.6.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.0 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

mthree-2.6.3-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl (4.0 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ i686

mthree-2.6.3-cp310-cp310-macosx_10_15_x86_64.whl (1.5 MB view hashes)

Uploaded CPython 3.10 macOS 10.15+ x86-64

mthree-2.6.3-cp310-cp310-macosx_10_15_universal2.whl (2.0 MB view hashes)

Uploaded CPython 3.10 macOS 10.15+ universal2 (ARM64, x86-64)

mthree-2.6.3-cp39-cp39-win_amd64.whl (1.5 MB view hashes)

Uploaded CPython 3.9 Windows x86-64

mthree-2.6.3-cp39-cp39-win32.whl (1.4 MB view hashes)

Uploaded CPython 3.9 Windows x86

mthree-2.6.3-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.0 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

mthree-2.6.3-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl (4.0 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ i686

mthree-2.6.3-cp39-cp39-macosx_10_15_x86_64.whl (1.5 MB view hashes)

Uploaded CPython 3.9 macOS 10.15+ x86-64

mthree-2.6.3-cp39-cp39-macosx_10_15_universal2.whl (2.0 MB view hashes)

Uploaded CPython 3.9 macOS 10.15+ universal2 (ARM64, x86-64)

mthree-2.6.3-cp38-cp38-win_amd64.whl (1.5 MB view hashes)

Uploaded CPython 3.8 Windows x86-64

mthree-2.6.3-cp38-cp38-win32.whl (1.4 MB view hashes)

Uploaded CPython 3.8 Windows x86

mthree-2.6.3-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.1 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

mthree-2.6.3-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl (4.0 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ i686

mthree-2.6.3-cp38-cp38-macosx_10_15_x86_64.whl (1.5 MB view hashes)

Uploaded CPython 3.8 macOS 10.15+ x86-64

mthree-2.6.3-cp38-cp38-macosx_10_15_universal2.whl (2.0 MB view hashes)

Uploaded CPython 3.8 macOS 10.15+ universal2 (ARM64, x86-64)

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page