Add documentation for nn.Hardsigmoid and nn.functional.hardsigmoid. (p…

…ytorch#38120) Summary: Pull Request resolved: pytorch#38120 Test Plan: build docs locally and attach a screenshot to this PR. Differential Revision: D21477815 Pulled By: zou3519 fbshipit-source-id: 420bbcfcbd191d1a8e33cdf4a90c95bf00a5d226
csarofeen · May 8, 2020 · 172bcdb · 172bcdb
1 parent 4157211
commit 172bcdb
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 2 deletions.
diff --git a/docs/source/nn.functional.rst b/docs/source/nn.functional.rst
@@ -268,6 +268,12 @@ Non-linear activation functions
 
 .. autofunction:: sigmoid
 
+:hidden:`hardsigmoid`
+~~~~~~~~~~~~~~~~~
+
+.. autofunction:: hardsigmoid
+
+
 Normalization functions
 -----------------------
 

diff --git a/docs/source/nn.rst b/docs/source/nn.rst
@@ -111,6 +111,7 @@ Non-linear Activations (weighted sum, nonlinearity)
 
     nn.ELU
     nn.Hardshrink
+    nn.Hardsigmoid
     nn.Hardtanh
     nn.LeakyReLU
     nn.LogSigmoid

diff --git a/torch/nn/functional.py b/torch/nn/functional.py
@@ -1617,7 +1617,7 @@ def hardsigmoid(input, inplace=False):
         \text{Hardsigmoid}(x) = \begin{cases}
             0 & \text{if~} x \le -3, \\
             1 & \text{if~} x \ge +3, \\
-            x / 6 & \text{otherwise}
+            x / 6 + 1 / 2 & \text{otherwise}
         \end{cases}
 
     Args:

diff --git a/torch/nn/modules/activation.py b/torch/nn/modules/activation.py
@@ -281,7 +281,7 @@ class Hardsigmoid(Module):
         \text{Hardsigmoid}(x) = \begin{cases}
             0 & \text{if~} x \le -3, \\
             1 & \text{if~} x \ge +3, \\
-            x / 6 & \text{otherwise}
+            x / 6 + 1 / 2 & \text{otherwise}
         \end{cases}