very messy support for subspace-restricted error metrics

Author: rileyjmurray

pygsti/report/factory.py

@@ -1199,6 +1199,10 @@ def construct_standard_report(results, title="auto",
     ws = ws or _ws.Workspace()
 
     advanced_options = advanced_options or {}
+    n_leak = advanced_options.get('n_leak', 0)
+    # ^ Not sure if this is a good place to pass this parameter.
+    #   A better implementation would be to store this info in model.basis
+    #   (for the various models).
     linlogPercentile = advanced_options.get('linlog percentile', 5)
     nmthreshold = advanced_options.get('nmthreshold', DEFAULT_NONMARK_ERRBAR_THRESHOLD)
     embed_figures = advanced_options.get('embed_figures', True)
@@ -1331,8 +1335,12 @@ def construct_standard_report(results, title="auto",
         'gauge_opt_labels': tuple(gauge_opt_labels),
         'max_lengths': tuple(Ls),
         'switchbd_maxlengths': tuple(swLs),
-        'show_unmodeled_error': bool('ShowUnmodeledError' in flags)
+        'show_unmodeled_error': bool('ShowUnmodeledError' in flags),
+        'n_leak' : n_leak
     }
+    # ^ Not sure if this is a good place to pass n_leak.
+    #   A better implementation would be to store this info in model.basis
+    #   (for the various models).
 
     templates = dict(
         html='~standard_html_report',

pygsti/report/reportables.py

@@ -998,6 +998,14 @@ def maximum_trace_dist(gate, mx_basis):
 Maximum_trace_dist = _modf.opfn_factory(maximum_trace_dist)
 # init args == (model, op_label)
 
+def leaky_maximum_trace_dist(gate, mx_basis):
+    closestUOpMx = _alg.find_closest_unitary_opmx(gate)
+    _tools.jamiolkowski_iso(closestUOpMx, mx_basis, mx_basis)
+    n_leak = 1
+    return _tools.leaky_jtracedist(gate, closestUOpMx, mx_basis, n_leak)
+
+Leaky_maximum_trace_dist = _modf.opfn_factory(leaky_maximum_trace_dist)
+
 
 def angles_btwn_rotn_axes(model):
     """
@@ -1069,6 +1077,12 @@ def entanglement_fidelity(a, b, mx_basis):
 Entanglement_fidelity = _modf.opsfn_factory(entanglement_fidelity)
 # init args == (model1, model2, op_label)
 
+def leaky_entanglement_fidelity(a, b, mx_basis):
+    n_leak = 1
+    return _tools.leaky_entanglement_fidelity(a, b, mx_basis, n_leak)
+
+Leaky_entanglement_fidelity = _modf.opsfn_factory(leaky_entanglement_fidelity)
+
 
 def entanglement_infidelity(a, b, mx_basis):
     """
@@ -1095,6 +1109,11 @@ def entanglement_infidelity(a, b, mx_basis):
 Entanglement_infidelity = _modf.opsfn_factory(entanglement_infidelity)
 # init args == (model1, model2, op_label)
 
+def leaky_entanglement_infidelity(a, b, mx_basis):
+    return 1 - leaky_entanglement_fidelity(a, b, mx_basis)
+
+Leaky_entanglement_infidelity = _modf.opsfn_factory(leaky_entanglement_infidelity)
+
 
 def closest_unitary_fidelity(a, b, mx_basis):  # assume vary model1, model2 fixed
     """
@@ -1186,6 +1205,12 @@ def jtrace_diff(a, b, mx_basis):  # assume vary model1, model2 fixed
 Jt_diff = _modf.opsfn_factory(jtrace_diff)
 # init args == (model1, model2, op_label)
 
+def leaky_jtrace_diff(a, b, mx_basis):
+    n_leak = 1
+    return _tools.leaky_jtracedist(a, b, mx_basis, n_leak)
+
+Leaky_Jt_diff = _modf.opsfn_factory(leaky_jtrace_diff)
+
 
 if _CVXPY_AVAILABLE:
 
@@ -2394,10 +2419,14 @@ def info_of_opfn_by_name(name):
     info = {
         "inf": ("Entanglement|Infidelity",
                 "1.0 - <psi| 1 x Lambda(psi) |psi>"),
+        "la-inf": ("Entanglement|Infidelity (subspace)",
+                   "TO-WRITE"),
         "agi": ("Avg. Gate|Infidelity",
                 "d/(d+1) (entanglement infidelity)"),
         "trace": ("1/2 Trace|Distance",
                   "0.5 | Chi(A) - Chi(B) |_tr"),
+        "la-trace" : ("1/2 Trace|Distance (subspace)",
+                      "TO-WRITE"),
         "diamond": ("1/2 Diamond-Dist",
                     "0.5 sup | (1 x (A-B))(rho) |_tr"),
         "nuinf": ("Non-unitary|Ent. Infidelity",
@@ -2467,12 +2496,18 @@ def evaluate_opfn_by_name(name, model, target_model, op_label_or_string,
     if name == "inf":
         fn = Entanglement_infidelity if b else \
             Circuit_entanglement_infidelity
+    elif name == "la-inf":
+        assert b
+        fn = Leaky_entanglement_infidelity
     elif name == "agi":
         fn = Avg_gate_infidelity if b else \
             Circuit_avg_gate_infidelity
     elif name == "trace":
         fn = Jt_diff if b else \
             Circuit_jt_diff
+    elif name == "la-trace":
+        assert b
+        fn = Leaky_Jt_diff
     elif name == "diamond":
         fn = HalfDiamondNorm if b else \
             CircuitHalfDiamondNorm

pygsti/report/section/gauge.py

@@ -168,9 +168,13 @@ def final_model_spam_vs_target_table(workspace, switchboard=None, confidence_lev
     @_Section.figure_factory(4)
     def final_gates_vs_target_table_gauge_var(workspace, switchboard=None, confidence_level=None,
                                               ci_brevity=1, **kwargs):
+        if kwargs.get('n_leak', 0) == 0:
+            display = ('inf', 'agi', 'trace', 'diamond', 'nuinf', 'nuagi')
+        else:
+            display = ('inf', 'la-inf', 'agi', 'trace', 'la-trace', 'diamond', 'nuinf', 'nuagi')
         return workspace.GatesVsTargetTable(
             switchboard.mdl_final, switchboard.mdl_target, _cri(1, switchboard, confidence_level, ci_brevity),
-            display=('inf', 'agi', 'trace', 'diamond', 'nuinf', 'nuagi')
+            display=display
         )
 
     @_Section.figure_factory(3)