``braintools.surrogate`` module
===============================

.. currentmodule:: braintools.surrogate 
.. automodule:: braintools.surrogate 


Surrogate Gradient Functions
----------------------------


.. autosummary::
   :toctree: generated/
   :nosignatures:

   sigmoid
   piecewise_quadratic
   piecewise_exp
   soft_sign
   arctan
   nonzero_sign_log
   erf
   piecewise_leaky_relu
   squarewave_fourier_series
   s2nn
   q_pseudo_spike
   leaky_relu
   log_tailed_relu
   relu_grad
   gaussian_grad
   inv_square_grad
   multi_gaussian_grad
   slayer_grad


Surrogate Gradient Classes
--------------------------

.. autosummary::
   :toctree: generated/
   :nosignatures:
   :template: classtemplate.rst

   Sigmoid
   PiecewiseQuadratic
   PiecewiseExp
   SoftSign
   Arctan
   NonzeroSignLog
   ERF
   PiecewiseLeakyRelu
   SquarewaveFourierSeries
   S2NN
   QPseudoSpike
   LeakyRelu
   LogTailedRelu
   ReluGrad
   GaussianGrad
   InvSquareGrad
   MultiGaussianGrad
   SlayerGrad