Add cirq.TensoredConfusionMatrices for readout error mitigation.

cirq-core/cirq/__init__.py

@@ -102,6 +102,7 @@
 )
 
 from cirq.experiments import (
+    TensoredConfusionMatrices,
     estimate_parallel_single_qubit_readout_errors,
     estimate_single_qubit_readout_errors,
     hog_score_xeb_fidelity_from_probabilities,
@@ -114,6 +115,7 @@
     generate_boixo_2018_supremacy_circuits_v2,
     generate_boixo_2018_supremacy_circuits_v2_bristlecone,
     generate_boixo_2018_supremacy_circuits_v2_grid,
+    measure_confusion_matrix,
     xeb_fidelity,
 )
 

cirq-core/cirq/experiments/__init__.py

@@ -65,6 +65,11 @@
     random_rotations_between_grid_interaction_layers_circuit,
 )
 
+from cirq.experiments.readout_confusion_matrix import (
+    TensoredConfusionMatrices,
+    measure_confusion_matrix,
+)
+
 from cirq.experiments.n_qubit_tomography import (
     get_state_tomography_data,
     state_tomography,

cirq-core/cirq/experiments/readout_confusion_matrix_test.py

@@ -0,0 +1,140 @@
+# Copyright 2022 The Cirq Developers
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import numpy as np
+import cirq
+import pytest
+
+from cirq.experiments.single_qubit_readout_calibration_test import NoisySingleQubitReadoutSampler
+
+
+def get_expected_cm(num_qubits: int, p0: float, p1: float):
+    expected_cm = np.zeros((2 ** num_qubits,) * 2)
+    for i in range(2 ** num_qubits):
+        for j in range(2 ** num_qubits):
+            p = 1.0
+            for k in range(num_qubits):
+                b0 = (i >> k) & 1
+                b1 = (j >> k) & 1
+                if b0 == 0:
+                    p *= p0 * b1 + (1 - p0) * (1 - b1)
+                else:
+                    p *= p1 * (1 - b1) + (1 - p1) * b1
+            expected_cm[i][j] = p
+    return expected_cm
+
+
+@pytest.mark.parametrize('p0, p1', [(0, 0), (0.2, 0.4), (0.5, 0.5), (0.6, 0.3), (1.0, 1.0)])
+def test_measure_confusion_matrix_with_noise(p0, p1):
+    sampler = NoisySingleQubitReadoutSampler(p0, p1, seed=1234)
+    num_qubits = 4
+    qubits = cirq.LineQubit.range(num_qubits)
+    expected_cm = get_expected_cm(num_qubits, p0, p1)
+    qubits_small = qubits[:2]
+    expected_cm_small = get_expected_cm(2, p0, p1)
+    repetitions = 12_000
+    # Build entire confusion matrix by running 2 ** 4 = 16 circuits.
+    readout_cm = cirq.measure_confusion_matrix(sampler, qubits, repetitions=repetitions)
+    assert readout_cm.repetitions == repetitions
+    for q, expected in zip([None, qubits_small], [expected_cm, expected_cm_small]):
+        np.testing.assert_allclose(readout_cm.confusion_matrix(q), expected, atol=1e-2)
+        np.testing.assert_allclose(
+            readout_cm.confusion_matrix(q) @ readout_cm.correction_matrix(q),
+            np.eye(expected.shape[0]),
+            atol=1e-2,
+        )
+
+    # Build a tensored confusion matrix using smaller single qubit confusion matrices.
+    # This works because the error is uncorrelated and requires only 4 * 2 = 8 circuits.
+    readout_cm = cirq.measure_confusion_matrix(
+        sampler, [[q] for q in qubits], repetitions=repetitions
+    )
+    assert readout_cm.repetitions == repetitions
+    for q, expected in zip([None, qubits_small], [expected_cm, expected_cm_small]):
+        np.testing.assert_allclose(readout_cm.confusion_matrix(q), expected, atol=1e-2)
+        np.testing.assert_allclose(
+            readout_cm.confusion_matrix(q) @ readout_cm.correction_matrix(q),
+            np.eye(expected.shape[0]),
+            atol=1e-2,
+        )
+
+    # Apply corrections to sampled probabilities using readout_cm.
+    qs = qubits_small
+    circuit = cirq.Circuit(cirq.H.on_each(*qs), cirq.measure(*qs))
+    reps = 100_000
+    sampled_result = cirq.get_state_histogram(sampler.run(circuit, repetitions=reps)) / reps
+    expected_result = [1 / 4] * 4
+
+    def l2norm(result: np.ndarray):
+        return np.sum((expected_result - result) ** 2)
+
+    corrected_result = readout_cm.apply(sampled_result, qs)
+    assert l2norm(corrected_result) <= l2norm(sampled_result)
+
+
+def test_readout_confusion_matrix_raises():
+    num_qubits = 2
+    confusion_matrix = get_expected_cm(num_qubits, 0.1, 0.2)
+    qubits = cirq.LineQubit.range(4)
+    with pytest.raises(ValueError, match=r"measure_qubits cannot be empty"):
+        _ = cirq.TensoredConfusionMatrices([], [], repetitions=0, timestamp=0)
+
+    with pytest.raises(ValueError, match=r"len\(confusion_matrices\)"):
+        _ = cirq.TensoredConfusionMatrices(
+            [confusion_matrix], [qubits[:2], qubits[2:]], repetitions=0, timestamp=0
+        )
+
+    with pytest.raises(ValueError, match="Shape mismatch for confusion matrix"):
+        _ = cirq.TensoredConfusionMatrices(confusion_matrix, qubits, repetitions=0, timestamp=0)
+
+    with pytest.raises(ValueError, match="Repeated qubits not allowed"):
+        _ = cirq.TensoredConfusionMatrices(
+            [confusion_matrix, confusion_matrix],
+            [qubits[:2], qubits[1:3]],
+            repetitions=0,
+            timestamp=0,
+        )
+
+    readout_cm = cirq.TensoredConfusionMatrices(
+        [confusion_matrix, confusion_matrix], [qubits[:2], qubits[2:]], repetitions=0, timestamp=0
+    )
+
+    with pytest.raises(ValueError, match="should be a subset of"):
+        _ = readout_cm.confusion_matrix([cirq.NamedQubit("a")])
+
+    with pytest.raises(ValueError, match="should be a subset of"):
+        _ = readout_cm.correction_matrix([cirq.NamedQubit("a")])
+
+    with pytest.raises(ValueError, match="result.shape .* should be"):
+        _ = readout_cm.apply(np.asarray([100]), qubits[:2])
+
+    with pytest.raises(ValueError, match="method.* should be"):
+        _ = readout_cm.apply(np.asarray([1 / 16] * 16), method='l1norm')
+
+
+def test_readout_confusion_matrix_repr_and_equality():
+    mat1 = cirq.testing.random_orthogonal(4, random_state=1234)
+    mat2 = cirq.testing.random_orthogonal(2, random_state=1234)
+    q = cirq.LineQubit.range(3)
+    a = cirq.TensoredConfusionMatrices([mat1, mat2], [q[:2], q[2:]], repetitions=0, timestamp=0)
+    b = cirq.TensoredConfusionMatrices(mat1, q[:2], repetitions=0, timestamp=0)
+    c = cirq.TensoredConfusionMatrices(mat2, q[2:], repetitions=0, timestamp=0)
+    for x in [a, b, c]:
+        cirq.testing.assert_equivalent_repr(x)
+        assert cirq.approx_eq(x, x)
+        assert x._approx_eq_(mat1, 1e-6) is NotImplemented
+    eq = cirq.testing.EqualsTester()
+    eq.add_equality_group(a, a)
+    eq.add_equality_group(b, b)
+    eq.add_equality_group(c, c)

cirq-core/cirq/experiments/single_qubit_readout_calibration_test.py

@@ -52,12 +52,12 @@ def run_sweep(
         results = self.simulator.run_sweep(program, params, repetitions)
         for result in results:
             for bits in result.measurements.values():
-                with np.nditer(bits, op_flags=['readwrite']) as it:
-                    for x in it:
-                        if x == 0 and self.prng.uniform() < self.p0:
-                            x[...] = 1
-                        elif self.prng.uniform() < self.p1:
-                            x[...] = 0
+                rand_num = self.prng.uniform(size=bits.shape)
+                should_flip = np.logical_or(
+                    np.logical_and(bits == 0, rand_num < self.p0),
+                    np.logical_and(bits == 1, rand_num < self.p1),
+                )
+                bits[should_flip] ^= 1
         return results
 
 

cirq-core/cirq/json_resolver_cache.py

@@ -140,6 +140,7 @@ def _parallel_gate_op(gate, qubits):
         '_QubitAsQid': raw_types._QubitAsQid,
         'QuantumFourierTransformGate': cirq.QuantumFourierTransformGate,
         'RandomGateChannel': cirq.RandomGateChannel,
+        'TensoredConfusionMatrices': cirq.TensoredConfusionMatrices,
         'RepetitionsStoppingCriteria': cirq.work.RepetitionsStoppingCriteria,
         'ResetChannel': cirq.ResetChannel,
         'Result': cirq.Result,

cirq-core/cirq/protocols/json_test_data/TensoredConfusionMatrices.json

@@ -0,0 +1,61 @@
+{
+  "cirq_type": "TensoredConfusionMatrices",
+  "confusion_matrices": [
+    [
+      [
+        0.6395,
+        0.1594,
+        0.1592,
+        0.0419
+      ],
+      [
+        0.5617,
+        0.2368,
+        0.1401,
+        0.0614
+      ],
+      [
+        0.5655,
+        0.1367,
+        0.2403,
+        0.0575
+      ],
+      [
+        0.4835,
+        0.2185,
+        0.2048,
+        0.0932
+      ]
+    ],
+    [
+      [
+        0.7999,
+        0.2001
+      ],
+      [
+        0.7046,
+        0.2954
+      ]
+    ]
+  ],
+  "measure_qubits": [
+    [
+      {
+        "cirq_type": "LineQubit",
+        "x": 0
+      },
+      {
+        "cirq_type": "LineQubit",
+        "x": 1
+      }
+    ],
+    [
+      {
+        "cirq_type": "NamedQubit",
+        "name": "a"
+      }
+    ]
+  ],
+  "repetitions": 10000,
+  "timestamp": 1642630636.966274
+}

cirq-core/cirq/protocols/json_test_data/TensoredConfusionMatrices.repr

@@ -0,0 +1,17 @@
+cirq.TensoredConfusionMatrices(
+    [
+        np.array(
+            [
+                [0.6395, 0.1594, 0.1592, 0.0419],
+                [0.5617, 0.2368, 0.1401, 0.0614],
+                [0.5655, 0.1367, 0.2403, 0.0575],
+                [0.4835, 0.2185, 0.2048, 0.0932],
+            ],
+            dtype=np.float64,
+        ),
+        np.array([[0.7999, 0.2001], [0.7046, 0.2954]], dtype=np.float64),
+    ],
+    [[cirq.LineQubit(0), cirq.LineQubit(1)], [cirq.NamedQubit('a')]],
+    repetitions=10000,
+    timestamp=1642630636.966274,
+)