WIP: leakage-aware GST #410

rileyjmurray · 2024-03-19T19:15:31Z

TODOs

Leakage analysis that's important, but out of scope for this PR.

systems with > 1 qubit.
systems with > 1 leakage level.
CPTP kite models

rileyjmurray · 2025-03-25T14:36:05Z

Text from an email Piper sent (not showing plots since they contained real data):

I was looking at the model violation tab, trying to work out why the smaller L models weren’t fitting the data as well as might be expected as quantified by Nsigma. I think this maybe be a function of how we calculate Nsigma = (2delta logl -k)/sqrt(2k). The number of non-gauge model parameters N_p is reported as 351 in the leakage-enhanced GST report (I don’t have any particular sense of whether this is correct). The number of data points N_s is 193 for L=1. This means that k (the degrees of freedom) is negative if you just calculate it as N_s-N_p. In cases like this, pyGSTi chooses k=1. k remains small until L is fairly large, which means two delta logl must be quite small for Nsigma to be small. This explains why we don’t see any red boxes in the per sequence detail for the L=1 iteration (and Nsigma is large enough that I would expect to see some or at least more dark gray squares than can be seen).

If you directly compare two delta logl between the two fits, you can see that the two delta logl is in fact smaller in the leakage-enhanced report than in the standard report.

I think the solution here is just to make sure that the first iteration of leakage-aware GST uses L=2 instead of L=1. (Or, more generally, we use the smallest L where N_s > N_p.)

rileyjmurray

Leaving file-level comments so @coreyostrove and I can figure out what to split out from this PR.

pygsti/algorithms/gaugeopt.py

rileyjmurray · 2025-07-24T20:27:32Z

pygsti/circuits/circuit.py

This change is needed for correctness; it's not leakage-specific.

rileyjmurray · 2025-07-24T20:27:52Z

pygsti/data/dataset.py

The change in 42f0cf3 (the date is misleading because I force-pushed) is not leakage-specific and seems worth keeping.

rileyjmurray · 2025-07-24T20:42:17Z

pygsti/modelmembers/operations/linearop.py

Small changes needed for leakage analysis.

rileyjmurray · 2025-07-24T20:49:19Z

pygsti/modelmembers/povms/__init__.py

Small changes needed for leakage analysis (could be needed in other contexts).

rileyjmurray · 2025-07-24T21:11:48Z

pygsti/tools/basistools.py

Changes needed for leakage analysis.

rileyjmurray · 2025-07-24T21:12:08Z

pygsti/tools/jamiolkowski.py

Not leakage-specific, but necessary for leakage analysis.

rileyjmurray · 2025-07-24T21:15:31Z

pygsti/tools/sdptools.py

Changes needed for leakage analysis, and useful more broadly

rileyjmurray · 2025-07-24T21:18:50Z

test/unit/algorithms/test_gaugeopt_correctness.py

Not leakage-specific

rileyjmurray · 2025-07-24T21:19:48Z

test/unit/tools/test_optools.py

Modest tests for code used in leakage analysis

rileyjmurray · 2025-07-25T18:53:38Z

pygsti/tools/optools.py

    """
-    povm_mx = compute_povm_map(model, povmlbl)
-    target_povm_mx = compute_povm_map(target_model, povmlbl)
-    return diamonddist(povm_mx, target_povm_mx, target_model.basis)
+    try:
+        povm_mx = compute_povm_map(model, povmlbl)
+        target_povm_mx = compute_povm_map(target_model, povmlbl)
+        return diamonddist(povm_mx, target_povm_mx, target_model.basis)
+    except AssertionError as e:
+        assert '`dim` must be a perfect square' in str(e)
+        return _np.NaN


This should have been included in PR #615

rileyjmurray · 2025-07-25T18:54:01Z

pygsti/tools/optools.py

-        tr = _np.sum(evals)
-        if abs(tr - 1) > __VECTOR_TOL__:
-            message = f"""
-            The PSD part of the input matrix is not trace-1 up to tolerance {__VECTOR_TOL__}.
-            Beware result!
-            """
-            _warnings.warn(message)


This should have been included in PR #615

rileyjmurray · 2025-07-25T23:35:00Z

pygsti/modelmembers/modelmembergraph.py

There are no subclasses of ModelMemberGraph, so the classmethod should be a staticmethod.

rileyjmurray · 2025-07-25T23:35:20Z

pygsti/modelmembers/povms/tppovm.py

readability

rileyjmurray · 2025-07-25T23:36:47Z

pygsti/modelmembers/states/densestate.py

Figuring this one out was a doozy. I'm certain that I could make a test which caused the existing code to break without doing anything leakage-specific.

…inearOperator (not just plain numpy ndarrays)

…frobenius norm computation. Bugfix in test_optools.py.

…lots of in-line comments explaining the logic.

…poses

…anch that omitted jac as a keyword argument to scipy.minimize, even if jac was None.

…nt fidelity from the calculation of that metric itself. This makes it easier to reuse the setup code in other metrics. While making this change, also make the setup more efficient by using TensorProduct bases from the beginning.

…elf` and make it a static method.

…eterizations on non-qubit spaces (for example, qutrit spaces) by changing the default error generator basis.

…n from ConfidenceRegionFactoryView.compute_confidence_interval(...) function, moving it to its own public instance method.

…n __eq__

…ed to be a classmethod; reverted to a staticmethod

… bug

…kage.py. Move some functions from optools.py into this new file. Still need to trim down pygsti/tools/leakage.py

…from optools.py into leakage.py

…es we had should not be needed if we define proper functions for handling gauge optimization

…ly basis. Only needed to update the .elements field of the ExplicitBasis that is the leakage-friendly-basis (to be an ndarray with ndim==3 rather than a list of ndarrays of ndim==2), and to change the default convert_to for gauge optimization to "full" instead of "full TP".

…norm tests on Windows

rileyjmurray force-pushed the leakage branch from f422726 to 2f23347 Compare September 24, 2024 21:07

rileyjmurray changed the title ~~WIP: leakage-aware gauge optimization~~ WIP: leakage-aware gauge optimization -- bad commit history Sep 24, 2024

rileyjmurray changed the base branch from master to develop September 24, 2024 21:15

rileyjmurray changed the title ~~WIP: leakage-aware gauge optimization -- bad commit history~~ WIP: leakage-aware gauge optimization Sep 24, 2024

rileyjmurray mentioned this pull request Sep 28, 2024

Maintenance of the Basis class #493

Merged

rileyjmurray force-pushed the leakage branch from 48eac7d to 0346cca Compare January 17, 2025 16:18

rileyjmurray changed the title ~~WIP: leakage-aware gauge optimization~~ WIP: leakage-aware GST Mar 25, 2025

rileyjmurray force-pushed the leakage branch from 904c2d9 to b3aba0d Compare July 24, 2025 18:54

rileyjmurray commented Jul 24, 2025

View reviewed changes

rileyjmurray mentioned this pull request Jul 25, 2025

à la carte standard GST reports, and exception handling for computing metrics #615

Merged

rileyjmurray force-pushed the leakage branch from 2608cdd to 7b38788 Compare July 25, 2025 18:49

rileyjmurray commented Jul 25, 2025

View reviewed changes

rileyjmurray mentioned this pull request Jul 25, 2025

New gauge group, plus minor changes to error generator classes #616

Merged

rileyjmurray commented Jul 25, 2025

View reviewed changes

pygsti/modelmembers/povms/tppovm.py Outdated

Copy link

Contributor Author

rileyjmurray Jul 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

readability

rileyjmurray commented Jul 25, 2025

View reviewed changes

rileyjmurray added 12 commits July 29, 2025 11:26

bugfix for my attemped efficiency improvement

f529155

extend basistools to gracefully accomodate objects that derive from L…

d389349

…inearOperator (not just plain numpy ndarrays)

update function in reportables to indicate API limitation. Bugfix in …

d7e880e

…frobenius norm computation. Bugfix in test_optools.py.

update implementation of state fidelity

9489fbd

comments. About to remove.

b402562

extend implementation to support bases other than pauli-product. Add …

43ce7af

…lots of in-line comments explaining the logic.

remove unused and broken function that I only added for debugging pur…

a4eca61

…poses

comment clarification

98cae3a

clean up implementation of ExplicitOpModelCalc.residuals

f47070b

slightly simplify minimize(...) function. There was an unnecessary br…

45e6b17

…anch that omitted jac as a keyword argument to scipy.minimize, even if jac was None.

add implementation of leaky jtracedist

4899bb8

rileyjmurray added 15 commits July 29, 2025 11:29

take an instance method for GSTGaugeOptSuite that never referenced `s…

1af3ef6

…elf` and make it a static method.

update the povm.convert(...) free function to work with CPTPLND param…

73da836

…eterizations on non-qubit spaces (for example, qutrit spaces) by changing the default error generator basis.

factor out functionality for computing the gradient of a ModelFunctio…

96c3fe7

…n from ConfidenceRegionFactoryView.compute_confidence_interval(...) function, moving it to its own public instance method.

revert hacky change in __hash__. Remove commented-out invalid lines i…

e21c524

…n __eq__

comments

50714ce

fix undefined variable; update comments

39cc16b

revert changes

d18e07c

left out of last commit

793b155

remove resolved TODO

b03e4ba

revert one-line change

84839c1

remove unused OuterProdBasis class

0776b57

remove commented-out code that isnt on develop

42688ae

ModelMemberGraph.load_modelmembers_from_serialization_dict did not ne…

5b1d324

…ed to be a classmethod; reverted to a staticmethod

readability

2952738

justify try-catch in DenseState._from_memoized_dict

f539e91

rileyjmurray force-pushed the leakage branch from f5f068a to f539e91 Compare July 29, 2025 18:30

rileyjmurray added 14 commits July 29, 2025 11:31

fix broken rebase

7323e24

have Circuit.__eq__ take less of a speed hit while still fixing prior…

39e4401

… bug

remove duplicate import

721ec35

move notebook infrastructure into a new pygsti file, pygsti/tools/lea…

82accb3

…kage.py. Move some functions from optools.py into this new file. Still need to trim down pygsti/tools/leakage.py

resolve circular imports, remove unused imports, move more functions …

26ec19e

…from optools.py into leakage.py

left out of last commit

72affd4

remove the report-generation helper functions from leakage.py. The on…

de254c1

…es we had should not be needed if we define proper functions for handling gauge optimization

changes to utilities for leakage-aware gauge optimization

0160477

correct incorrect import statements

cab438f

vaguely user-friendly API

6a46db8

revert some changes to _add_gauge_opt

06b48a9

left out

480694a

remove re-introduction of hack that was no longer needed for diamond …

9451edb

…norm tests on Windows

WIP: leakage-aware GST #410

Are you sure you want to change the base?

WIP: leakage-aware GST #410

Uh oh!

Conversation

rileyjmurray commented Mar 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rileyjmurray commented Mar 25, 2025

Uh oh!

rileyjmurray left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rileyjmurray Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rileyjmurray Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rileyjmurray commented Mar 19, 2024 •

edited

Loading

rileyjmurray Jul 24, 2025 •

edited

Loading

rileyjmurray Jul 24, 2025 •

edited

Loading