Changeset 8429515


Ignore:
Timestamp:
Dec 29, 2021, 5:52:01 PM (3 weeks ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/crepe
Children:
6627c87
Parents:
514a87c
git-author:
Paul Brossier <piem@piem.org> (01/29/19 02:59:06)
git-committer:
Paul Brossier <piem@piem.org> (12/29/21 17:52:01)
Message:

[maxpool2d] add basic documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/ai/maxpool2d.h

    r514a87c r8429515  
    2222#define AUBIO_MAXPOOL2D_H
    2323
     24/** \file
     25
     26  Max pooling layer (2D)
     27
     28*/
     29
    2430#ifdef __cplusplus
    2531extern "C" {
    2632#endif
    2733
     34/** maxpool2d layer */
    2835typedef struct _aubio_maxpool2d_t aubio_maxpool2d_t;
    2936
     37/** create a new maxpool2d layer
     38
     39  \param pool_size  size of the pooling windows
     40
     41  \return new ::aubio_maxpool2d_t layer
     42
     43*/
    3044aubio_maxpool2d_t *new_aubio_maxpool2d(uint_t pool_size[2]);
    3145
    32 void aubio_maxpool2d_do(aubio_maxpool2d_t *t,
    33         aubio_tensor_t *input_tensor,
    34         aubio_tensor_t *activations);
     46/** get output shape
    3547
    36 uint_t aubio_maxpool2d_set_weights(aubio_maxpool2d_t *t,
    37         aubio_tensor_t *kernels);
     48  \param t      layer
     49  \param input  input tensor
     50  \param shape  output shape
    3851
    39 aubio_tensor_t *aubio_maxpool2d_get_weigths(aubio_maxpool2d_t *t);
     52  \return 0 on success, non-zero otherwise
    4053
     54*/
    4155uint_t aubio_maxpool2d_get_output_shape(aubio_maxpool2d_t *t,
    4256        aubio_tensor_t *input, uint_t *shape);
    4357
     58/** compute layer output
     59
     60  \param    t               layer
     61  \param    input_tensor    input tensor
     62  \param    output_tensor   output tensor
     63
     64*/
     65void aubio_maxpool2d_do(aubio_maxpool2d_t *t,
     66        aubio_tensor_t *input_tensor,
     67        aubio_tensor_t *output_tensor);
     68
     69/** destroy layer
     70
     71  \param t      layer to destroy
     72
     73*/
    4474void del_aubio_maxpool2d(aubio_maxpool2d_t *t);
    4575
Note: See TracChangeset for help on using the changeset viewer.