Changeset c249f57

Timestamp:

Jan 23, 2019, 11:32:36 PM (6 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/crepe_org

Children:

51c0b61

Parents:

e75a48e

Message:

[ai] add some documentation to activation.h

File:

• src/ai/activation.h (modified) (1 diff)

src/ai/activation.h

@@ -23 +23 @@
 #define AUBIO_ACTIVATION_H
 
+/** \file
+
+  Activation functions.
+
+*/
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+/** Rectifier linear unit (ReLU)
+
+  \param t input tensor on which to compute the activation function (in-place)
+
+  Upon return, each value \f$x\f$ of the tensor \f$t\f$ will be set to
+  \f$max(0, x)\f$.
+
+*/
 void aubio_activation_relu(aubio_tensor_t *t);
+
+/** compute sigmoid activation
+
+  \param t input tensor on which to compute the activation function (in-place)
+
+  Upon return, each value \f$x\f$ of the tensor \f$t\f$ will be set to
+  \f$\frac{1}{1 + e^{-x}}\f$.
+
+*/
 void aubio_activation_sigmoid(aubio_tensor_t *t);