add tanh activation (#10)

brainpy · Apr 20, 2024 · 5b970fe · 5b970fe
1 parent ca6fd53
commit 5b970fe
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/braintools/functional/_activations.py b/braintools/functional/_activations.py
@@ -27,6 +27,7 @@
 import braincore as bc
 
 __all__ = [
+  "tanh",
   "relu",
   "squareplus",
   "softplus",
@@ -60,6 +61,22 @@
   'softmin',
 ]
 
+def tanh(x: ArrayLike) -> jax.Array:
+  r"""Hyperbolic tangent activation function.
+
+  Computes the element-wise function:
+
+  .. math::
+    \mathrm{tanh}(x) = \frac{e^x - e^{-x}}{e^x + e^{-x}}
+
+  Args:
+    x : input array
+
+  Returns:
+    An array.
+  """
+  return jnp.tanh(x)
+
 
 def softmin(x, axis=-1):
   r"""

diff --git a/docs/apis/functional.rst b/docs/apis/functional.rst
@@ -12,6 +12,7 @@ Activation Functions
    :nosignatures:
    :template: classtemplate.rst
 
+   tanh
    relu
    squareplus
    softplus