WIP: Tagging for code level of user exposure

.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 - 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 - 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 - 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 - 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 (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 (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 (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 (Tentative, probably only used in RB internals, but check with Jordan)
 """
 Functions for analyzing RB data
 """

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

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