Add documentation for 2D Convolution Layer
Showing the changes to libavfilter (1 of 1 file). Show all
Unified · Split
| @@ -34,7 +34,34 @@ typedef struct ConvolutionalParams{ · 33 unmodified lines | ||
| 34 | 34 | float *biases; |
| 35 | 35 | } ConvolutionalParams; |
| 36 | 36 | |
| 37 | +/** | |
| 38 | + * @brief Load the 2D Convolution Layer. | |
| 39 | + * | |
| 40 | + * It assigns the 2D convolution layer with ConvolutionalParams | |
| 41 | + * after parsing from the model file context. | |
| 42 | + * | |
| 43 | + * @param layer pointer to the DNN layer instance | |
| 44 | + * @param model_file_context pointer to model file context | |
| 45 | + * @param file_size model file size to check if data is read | |
| 46 | + * correctly from the model file | |
| 47 | + * @param operands_num operand count of the whole model to | |
| 48 | + * check if data is read correctly from the model file | |
| 49 | + * @return number of bytes read from the model file | |
| 50 | + * @retval 0 if out of memory or an error occurs | |
| 51 | + */ | |
| 37 | 52 | int ff_dnn_load_layer_conv2d(Layer *layer, AVIOContext *model_file_context, int file_size, int operands_num); |
| 53 | + | |
| 54 | +/** | |
| 55 | + * @brief Execute the 2D Convolution Layer. | |
| 56 | + * | |
| 57 | + * @param operands all operands for the model | |
| 58 | + * @param input_operand_indexes input operand indexes for this layer | |
| 59 | + * @param output_operand_index output operand index for this layer | |
| 60 | + * @param parameters convolution parameters | |
| 61 | + * @param ctx pointer to Native model context for logging | |
| 62 | + * @retval 0 if the execution succeeds | |
| 63 | + * @retval DNN_ERROR if the execution fails | |
| 64 | + */ | |
| 38 | 65 | int ff_dnn_execute_layer_conv2d(DnnOperand *operands, const int32_t *input_operand_indexes, |
| 39 | 66 | int32_t output_operand_index, const void *parameters, NativeContext *ctx); |
| 40 | 67 | #endif |