add activations docs and add 1.6 changelog entry

rsokl · Jun 21, 2020 · b469c78 · b469c78
1 parent 698c747
commit b469c78
Show file tree

Hide file tree

Showing 33 changed files with 135 additions and 79 deletions.
diff --git a/docs/source/changes.rst b/docs/source/changes.rst
@@ -6,6 +6,23 @@ This is a record of all past mygrad releases and what went into them,
 in reverse chronological order. All previous releases should still be available
 on pip.
 
+.. _v1.6.0:
+
+------------------
+1.6.0 - 2020-06-21
+------------------
+
+New features:
+
+- Adds :func:`~mygrad.nnet.activations.elu`
+- Adds :func:`~mygrad.nnet.activations.glu`
+- Adds :func:`~mygrad.nnet.activations.leaky_relu`
+- Adds :func:`~mygrad.nnet.activations.selu`
+- Adds :func:`~mygrad.nnet.activations.soft_sign`
+
+Big thanks to David Mascharka!
+
+
 .. _v1.5.0:
 
 -------------------

diff --git a/docs/source/generated/mygrad.nnet.activations.elu.rst b/docs/source/generated/mygrad.nnet.activations.elu.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.activations.elu
+===========================
+
+.. currentmodule:: mygrad.nnet.activations
+
+.. autofunction:: elu
diff --git a/docs/source/generated/mygrad.nnet.activations.glu.rst b/docs/source/generated/mygrad.nnet.activations.glu.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.activations.glu
+===========================
+
+.. currentmodule:: mygrad.nnet.activations
+
+.. autofunction:: glu
diff --git a/docs/source/generated/mygrad.nnet.activations.hard_tanh.rst b/docs/source/generated/mygrad.nnet.activations.hard_tanh.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.activations.hard_tanh
+=================================
+
+.. currentmodule:: mygrad.nnet.activations
+
+.. autofunction:: hard_tanh
diff --git a/docs/source/generated/mygrad.nnet.activations.leaky_relu.rst b/docs/source/generated/mygrad.nnet.activations.leaky_relu.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.activations.leaky_relu
+==================================
+
+.. currentmodule:: mygrad.nnet.activations
+
+.. autofunction:: leaky_relu
diff --git a/docs/source/generated/mygrad.nnet.activations.logsoftmax.rst b/docs/source/generated/mygrad.nnet.activations.logsoftmax.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.activations.logsoftmax
+==================================
+
+.. currentmodule:: mygrad.nnet.activations
+
+.. autofunction:: logsoftmax
diff --git a/docs/source/generated/mygrad.nnet.activations.relu.rst b/docs/source/generated/mygrad.nnet.activations.relu.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.activations.relu
+============================
+
+.. currentmodule:: mygrad.nnet.activations
+
+.. autofunction:: relu
diff --git a/docs/source/generated/mygrad.nnet.activations.selu.rst b/docs/source/generated/mygrad.nnet.activations.selu.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.activations.selu
+============================
+
+.. currentmodule:: mygrad.nnet.activations
+
+.. autofunction:: selu
diff --git a/docs/source/generated/mygrad.nnet.activations.sigmoid.rst b/docs/source/generated/mygrad.nnet.activations.sigmoid.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.activations.sigmoid
+===============================
+
+.. currentmodule:: mygrad.nnet.activations
+
+.. autofunction:: sigmoid
diff --git a/docs/source/generated/mygrad.nnet.activations.soft_sign.rst b/docs/source/generated/mygrad.nnet.activations.soft_sign.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.activations.soft_sign
+=================================
+
+.. currentmodule:: mygrad.nnet.activations
+
+.. autofunction:: soft_sign
diff --git a/docs/source/generated/mygrad.nnet.activations.softmax.rst b/docs/source/generated/mygrad.nnet.activations.softmax.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.activations.softmax
+===============================
+
+.. currentmodule:: mygrad.nnet.activations
+
+.. autofunction:: softmax
diff --git a/docs/source/generated/mygrad.nnet.activations.tanh.rst b/docs/source/generated/mygrad.nnet.activations.tanh.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.activations.tanh
+============================
+
+.. currentmodule:: mygrad.nnet.activations
+
+.. autofunction:: tanh
diff --git a/docs/source/generated/mygrad.nnet.batchnorm.rst b/docs/source/generated/mygrad.nnet.batchnorm.rst
diff --git a/docs/source/generated/mygrad.nnet.conv_nd.rst b/docs/source/generated/mygrad.nnet.conv_nd.rst
diff --git a/docs/source/generated/mygrad.nnet.gru.rst b/docs/source/generated/mygrad.nnet.gru.rst
diff --git a/docs/source/generated/mygrad.nnet.hard_tanh.rst b/docs/source/generated/mygrad.nnet.hard_tanh.rst
diff --git a/docs/source/generated/mygrad.nnet.layers.batchnorm.rst b/docs/source/generated/mygrad.nnet.layers.batchnorm.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.layers.batchnorm
+============================
+
+.. currentmodule:: mygrad.nnet.layers
+
+.. autofunction:: batchnorm
diff --git a/docs/source/generated/mygrad.nnet.layers.conv_nd.rst b/docs/source/generated/mygrad.nnet.layers.conv_nd.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.layers.conv\_nd
+===========================
+
+.. currentmodule:: mygrad.nnet.layers
+
+.. autofunction:: conv_nd
diff --git a/docs/source/generated/mygrad.nnet.layers.gru.rst b/docs/source/generated/mygrad.nnet.layers.gru.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.layers.gru
+======================
+
+.. currentmodule:: mygrad.nnet.layers
+
+.. autofunction:: gru
diff --git a/docs/source/generated/mygrad.nnet.layers.max_pool.rst b/docs/source/generated/mygrad.nnet.layers.max_pool.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.layers.max\_pool
+============================
+
+.. currentmodule:: mygrad.nnet.layers
+
+.. autofunction:: max_pool
diff --git a/docs/source/generated/mygrad.nnet.logsoftmax.rst b/docs/source/generated/mygrad.nnet.logsoftmax.rst
diff --git a/docs/source/generated/mygrad.nnet.losses.margin_ranking_loss.rst b/docs/source/generated/mygrad.nnet.losses.margin_ranking_loss.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.losses.margin\_ranking\_loss
+========================================
+
+.. currentmodule:: mygrad.nnet.losses
+
+.. autofunction:: margin_ranking_loss
diff --git a/docs/source/generated/mygrad.nnet.losses.multiclass_hinge.rst b/docs/source/generated/mygrad.nnet.losses.multiclass_hinge.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.losses.multiclass\_hinge
+====================================
+
+.. currentmodule:: mygrad.nnet.losses
+
+.. autofunction:: multiclass_hinge
diff --git a/docs/source/generated/mygrad.nnet.losses.softmax_crossentropy.rst b/docs/source/generated/mygrad.nnet.losses.softmax_crossentropy.rst
@@ -0,0 +1,6 @@
+mygrad.nnet.losses.softmax\_crossentropy
+========================================
+
+.. currentmodule:: mygrad.nnet.losses
+
+.. autofunction:: softmax_crossentropy
diff --git a/docs/source/generated/mygrad.nnet.margin_ranking_loss.rst b/docs/source/generated/mygrad.nnet.margin_ranking_loss.rst
diff --git a/docs/source/generated/mygrad.nnet.max_pool.rst b/docs/source/generated/mygrad.nnet.max_pool.rst
diff --git a/docs/source/generated/mygrad.nnet.multiclass_hinge.rst b/docs/source/generated/mygrad.nnet.multiclass_hinge.rst
diff --git a/docs/source/generated/mygrad.nnet.relu.rst b/docs/source/generated/mygrad.nnet.relu.rst
diff --git a/docs/source/generated/mygrad.nnet.sigmoid.rst b/docs/source/generated/mygrad.nnet.sigmoid.rst
diff --git a/docs/source/generated/mygrad.nnet.softmax.rst b/docs/source/generated/mygrad.nnet.softmax.rst
diff --git a/docs/source/generated/mygrad.nnet.softmax_crossentropy.rst b/docs/source/generated/mygrad.nnet.softmax_crossentropy.rst
diff --git a/docs/source/generated/mygrad.nnet.tanh.rst b/docs/source/generated/mygrad.nnet.tanh.rst
diff --git a/docs/source/nnet.rst b/docs/source/nnet.rst
@@ -1,7 +1,7 @@
 Neural network operations (:mod:`mygrad.nnet`)
 **********************************************
 
-.. currentmodule:: mygrad.nnet
+.. currentmodule:: mygrad.nnet.layers
 
 
 Layer operations
@@ -14,6 +14,7 @@ Layer operations
    max_pool
    gru
 
+.. currentmodule:: mygrad.nnet.losses
 
 Losses
 ------
@@ -25,15 +26,23 @@ Losses
    margin_ranking_loss
 
 
+.. currentmodule:: mygrad.nnet.activations
+
 Activations
 -----------
 .. autosummary::
    :toctree: generated/
 
+
+   elu
+   glu
    hard_tanh
+   leaky_relu
    logsoftmax
+   selu
    sigmoid
    softmax
+   soft_sign
    relu
    tanh