add brainpy.math.Surrogate

brainpy/_src/math/surrogate/_one_input_new.py

@@ -90,7 +90,30 @@ def _as_jax(x):
 
 
 class Surrogate(object):
-  """The base surrograte gradient function."""
+  """The base surrograte gradient function.
+
+  To customize a surrogate gradient function, you can inherit this class and
+  implement the `surrogate_fun` and `surrogate_grad` methods.
+
+  Examples
+  --------
+
+  >>> import brainpy as bp
+  >>> import brainpy.math as bm
+  >>> import jax.numpy as jnp
+
+  >>> class MySurrogate(bm.Surrogate):
+  ...   def __init__(self, alpha=1.):
+  ...     super().__init__()
+  ...     self.alpha = alpha
+  ...
+  ...   def surrogate_fun(self, x):
+  ...     return jnp.sin(x) * self.alpha
+  ...
+  ...   def surrogate_grad(self, x):
+  ...     return jnp.cos(x) * self.alpha
+
+  """
 
   def __call__(self, x):
     x = _as_jax(x)

brainpy/math/surrogate.py

@@ -1,8 +1,9 @@
 # -*- coding: utf-8 -*-
 
 
-
 from brainpy._src.math.surrogate._one_input_new import (
+  Surrogate,
+
   Sigmoid,
   sigmoid as sigmoid,