Skip to content

Added docstring/documentation for sigmoid_function #10756

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.

Sign up for GitHub

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 4 commits into from
Oct 23, 2023
Merged

Added docstring/documentation for sigmoid_function #10756

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b0689c5
Added doctest for sigmoid_function
Suyashd999 Oct 21, 2023
fd99499
Added doctest for sigmoid_function
Suyashd999 Oct 21, 2023
ef23bae
Added doctest for sigmoid_function
Suyashd999 Oct 21, 2023
58a792c
Merge branch 'TheAlgorithms:master' into master
Suyashd999 Oct 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions machine_learning/logistic_regression.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,21 @@


def sigmoid_function(z):
"""
Also known as Logistic Function.

1
f(x) = -------
1 + e⁻ˣ

The sigmoid function approaches a value of 1 as its input 'x' becomes
increasing positive. Opposite for negative values.

Reference: https://en.wikipedia.org/wiki/Sigmoid_function

@param z: input to the function
@returns: returns value in the range 0 to 1
"""
return 1 / (1 + np.exp(-z))


Expand Down