Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed
  • src/ai/activation.h

    re75a48e rc249f57  
    2323#define AUBIO_ACTIVATION_H
    2424
     25/** \file
     26
     27  Activation functions.
     28
     29*/
     30
    2531#ifdef __cplusplus
    2632extern "C" {
    2733#endif
    2834
     35/** Rectifier linear unit (ReLU)
     36
     37  \param t input tensor on which to compute the activation function (in-place)
     38
     39  Upon return, each value \f$x\f$ of the tensor \f$t\f$ will be set to
     40  \f$max(0, x)\f$.
     41
     42*/
    2943void aubio_activation_relu(aubio_tensor_t *t);
     44
     45/** compute sigmoid activation
     46
     47  \param t input tensor on which to compute the activation function (in-place)
     48
     49  Upon return, each value \f$x\f$ of the tensor \f$t\f$ will be set to
     50  \f$\frac{1}{1 + e^{-x}}\f$.
     51
     52*/
    3053void aubio_activation_sigmoid(aubio_tensor_t *t);
    3154
Note: See TracChangeset for help on using the changeset viewer.