Skip to main content

A library for implementing spacetime coherent Pauli checks

Project description

Release Platform Python Qiskit
Docs (stable) License Downloads Tests Coverage

Qiskit Paulice

qiskit-paulice is a package for embedding hardware efficient Pauli checks into arbitrary Clifford circuits on arbitrary qubit connectivities using spacetime stabilizer codes. These checks can be used to detect logical errors during circuit execution. Postselecting only samples with no detected errors can improve the fidelity of states sampled with a quantum processor at the cost of some ancilla qubits and an increase in sampling overhead. This method is particularly suited to near-term hardware since it has a much milder overhead in qubits and gates compared to fault tolerant quantum computing, while having a better sampling overhead than error mitigation methods such as ZNE or PEC [1].

Although spacetime Pauli checks may be used to implement standalone error detection routines, they are also relevant in the context of error mitigation and error correction. Error detection can complement error mitigation techniques such as probabilistic error cancellation (PEC) by capturing some of the noise affecting gates and measurements, reducing the impact of the noise channel being inverted and thus reducing the sampling overhead. They may also be viewed as an early step toward practical fault tolerance since implementing stabilizer codes to protect data qubits from logical errors is a core concept of traditional error correction. Since this method provides single shot access to the quantum state it can be used in both sampling-based and expectation value-based workflows.


Documentation

Documentation for this package is available on the IBM Quantum Platform.


Installation

We encourage installing this package via pip, when possible:

pip install 'qiskit-paulice'

For more installation information refer to these installation instructions.


Getting started

A simple guide to help you get started quickly with this package is available here.


Use case examples

This technique has been used to improve the fidelity of samples from Clifford-dominated circuits up to 50 qubits and 2450 entangling gates [1].


Technical discussion

Finding good sets of spacetime Pauli checks

Quantum circuit cartoon

A set of spacetime Pauli checks is "good" if each check is valid, low weight, and effective.

A check is comprised of a number of controlled Pauli rotations, $P$, placed on some wires in the circuit, $w$: ${(P_1,w_1), ..., (P_k,w_k)}$. For a given check, the controls lie on a single ancilla qubit, and the rotations occur on wires of a single target qubit. For Clifford circuits, a check is valid if its backpropagated product is a stabilizer of the state prepared by the ideal circuit: $\prod_{i}B(P_i,w_i) \in S$, where $B(P,w)$ is the backpropagator of $P$ from $w$ to the beginning of the circuit, and $S$ is the set of all stabilizers of the circuit.

A check is low weight if it requires few entangling gates to implement. The check picking algorithm will favor checks that are low weight and provide the most effective error detection.

A check is effective if it captures much more error than it introduces. A Pauli check is comprised of a number of entangling gates and thus introduces some additional gate noise into the calculation. It is important to ensure each additional check brings some additional error detection capability. The effectiveness of a set of checks can be approximated by composing the Pauli errors that are uncovered by the checks into a postselected noise channel and calculating its impact. Minimizing the sampling overhead for implementing the uncovered inverse noise channel is a solid heuristic for selecting good checks, as it gives an indication of how much error the checks can't detect. A slower but more realistic approach is to perform a Monte Carlo sampling from the noisy state and empirically compute the logical error rate of the postselected distribution. Both of these approaches are available as built-in cost functions in the qiskit_paulice.add_pauli_checks function.

Postselecting samples based on syndrome data

In this package a check is implemented using entangling gates between one ancilla qubit and one target qubit. Each ancilla starts in $|0\rangle$, so $Z_\text{anc}$ stabilizes its input state. Forward propagating $Z_\text{anc}$ from the beginning of the ancilla through the entire checked circuit yields a Pauli operator on the output which may be higher weight and extend into the payload circuit. The qubit indices on which this output operator has non-identity terms are called the check's support, and the check passes if the bits, $b$, in the check's support have even parity: $\bigoplus_{i=1} b_i = 0$. A sample is kept if each check produces $0$ for its parity check.

Software Features

  • Automatic noise model creation from backend benchmark data
  • Rust accelerated check finding
  • 3 built-in algorithms for check finding
  • Evaluate efficacy of checks based on sampling overhead of postselected inverse noise channel or logical error rate based on Monte Carlo sampling of noisy state
  • Helper functionality for finding ancilla/target qubit pairs for a given backend

Known issues

  • Idling noise is not provided via NoiseModel.get_backend and is ignored during check picking
  • While many stochastic steps in the algorithm are controllable with a random seed, some features have randomness not controllable with a seed. Specifically, the following kwargs values for add_pauli_checks will cause undeterministic check picking: cost="LER", method="genetic", and method="windowed_genetic". For deterministic behavior use: add_pauli_checks(..., cost="gamma", method="windowed"), which are the default values.

Future work

  • Support for handling non-Clifford systems
  • More support for analyzing postselected noise channel
  • Handling idling noise when picking checks
  • Controllable randomness for logical error rate cost function and genetic search algorithms

Contributing

The source code is available on GitHub.

The developer guide is located at CONTRIBUTING.md in the root of this project's repository. By participating, you are expected to uphold Qiskit's code of conduct.


Citing this package

If you use this package in your research, use the CITATION.bib file in this project’s repository to cite the appropriate reference(s).


License

Apache License 2.0


Deprecation Policy

We follow semantic versioning. We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in the release notes.


References

[1] Simon Martiel, Ali Javadi-Abhari, Low-overhead error detection with spacetime codes, arXiv:2504.15725 [quant-ph].

Project details


Download files

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

Source Distribution

qiskit_paulice-0.2.tar.gz (804.5 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

qiskit_paulice-0.2-cp310-abi3-win_amd64.whl (382.6 kB view details)

Uploaded CPython 3.10+Windows x86-64

qiskit_paulice-0.2-cp310-abi3-manylinux_2_28_x86_64.whl (560.7 kB view details)

Uploaded CPython 3.10+manylinux: glibc 2.28+ x86-64

qiskit_paulice-0.2-cp310-abi3-manylinux_2_28_aarch64.whl (540.6 kB view details)

Uploaded CPython 3.10+manylinux: glibc 2.28+ ARM64

qiskit_paulice-0.2-cp310-abi3-macosx_11_0_arm64.whl (485.4 kB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

qiskit_paulice-0.2-cp310-abi3-macosx_10_12_x86_64.whl (495.6 kB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

Details for the file qiskit_paulice-0.2.tar.gz.

File metadata

  • Download URL: qiskit_paulice-0.2.tar.gz
  • Upload date:
  • Size: 804.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for qiskit_paulice-0.2.tar.gz
Algorithm Hash digest
SHA256 ab085290a5999f8ba6f0f622014dda14c213ec74802ae93856bd8fd1dd82c13c
MD5 ee4ec29037269e2ab6f7d8698a4a0446
BLAKE2b-256 25e35311bcef5ea0311e06149e84ac5a42dba17174a64bc996e8b11dee386356

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit_paulice-0.2.tar.gz:

Publisher: release.yml on Qiskit/qiskit-paulice

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qiskit_paulice-0.2-cp310-abi3-win_amd64.whl.

File metadata

  • Download URL: qiskit_paulice-0.2-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 382.6 kB
  • Tags: CPython 3.10+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for qiskit_paulice-0.2-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 80ef17e5e000e8b7a58fa142516712563c77257e9b8948ac25fe89aeaec55699
MD5 19c06f28c877cacd76e82310dbb0b34a
BLAKE2b-256 a4c681492924e9e213ea395fd8abd3e1b3e1c7f482d69b8043a15a796f0d4089

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit_paulice-0.2-cp310-abi3-win_amd64.whl:

Publisher: release.yml on Qiskit/qiskit-paulice

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qiskit_paulice-0.2-cp310-abi3-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for qiskit_paulice-0.2-cp310-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 66faa274b58d47e424b21c1202262b34293fd83129ba6fd702435c34ab1cb114
MD5 3a6221634b5cf7c8bf9f72b64334eac8
BLAKE2b-256 82d6e63bf35ae6b8158f5eb7c75d5942dbe498f978bf9e195dd645dcdd00cda5

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit_paulice-0.2-cp310-abi3-manylinux_2_28_x86_64.whl:

Publisher: release.yml on Qiskit/qiskit-paulice

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qiskit_paulice-0.2-cp310-abi3-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for qiskit_paulice-0.2-cp310-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 de7bf7fd9cefeb45f8da63c49377a309a919e06108e3e4121fcdb8f46c570318
MD5 8c2e5dc3ae0adb1b0d5bb0303a010713
BLAKE2b-256 3463f6cfae6f2427a1bcc2392a5cb38d6e8940da16f6cee802fb3b71a69d4cbb

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit_paulice-0.2-cp310-abi3-manylinux_2_28_aarch64.whl:

Publisher: release.yml on Qiskit/qiskit-paulice

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qiskit_paulice-0.2-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for qiskit_paulice-0.2-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 3e5c95aca7c0d610550de96b45b8d737c337aa86ea59565c91c1543c43702d51
MD5 5783a6816083350815de4a983ab32289
BLAKE2b-256 9ab6044d1c8e526c8c6666004522d22b3fd135227c1dceebb06617a3eb1a110c

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit_paulice-0.2-cp310-abi3-macosx_11_0_arm64.whl:

Publisher: release.yml on Qiskit/qiskit-paulice

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qiskit_paulice-0.2-cp310-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for qiskit_paulice-0.2-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 9d9b89d4ea18b8c822e33a2ebd1a5027dfed4d2dedbda13f87259f961dbfbf56
MD5 45cbf65e24af9cb2748b8e6b82b0ed53
BLAKE2b-256 11c0c84d9d72e537ccbd7f752d272f2d3d28cac905a5cf3bbbbf46e85d5e372c

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit_paulice-0.2-cp310-abi3-macosx_10_12_x86_64.whl:

Publisher: release.yml on Qiskit/qiskit-paulice

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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