Simple profiling through decorator functions. (counting and timing of functions decorated with @count and @timeIt that have a SimPEG.utils.Counter)

e.g. output:
‘’’
Counters:
  InexactGaussNewton.doEndIteration       :        6
  InexactGaussNewton.printIter            :        7
  InexactGaussNewton.scaleSearchDirection :        6

Times:                                        mean      sum
  InexactGaussNewton.findSearchDirection  : 1.55e-02, 9.29e-02,    6x
  InexactGaussNewton.minimize             : 1.10e-01, 1.10e-01,    1x
  InexactGaussNewton.modifySearchDirection: 2.89e-04, 1.73e-03,    6x
  InexactGaussNewton.projection           : 3.69e-06, 1.11e-04,   30x
  InexactGaussNewton.stoppingCriteria     : 1.16e-04, 1.51e-03,   13x
  Inversion.dataObj                       : 6.60e-05, 8.58e-04,   13x
  Inversion.dataObj2Deriv                 : 1.03e-04, 6.20e-03,   60x
  Inversion.dataObjDeriv                  : 5.06e-05, 3.54e-04,    7x
  Inversion.evalFunction                  : 7.75e-04, 1.01e-02,   13x
  Inversion.run                           : 1.10e-01, 1.10e-01,    1x
  Regularization.modelObj                 : 3.56e-04, 4.63e-03,   13x
  Regularization.modelObj2Deriv           : 1.29e-03, 7.76e-02,   60x
  Regularization.modelObjDeriv            : 5.01e-04, 3.51e-03,    7x
‘’’

SimPEG/regularization/Regularization.py

@@ -1,4 +1,4 @@
-from SimPEG.utils import sdiag
+from SimPEG.utils import sdiag, count, timeIt
 import numpy as np
 
 class Regularization(object):
@@ -40,21 +40,20 @@ class Regularization(object):
             self._Wz = sdiag(a)*self.mesh.cellGradz
         return self._Wz
 
+    alpha_s = 1e-6
+    alpha_x = 1
+    alpha_y = 1
+    alpha_z = 1
 
+    counter = None
 
     def __init__(self, mesh):
         self.mesh = mesh
-        self._Wx = None
-        self._Wy = None
-        self._Wz = None
-        self.alpha_s = 1e-6
-        self.alpha_x = 1
-        self.alpha_y = 1
-        self.alpha_z = 1
 
     def pnorm(self, r):
         return 0.5*r.dot(r)
 
+    @timeIt
     def modelObj(self, m):
         mresid = m - self.mref
 
@@ -69,6 +68,7 @@ class Regularization(object):
 
         return mobj
 
+    @timeIt
     def modelObjDeriv(self, m):
         """
 
@@ -104,6 +104,7 @@ class Regularization(object):
         return mobjDeriv
 
 
+    @timeIt
     def modelObj2Deriv(self, m):
         mresid = m - self.mref