From 739f723ebede2d6abb4c2a6fea5683d764b5463e Mon Sep 17 00:00:00 2001 From: Erik Nielsen Date: Tue, 14 Nov 2023 13:02:16 -0500 Subject: [PATCH 1/4] Erik adds some tagging during meeting with Riley. The ball is rolling!! --- pygsti/algorithms/compilers.py | 1 + pygsti/algorithms/contract.py | 1 + pygsti/algorithms/core.py | 1 + pygsti/algorithms/directx.py | 1 + pygsti/algorithms/fiducialpairreduction.py | 1 + 5 files changed, 5 insertions(+) diff --git a/pygsti/algorithms/compilers.py b/pygsti/algorithms/compilers.py index ac0c79331..c7ca7cac7 100644 --- a/pygsti/algorithms/compilers.py +++ b/pygsti/algorithms/compilers.py @@ -1,3 +1,4 @@ +## user-exposure: low (EGN) """ Clifford circuit, CNOT circuit, and stabilizer state/measurement generation compilation routines """ diff --git a/pygsti/algorithms/contract.py b/pygsti/algorithms/contract.py index c24f4f204..a358ab01c 100644 --- a/pygsti/algorithms/contract.py +++ b/pygsti/algorithms/contract.py @@ -1,3 +1,4 @@ +## user-exposure: minimal, forsaken (EGN) """ GST contraction algorithms """ diff --git a/pygsti/algorithms/core.py b/pygsti/algorithms/core.py index 44ecd95da..a607c6bc1 100644 --- a/pygsti/algorithms/core.py +++ b/pygsti/algorithms/core.py @@ -1,3 +1,4 @@ +## user-exposure: high (EGN - for "old"-style GST API e.g. run_gst_fit) """ Core GST algorithms """ diff --git a/pygsti/algorithms/directx.py b/pygsti/algorithms/directx.py index 13fd0fb09..a107d78df 100644 --- a/pygsti/algorithms/directx.py +++ b/pygsti/algorithms/directx.py @@ -1,3 +1,4 @@ +## user-exposure: minimal, forsaken (EGN - we don't use this anymore and never really did) """ Functions for generating Direct-(LGST, MC2GST, MLGST) models """ diff --git a/pygsti/algorithms/fiducialpairreduction.py b/pygsti/algorithms/fiducialpairreduction.py index 438e82ee8..c34310119 100644 --- a/pygsti/algorithms/fiducialpairreduction.py +++ b/pygsti/algorithms/fiducialpairreduction.py @@ -1,3 +1,4 @@ +## user-exposure: high (EGN - users use these functions for building GST experiment designs) """ Functions for reducing the number of required fiducial pairs for analysis. """ From 6565ad70bf846abc6f23d87783ec938c84b089e2 Mon Sep 17 00:00:00 2001 From: Corey Ostrove Date: Tue, 28 Nov 2023 14:15:34 -0700 Subject: [PATCH 2/4] Tag more of the algorithms module Add tagging to the top-levels of the rest of algorithms module. --- pygsti/algorithms/fiducialselection.py | 1 + pygsti/algorithms/gaugeopt.py | 1 + pygsti/algorithms/germselection.py | 1 + pygsti/algorithms/grammatrix.py | 1 + pygsti/algorithms/grasp.py | 1 + pygsti/algorithms/mirroring.py | 1 + pygsti/algorithms/randomcircuit.py | 1 + pygsti/algorithms/rbfit.py | 1 + pygsti/algorithms/robust_phase_estimation.py | 1 + pygsti/algorithms/scoring.py | 1 + 10 files changed, 10 insertions(+) diff --git a/pygsti/algorithms/fiducialselection.py b/pygsti/algorithms/fiducialselection.py index 39ff8d6de..ba84af086 100644 --- a/pygsti/algorithms/fiducialselection.py +++ b/pygsti/algorithms/fiducialselection.py @@ -1,3 +1,4 @@ +## user-exposure: high (CIO - users use these functions for building GST experiment designs) """ Functions for selecting a complete set of fiducials for a GST analysis. """ diff --git a/pygsti/algorithms/gaugeopt.py b/pygsti/algorithms/gaugeopt.py index fcd52d267..f5f2ddab3 100644 --- a/pygsti/algorithms/gaugeopt.py +++ b/pygsti/algorithms/gaugeopt.py @@ -1,3 +1,4 @@ +## user-exposure: low (CIO - manually gauge optimizing models is typically an advanced use case) """ GST gauge optimization algorithms """ diff --git a/pygsti/algorithms/germselection.py b/pygsti/algorithms/germselection.py index c2885690a..8c9e7b86b 100644 --- a/pygsti/algorithms/germselection.py +++ b/pygsti/algorithms/germselection.py @@ -1,3 +1,4 @@ +## user-exposure: high (CIO - users use these functions for building GST experiment designs) """ Functions for selecting a complete set of germs for a GST analysis. """ diff --git a/pygsti/algorithms/grammatrix.py b/pygsti/algorithms/grammatrix.py index d834cc546..675a112ff 100644 --- a/pygsti/algorithms/grammatrix.py +++ b/pygsti/algorithms/grammatrix.py @@ -1,3 +1,4 @@ +## user-exposure: minimal (CIO - Only presently utilized in creation of gram matrix spectrum plots in reports) """ Utility functions related to Gram matrix construction. """ diff --git a/pygsti/algorithms/grasp.py b/pygsti/algorithms/grasp.py index 5d70402c0..7f4a1f94f 100644 --- a/pygsti/algorithms/grasp.py +++ b/pygsti/algorithms/grasp.py @@ -1,3 +1,4 @@ +## user-exposure : minimal (Used internally in certain combinatorial optimization problems, but also less frequently nowadays) """ Functions to facilitate using GRASP. """ diff --git a/pygsti/algorithms/mirroring.py b/pygsti/algorithms/mirroring.py index 74dc2bcec..cde8a0138 100644 --- a/pygsti/algorithms/mirroring.py +++ b/pygsti/algorithms/mirroring.py @@ -1,3 +1,4 @@ +## user-exposure: low (Tentative, probably only used in RB internals, but check with Timothy or Jordan) """ circuit mirroring functions. """ diff --git a/pygsti/algorithms/randomcircuit.py b/pygsti/algorithms/randomcircuit.py index da4a42a8d..400bc681a 100644 --- a/pygsti/algorithms/randomcircuit.py +++ b/pygsti/algorithms/randomcircuit.py @@ -1,3 +1,4 @@ +## user-exposure: low (Tentative, probably only used in RB internals, but check with Jordan) """ Random circuit sampling functions. """ diff --git a/pygsti/algorithms/rbfit.py b/pygsti/algorithms/rbfit.py index ba54b3706..799788272 100644 --- a/pygsti/algorithms/rbfit.py +++ b/pygsti/algorithms/rbfit.py @@ -1,3 +1,4 @@ +## user-exposure: low (Tentative, probably only used in RB internals, but check with Jordan) """ Functions for analyzing RB data """ diff --git a/pygsti/algorithms/robust_phase_estimation.py b/pygsti/algorithms/robust_phase_estimation.py index c5ec90a86..e61f56d9b 100644 --- a/pygsti/algorithms/robust_phase_estimation.py +++ b/pygsti/algorithms/robust_phase_estimation.py @@ -1,3 +1,4 @@ +## user-exposure: low (Tentative, probably only used in RPE internals, but check with Kenny) """ Robust Phase Estimation platform agnostic portion """ diff --git a/pygsti/algorithms/scoring.py b/pygsti/algorithms/scoring.py index 7879088c2..a79591920 100644 --- a/pygsti/algorithms/scoring.py +++ b/pygsti/algorithms/scoring.py @@ -1,3 +1,4 @@ +## user-exposure: minimal (CIO- used internally in a number of experiment design related combinatorial optimization routines) """ Common functions used in scoring germ and fiducial sets. """ From 30bdf40594050a15184091ebf7abd2d08c522670 Mon Sep 17 00:00:00 2001 From: Corey Ostrove Date: Tue, 28 Nov 2023 19:46:59 -0700 Subject: [PATCH 3/4] Temporarily disable testing Temporarily disable the on-push unit testing in anticipation for many comment-only commits getting pushed to this branch. --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index fa5a4ba94..9d51b1a18 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -5,7 +5,7 @@ name: Build and run tests on: push: - branches-ignore: [ "beta" ] + branches-ignore: [ "beta", "user-exposure-tagging" ] # Hacky way to only run pull requests from forked repositories (assumes : is not used in branch names unless forked) # https://github.community/t/how-to-trigger-an-action-on-push-or-pull-request-but-not-both/16662/10 pull_request: From d96df107d67adeb456922b653e0521e17df3012e Mon Sep 17 00:00:00 2001 From: Erik Nielsen Date: Tue, 5 Dec 2023 11:26:28 -0500 Subject: [PATCH 4/4] Erik adds another round of module-level tags. Added agreements with others' markings for the rest of algorithms/ subpackage and added new markings for modules in baseobjs/ --- pygsti/algorithms/fiducialselection.py | 2 +- pygsti/algorithms/gaugeopt.py | 2 +- pygsti/algorithms/germselection.py | 2 +- pygsti/algorithms/grammatrix.py | 2 +- pygsti/algorithms/grasp.py | 2 +- pygsti/algorithms/mirroring.py | 2 +- pygsti/algorithms/randomcircuit.py | 2 +- pygsti/algorithms/rbfit.py | 2 +- pygsti/algorithms/robust_phase_estimation.py | 2 +- pygsti/algorithms/scoring.py | 2 +- pygsti/baseobjs/_compatibility.py | 1 + pygsti/baseobjs/advancedoptions.py | 1 + pygsti/baseobjs/basis.py | 1 + pygsti/baseobjs/basisconstructors.py | 1 + pygsti/baseobjs/errorgenbasis.py | 1 + pygsti/baseobjs/errorgenlabel.py | 1 + pygsti/baseobjs/errorgenspace.py | 1 + pygsti/baseobjs/exceptions.py | 1 + pygsti/baseobjs/label.py | 1 + pygsti/baseobjs/mongoserializable.py | 1 + pygsti/baseobjs/nicelyserializable.py | 1 + pygsti/baseobjs/opcalc/fastopcalc.pyx | 1 + pygsti/baseobjs/opcalc/slowopcalc.py | 1 + pygsti/baseobjs/outcomelabeldict.py | 1 + pygsti/baseobjs/polynomial.py | 1 + pygsti/baseobjs/profiler.py | 1 + pygsti/baseobjs/protectedarray.py | 1 + pygsti/baseobjs/qubitgraph.py | 1 + pygsti/baseobjs/resourceallocation.py | 1 + pygsti/baseobjs/smartcache.py | 1 + pygsti/baseobjs/statespace.py | 1 + pygsti/baseobjs/unitarygatefunction.py | 1 + pygsti/baseobjs/verbosityprinter.py | 1 + 33 files changed, 33 insertions(+), 10 deletions(-) diff --git a/pygsti/algorithms/fiducialselection.py b/pygsti/algorithms/fiducialselection.py index ba84af086..84c14d8ce 100644 --- a/pygsti/algorithms/fiducialselection.py +++ b/pygsti/algorithms/fiducialselection.py @@ -1,4 +1,4 @@ -## user-exposure: high (CIO - users use these functions for building GST experiment designs) +## user-exposure: high (CIO, EGN - users use these functions for building GST experiment designs) """ Functions for selecting a complete set of fiducials for a GST analysis. """ diff --git a/pygsti/algorithms/gaugeopt.py b/pygsti/algorithms/gaugeopt.py index f5f2ddab3..5e8a17758 100644 --- a/pygsti/algorithms/gaugeopt.py +++ b/pygsti/algorithms/gaugeopt.py @@ -1,4 +1,4 @@ -## user-exposure: low (CIO - manually gauge optimizing models is typically an advanced use case) +## user-exposure: low (CIO, EGN - manually gauge optimizing models is typically an advanced use case) """ GST gauge optimization algorithms """ diff --git a/pygsti/algorithms/germselection.py b/pygsti/algorithms/germselection.py index 8c9e7b86b..27dd8adba 100644 --- a/pygsti/algorithms/germselection.py +++ b/pygsti/algorithms/germselection.py @@ -1,4 +1,4 @@ -## user-exposure: high (CIO - users use these functions for building GST experiment designs) +## user-exposure: high (CIO, EGN - users use these functions for building GST experiment designs) """ Functions for selecting a complete set of germs for a GST analysis. """ diff --git a/pygsti/algorithms/grammatrix.py b/pygsti/algorithms/grammatrix.py index 675a112ff..a730a22de 100644 --- a/pygsti/algorithms/grammatrix.py +++ b/pygsti/algorithms/grammatrix.py @@ -1,4 +1,4 @@ -## user-exposure: minimal (CIO - Only presently utilized in creation of gram matrix spectrum plots in reports) +## user-exposure: minimal (CIO, EGN - Only presently utilized in creation of gram matrix spectrum plots in reports) """ Utility functions related to Gram matrix construction. """ diff --git a/pygsti/algorithms/grasp.py b/pygsti/algorithms/grasp.py index 7f4a1f94f..ba9519411 100644 --- a/pygsti/algorithms/grasp.py +++ b/pygsti/algorithms/grasp.py @@ -1,4 +1,4 @@ -## user-exposure : minimal (Used internally in certain combinatorial optimization problems, but also less frequently nowadays) +## user-exposure : minimal (???, EGN Used internally in certain combinatorial optimization problems, but also less frequently nowadays) """ Functions to facilitate using GRASP. """ diff --git a/pygsti/algorithms/mirroring.py b/pygsti/algorithms/mirroring.py index cde8a0138..f012462fa 100644 --- a/pygsti/algorithms/mirroring.py +++ b/pygsti/algorithms/mirroring.py @@ -1,4 +1,4 @@ -## user-exposure: low (Tentative, probably only used in RB internals, but check with Timothy or Jordan) +## user-exposure: low (??, EGN Tentative, probably only used in RB internals, but check with Timothy or Jordan) """ circuit mirroring functions. """ diff --git a/pygsti/algorithms/randomcircuit.py b/pygsti/algorithms/randomcircuit.py index 400bc681a..d1c39a3d5 100644 --- a/pygsti/algorithms/randomcircuit.py +++ b/pygsti/algorithms/randomcircuit.py @@ -1,4 +1,4 @@ -## user-exposure: low (Tentative, probably only used in RB internals, but check with Jordan) +## user-exposure: low (??, EGN Tentative, probably only used in RB internals, but check with Jordan) """ Random circuit sampling functions. """ diff --git a/pygsti/algorithms/rbfit.py b/pygsti/algorithms/rbfit.py index 799788272..3448ab06b 100644 --- a/pygsti/algorithms/rbfit.py +++ b/pygsti/algorithms/rbfit.py @@ -1,4 +1,4 @@ -## user-exposure: low (Tentative, probably only used in RB internals, but check with Jordan) +## user-exposure: low (??, EGN Tentative, probably only used in RB internals, but check with Jordan; FitResults may be independently used by Users extracting RB parameters from RB results) """ Functions for analyzing RB data """ diff --git a/pygsti/algorithms/robust_phase_estimation.py b/pygsti/algorithms/robust_phase_estimation.py index e61f56d9b..9c4eed926 100644 --- a/pygsti/algorithms/robust_phase_estimation.py +++ b/pygsti/algorithms/robust_phase_estimation.py @@ -1,4 +1,4 @@ -## user-exposure: low (Tentative, probably only used in RPE internals, but check with Kenny) +## user-exposure: low (??, EGN Tentative, probably only used in RPE internals, but check with Kenny) """ Robust Phase Estimation platform agnostic portion """ diff --git a/pygsti/algorithms/scoring.py b/pygsti/algorithms/scoring.py index a79591920..a5bca5224 100644 --- a/pygsti/algorithms/scoring.py +++ b/pygsti/algorithms/scoring.py @@ -1,4 +1,4 @@ -## user-exposure: minimal (CIO- used internally in a number of experiment design related combinatorial optimization routines) +## user-exposure: minimal (CIO, EGN - used internally in a number of experiment design related combinatorial optimization routines) """ Common functions used in scoring germ and fiducial sets. """ diff --git a/pygsti/baseobjs/_compatibility.py b/pygsti/baseobjs/_compatibility.py index e63a0a618..abaf2c2e1 100644 --- a/pygsti/baseobjs/_compatibility.py +++ b/pygsti/baseobjs/_compatibility.py @@ -1,3 +1,4 @@ +## user-exposure: minimal (EGN - internal use only; module already begins with underscore) """ Tools for general compatibility. """ diff --git a/pygsti/baseobjs/advancedoptions.py b/pygsti/baseobjs/advancedoptions.py index 8fbc5033a..16a8ab76e 100644 --- a/pygsti/baseobjs/advancedoptions.py +++ b/pygsti/baseobjs/advancedoptions.py @@ -1,3 +1,4 @@ +## user-exposure: high (EGN - not necessarily used a lot, but the purpose of the objects herein is to give end users access to advance protocol options) """ Utilities for defining advanced low-level parameterizations for various pyGSTi operations """ diff --git a/pygsti/baseobjs/basis.py b/pygsti/baseobjs/basis.py index 74a76e9ba..bf10c8aaf 100644 --- a/pygsti/baseobjs/basis.py +++ b/pygsti/baseobjs/basis.py @@ -1,3 +1,4 @@ +## user-exposure: high (EGN - in particular Basis.cast and access to Basis attributes) """ Defines the Basis object and supporting functions """ diff --git a/pygsti/baseobjs/basisconstructors.py b/pygsti/baseobjs/basisconstructors.py index 5fa8f3a19..7bd1b2405 100644 --- a/pygsti/baseobjs/basisconstructors.py +++ b/pygsti/baseobjs/basisconstructors.py @@ -1,3 +1,4 @@ +## user-exposure: low (EGN - most current access to basis functionality should be through the Basis object; this may be used in old code however, and so deprecating these might be a good idea) """ Functions for creating the standard sets of matrices in the standard, Pauli, Gell-Mann, and qutrit bases """ diff --git a/pygsti/baseobjs/errorgenbasis.py b/pygsti/baseobjs/errorgenbasis.py index 8f254198e..70973bb08 100644 --- a/pygsti/baseobjs/errorgenbasis.py +++ b/pygsti/baseobjs/errorgenbasis.py @@ -1,3 +1,4 @@ +## user-exposure: low (EGN - using these objects directly is uncommon and power-user functionality.) """ Defines the ElementaryErrorgenBasis class and supporting functionality. """ diff --git a/pygsti/baseobjs/errorgenlabel.py b/pygsti/baseobjs/errorgenlabel.py index c83781907..75eb751a3 100644 --- a/pygsti/baseobjs/errorgenlabel.py +++ b/pygsti/baseobjs/errorgenlabel.py @@ -1,3 +1,4 @@ +## user-exposure: low (EGN - using these objects directly is uncommon and power-user functionality. Ensuring they can be created from simple strings/tuples however may be "high" exposure) """ Defines the ElementaryErrorgenLabel class and supporting functionality. """ diff --git a/pygsti/baseobjs/errorgenspace.py b/pygsti/baseobjs/errorgenspace.py index d1df666a4..ea1ab648e 100644 --- a/pygsti/baseobjs/errorgenspace.py +++ b/pygsti/baseobjs/errorgenspace.py @@ -1,3 +1,4 @@ +## user-exposure: low (EGN - using these objects directly is uncommon and power-user functionality.) """ Defines the ErrorgenSpace class and supporting functionality. """ diff --git a/pygsti/baseobjs/exceptions.py b/pygsti/baseobjs/exceptions.py index 9678cbb7a..2b7322ed5 100644 --- a/pygsti/baseobjs/exceptions.py +++ b/pygsti/baseobjs/exceptions.py @@ -1,3 +1,4 @@ +## user-exposure: minimal (EGN - we don't even use these in the pygsti code except maybe in a few rare cases.) """ Defines GST exception classes """ diff --git a/pygsti/baseobjs/label.py b/pygsti/baseobjs/label.py index 8a081a882..a4db8508b 100644 --- a/pygsti/baseobjs/label.py +++ b/pygsti/baseobjs/label.py @@ -1,3 +1,4 @@ +## user-exposure: low (EGN - using these objects directly is uncommon, though their ability to act like and be created from strings & tuples is utilized by even novice users perhaps unknowingly) """ Defines the Label class """ diff --git a/pygsti/baseobjs/mongoserializable.py b/pygsti/baseobjs/mongoserializable.py index fe1a8bdb7..15c7cff04 100644 --- a/pygsti/baseobjs/mongoserializable.py +++ b/pygsti/baseobjs/mongoserializable.py @@ -1,3 +1,4 @@ +## user-exposure: minimal (EGN - this is unadvertized functionality and not used by anyone but Erik currently.) """ Defines the MongoSerializable class """ diff --git a/pygsti/baseobjs/nicelyserializable.py b/pygsti/baseobjs/nicelyserializable.py index 44f858b1b..0f3d02515 100644 --- a/pygsti/baseobjs/nicelyserializable.py +++ b/pygsti/baseobjs/nicelyserializable.py @@ -1,3 +1,4 @@ +## user-exposure: low (EGN - this is a base class for many others but not used directly by end users.) """ Defines the NicelySerializable class """ diff --git a/pygsti/baseobjs/opcalc/fastopcalc.pyx b/pygsti/baseobjs/opcalc/fastopcalc.pyx index b55cc7f37..6c2d8d204 100644 --- a/pygsti/baseobjs/opcalc/fastopcalc.pyx +++ b/pygsti/baseobjs/opcalc/fastopcalc.pyx @@ -1,3 +1,4 @@ +## user-exposure: minimal (EGN - these should just be subroutines of higher-level api functions) # encoding: utf-8 # cython: profile=False # cython: linetrace=False diff --git a/pygsti/baseobjs/opcalc/slowopcalc.py b/pygsti/baseobjs/opcalc/slowopcalc.py index b887ba591..2cf7ba9b1 100644 --- a/pygsti/baseobjs/opcalc/slowopcalc.py +++ b/pygsti/baseobjs/opcalc/slowopcalc.py @@ -1,3 +1,4 @@ +## user-exposure: minimal (EGN - parallel to fastopcalc.pyx) """Python implementations of common polynomial operations""" #*************************************************************************************************** # Copyright 2015, 2019 National Technology & Engineering Solutions of Sandia, LLC (NTESS). diff --git a/pygsti/baseobjs/outcomelabeldict.py b/pygsti/baseobjs/outcomelabeldict.py index 35fb425b7..4600360ba 100644 --- a/pygsti/baseobjs/outcomelabeldict.py +++ b/pygsti/baseobjs/outcomelabeldict.py @@ -1,3 +1,4 @@ +## user-exposure: low (EGN - using these objects directly is power-user functionality, though the ability of an OutcomeLabelDict to act like a normal dict is "high" exposure.) """ Defines the OutcomeLabelDict class """ diff --git a/pygsti/baseobjs/polynomial.py b/pygsti/baseobjs/polynomial.py index eed6e88c0..acfa078ae 100644 --- a/pygsti/baseobjs/polynomial.py +++ b/pygsti/baseobjs/polynomial.py @@ -1,3 +1,4 @@ +## user-exposure: minimal (EGN - only used by "TermForwardSimulator" and under the hood even there.) """ Defines the Polynomial class """ diff --git a/pygsti/baseobjs/profiler.py b/pygsti/baseobjs/profiler.py index 18579e7c9..6d59200e2 100644 --- a/pygsti/baseobjs/profiler.py +++ b/pygsti/baseobjs/profiler.py @@ -1,3 +1,4 @@ +## user-exposure: minimal (EGN - internal use only.) """ Defines the Profiler class and supporting functionality """ diff --git a/pygsti/baseobjs/protectedarray.py b/pygsti/baseobjs/protectedarray.py index 59d7eca72..cc1272f75 100644 --- a/pygsti/baseobjs/protectedarray.py +++ b/pygsti/baseobjs/protectedarray.py @@ -1,3 +1,4 @@ +## user-exposure: low (EGN - I expect never used directly, but functionality accessed as the base class for TP maps.) """ Defines the ProtectedArray class """ diff --git a/pygsti/baseobjs/qubitgraph.py b/pygsti/baseobjs/qubitgraph.py index 79315c419..61ecc1059 100644 --- a/pygsti/baseobjs/qubitgraph.py +++ b/pygsti/baseobjs/qubitgraph.py @@ -1,3 +1,4 @@ +## user-exposure: low (EGN - not used direclty except by power users, though conversions from names like geometry='line' is used by many uses.) """ Defines the QubitGraph class and supporting functions """ diff --git a/pygsti/baseobjs/resourceallocation.py b/pygsti/baseobjs/resourceallocation.py index e0d27a8f8..822df8390 100644 --- a/pygsti/baseobjs/resourceallocation.py +++ b/pygsti/baseobjs/resourceallocation.py @@ -1,3 +1,4 @@ +## user-exposure: minimal (EGN - internal use only.) """ Resource allocation manager """ diff --git a/pygsti/baseobjs/smartcache.py b/pygsti/baseobjs/smartcache.py index 078666649..27d8c226a 100644 --- a/pygsti/baseobjs/smartcache.py +++ b/pygsti/baseobjs/smartcache.py @@ -1,3 +1,4 @@ +## user-exposure: minimal (EGN - internal use only.) """ Defines SmartCache and supporting functions """ diff --git a/pygsti/baseobjs/statespace.py b/pygsti/baseobjs/statespace.py index 4a358a35f..95241a268 100644 --- a/pygsti/baseobjs/statespace.py +++ b/pygsti/baseobjs/statespace.py @@ -1,3 +1,4 @@ +## user-exposure: low (EGN - used directly only by power users. Created implicitly by conversion from integers to QubitSpaces, etc.) """ Defines OrderedDict-derived classes used to store specific pyGSTi objects """ diff --git a/pygsti/baseobjs/unitarygatefunction.py b/pygsti/baseobjs/unitarygatefunction.py index 5cc80ef70..9e9bea865 100644 --- a/pygsti/baseobjs/unitarygatefunction.py +++ b/pygsti/baseobjs/unitarygatefunction.py @@ -1,3 +1,4 @@ +## user-exposure: minimal (EGN - only power users creating their own continuously parameterized gates would make use of this class.) """ Defines the UnitaryGateFunction class and supporting functionality. """ diff --git a/pygsti/baseobjs/verbosityprinter.py b/pygsti/baseobjs/verbosityprinter.py index 1cbc4abca..a1dbd2b82 100644 --- a/pygsti/baseobjs/verbosityprinter.py +++ b/pygsti/baseobjs/verbosityprinter.py @@ -1,3 +1,4 @@ +## user-exposure: low (EGN - almost always created internally by casting from an integer.) """ Defines the VerbosityPrinter class, used for logging output. """