Skip to content

The tanh activation function is added #8689

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Apr 25, 2023
42 changes: 42 additions & 0 deletions maths/tanh.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
"""
This script demonstrates the implementation of the tangent hyperbolic
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor suggestion I have is to add a brief description of what the function does at the beginning of the docstring. For example:

"""
Implements the tangent hyperbolic or tanh function.

The function takes a vector of K real numbers as input and then applies
the tanh function to each element of the vector. The output values are
mostly in the range (-1, 1).
...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you for suggestion✌✌.

or tanh function.

The function takes a vector of K real numbers as input and
then (e^x - e^(-x))/(e^x + e^(-x)). After through tanh, the
element of the vector mostly -1 between 1.

Script inspired from its corresponding Wikipedia article
https://en.wikipedia.org/wiki/Activation_function
"""
import numpy as np


def tangent_hyperbolic(vector: np.array) -> np.array:
"""
Implements the tanh function

Parameters:
vector: np.array

Returns:
tanh (np.array): The input numpy array after applying tanh.

mathematically (e^x - e^(-x))/(e^x + e^(-x)) can be written as (2/(1+e^(-2x))-1

Examples:
>>> tangent_hyperbolic(np.array([1,5,6,-0.67]))
array([ 0.76159416, 0.9999092 , 0.99998771, -0.58497988])

>>> tangent_hyperbolic(np.array([8,10,2,-0.98,13]))
array([ 0.99999977, 1. , 0.96402758, -0.7530659 , 1. ])

"""

return (2 / (1 + np.exp(-2 * vector))) - 1


if __name__ == "__main__":
import doctest

doctest.testmod()