User exposure tagging

.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:

pygsti/algorithms/compilers.py

@@ -1,3 +1,4 @@
+## user-exposure: low (EGN)
 """
 Clifford circuit, CNOT circuit, and stabilizer state/measurement generation compilation routines
 """

pygsti/algorithms/contract.py

@@ -1,3 +1,4 @@
+## user-exposure: minimal, forsaken (EGN)
 """
 GST contraction algorithms
 """

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
 """

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
 """

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.
 """

pygsti/algorithms/fiducialselection.py

@@ -1,3 +1,4 @@
+## 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.
 """

pygsti/algorithms/gaugeopt.py

@@ -1,3 +1,4 @@
+## user-exposure: low (CIO, EGN - manually gauge optimizing models is typically an advanced use case)
 """
 GST gauge optimization algorithms
 """

pygsti/algorithms/germselection.py

@@ -1,3 +1,4 @@
+## 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.
 """

pygsti/algorithms/grammatrix.py

@@ -1,3 +1,4 @@
+## user-exposure: minimal (CIO, EGN - Only presently utilized in creation of gram matrix spectrum plots in reports)
 """
 Utility functions related to Gram matrix construction.
 """

pygsti/algorithms/grasp.py

@@ -1,3 +1,4 @@
+## user-exposure : minimal (???, EGN Used internally in certain combinatorial optimization problems, but also less frequently nowadays)
 """
 Functions to facilitate using GRASP.
 """

pygsti/algorithms/mirroring.py

@@ -1,3 +1,4 @@
+## user-exposure: low (??, EGN Tentative, probably only used in RB internals, but check with Timothy or Jordan)
 """
 circuit mirroring functions.
 """

pygsti/algorithms/randomcircuit.py

@@ -1,3 +1,4 @@
+## user-exposure: low (??, EGN Tentative, probably only used in RB internals, but check with Jordan)
 """
 Random circuit sampling functions.
 """

pygsti/algorithms/rbfit.py

@@ -1,3 +1,4 @@
+## 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
 """

pygsti/algorithms/robust_phase_estimation.py

@@ -1,3 +1,4 @@
+## user-exposure: low (??, EGN Tentative, probably only used in RPE internals, but check with Kenny)
 """
 Robust Phase Estimation platform agnostic portion
 """

pygsti/algorithms/scoring.py

@@ -1,3 +1,4 @@
+## 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.
 """

pygsti/baseobjs/_compatibility.py

@@ -1,3 +1,4 @@
+## user-exposure: minimal (EGN - internal use only; module already begins with underscore)
 """
 Tools for general compatibility.
 """

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
 """

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
 """

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
 """

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.
 """

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.
 """

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.
 """

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
 """

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
 """

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
 """

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
 """

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

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).

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
 """

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
 """

pygsti/baseobjs/profiler.py

@@ -1,3 +1,4 @@
+## user-exposure: minimal (EGN - internal use only.)
 """
 Defines the Profiler class and supporting functionality
 """

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
 """

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
 """

pygsti/baseobjs/resourceallocation.py

@@ -1,3 +1,4 @@
+## user-exposure: minimal (EGN - internal use only.)
 """
 Resource allocation manager
 """

pygsti/baseobjs/smartcache.py

@@ -1,3 +1,4 @@
+## user-exposure: minimal (EGN - internal use only.)
 """
 Defines SmartCache and supporting functions
 """

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
 """

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.
 """

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.
 """