Changeset 30cb440e for src

Timestamp:

Jan 29, 2019, 2:55:31 AM (6 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/crepe_org

Children:

382375d

Parents:

e2010b3

Message:

[dense] improve documentation

File:

• src/ai/dense.h (modified) (2 diffs)

src/ai/dense.h

@@ -24 +24 @@
 /** \file
 
- Fully connected dense layer.
+ Fully connected layer
 
 */
@@ -32 +32 @@
 #endif
 
+/** dense layer */
 typedef struct _aubio_dense_t aubio_dense_t;
 
+/** create a new dense layer
+
+  \param n_units    number of units
+
+  \return new dense layer
+
+*/
 aubio_dense_t *new_aubio_dense(uint_t n_units);
 
-void del_aubio_dense(aubio_dense_t *c);
+/** get output shape
 
+  \param c      ::aubio_dense_t layer
+  \param input  input tensor
+  \param shape  output shape
+
+  \return 0 on success, non-zero otherwise
+
+*/
 uint_t aubio_dense_get_output_shape(aubio_dense_t *c,
     aubio_tensor_t *input, uint_t *shape);
 
+/** get internal weights
+
+   \param c     dense layer
+
+   \return matrix of weights
+
+   This function should be called after ::aubio_dense_get_output_shape
+   to get a pointer to the internal weight matrix.
+
+*/
 fmat_t *aubio_dense_get_weights(aubio_dense_t *c);
 
+/** get internal biases
+
+   \param c     dense layer
+
+   \return vector of biases
+
+   This function should be called after ::aubio_dense_get_output_shape
+   to get a pointer to the internal biases.
+
+*/
 fvec_t *aubio_dense_get_bias(aubio_dense_t *c);
 
+/** compute forward pass
+
+  \param c          ::aubio_dense_t layer
+  \param input      input tensor
+  \param output     output tensor
+
+  This function computes the output of the dense layer given an input tensor.
+
+*/
 void aubio_dense_do(aubio_dense_t *c, aubio_tensor_t *input,
     aubio_tensor_t *output);
+
+/** destroy layer
+
+  \param c  layer to destroy
+
+*/
+void del_aubio_dense(aubio_dense_t *c);
 
 #ifdef __cplusplus