diff mbox series

[FFmpeg-devel,V4,2/5] lavfi/dnn_backend_native_layer_conv2d.h: Documentation

Message ID 20210513070423.14234-2-shubhanshu.e01@gmail.com
State Superseded
Headers show
Series [FFmpeg-devel,V4,1/5] lavfi/dnn_backend_native_layer_avgpool.h: Documentation
Related show

Checks

Context Check Description
andriy/x86_make success Make finished
andriy/x86_make_fate success Make fate finished
andriy/PPC64_make success Make finished
andriy/PPC64_make_fate success Make fate finished

Commit Message

Shubhanshu Saxena May 13, 2021, 7:04 a.m. UTC
Add documentation for 2D Convolution Layer

Signed-off-by: Shubhanshu Saxena <shubhanshu.e01@gmail.com>
---
 .../dnn/dnn_backend_native_layer_conv2d.h     | 27 +++++++++++++++++++
 1 file changed, 27 insertions(+)

Comments

Guo, Yejun May 14, 2021, 1:53 a.m. UTC | #1
> -----Original Message-----
> From: ffmpeg-devel <ffmpeg-devel-bounces@ffmpeg.org> On Behalf Of
> Shubhanshu Saxena
> Sent: 2021年5月13日 15:04
> To: ffmpeg-devel@ffmpeg.org
> Cc: Shubhanshu Saxena <shubhanshu.e01@gmail.com>
> Subject: [FFmpeg-devel] [PATCH V4 2/5]
> lavfi/dnn_backend_native_layer_conv2d.h: Documentation
> 
> Add documentation for 2D Convolution Layer
> 
> Signed-off-by: Shubhanshu Saxena <shubhanshu.e01@gmail.com>
> ---
>  .../dnn/dnn_backend_native_layer_conv2d.h     | 27
> +++++++++++++++++++
>  1 file changed, 27 insertions(+)
> 
> diff --git a/libavfilter/dnn/dnn_backend_native_layer_conv2d.h
> b/libavfilter/dnn/dnn_backend_native_layer_conv2d.h
> index 03ca795c61..f951f8d80e 100644
> --- a/libavfilter/dnn/dnn_backend_native_layer_conv2d.h
> +++ b/libavfilter/dnn/dnn_backend_native_layer_conv2d.h
> @@ -34,7 +34,34 @@ typedef struct ConvolutionalParams{
>      float *biases;
>  } ConvolutionalParams;
> 
> +/**
> + * @brief Load the 2D Convolution Layer.
> + *
> + * It assigns the 2D convolution layer with ConvolutionalParams
> + * after parsing from the model file context.
> + *
> + * @param layer pointer to the DNN layer instance
> + * @param model_file_context pointer to model file context
> + * @param file_size model file size to check if data is read
> + * correctly from the model file
> + * @param operands_num operand count of the whole model to
> + * check if data is read correctly from the model file
> + * @return number of bytes read from the model file
> + * @retval 0 if an error occurs or out of memory
> + */
>  int ff_dnn_load_layer_conv2d(Layer *layer, AVIOContext
> *model_file_context, int file_size, int operands_num);
> +
> +/**
> + * @brief Execute the 2D Convolution Layer.
> + *
> + * @param operands all operands for the model
> + * @param input_operand_indexes input operand indexes for this layer
> + * @param output_operand_index output operand index for this layer
> + * @param parameters average pooling parameters

typo for 'average pooling parameters' in patch 2 to patch 5.

will push patch 1 soon.
Shubhanshu Saxena May 14, 2021, 7:18 a.m. UTC | #2
On Fri, May 14, 2021 at 7:23 AM Guo, Yejun <yejun.guo@intel.com> wrote:

>
> typo for 'average pooling parameters' in patch 2 to patch 5.
>
> will push patch 1 soon.
>
> Corrected
diff mbox series

Patch

diff --git a/libavfilter/dnn/dnn_backend_native_layer_conv2d.h b/libavfilter/dnn/dnn_backend_native_layer_conv2d.h
index 03ca795c61..f951f8d80e 100644
--- a/libavfilter/dnn/dnn_backend_native_layer_conv2d.h
+++ b/libavfilter/dnn/dnn_backend_native_layer_conv2d.h
@@ -34,7 +34,34 @@  typedef struct ConvolutionalParams{
     float *biases;
 } ConvolutionalParams;
 
+/**
+ * @brief Load the 2D Convolution Layer.
+ *
+ * It assigns the 2D convolution layer with ConvolutionalParams
+ * after parsing from the model file context.
+ *
+ * @param layer pointer to the DNN layer instance
+ * @param model_file_context pointer to model file context
+ * @param file_size model file size to check if data is read
+ * correctly from the model file
+ * @param operands_num operand count of the whole model to
+ * check if data is read correctly from the model file
+ * @return number of bytes read from the model file
+ * @retval 0 if an error occurs or out of memory
+ */
 int ff_dnn_load_layer_conv2d(Layer *layer, AVIOContext *model_file_context, int file_size, int operands_num);
+
+/**
+ * @brief Execute the 2D Convolution Layer.
+ *
+ * @param operands all operands for the model
+ * @param input_operand_indexes input operand indexes for this layer
+ * @param output_operand_index output operand index for this layer
+ * @param parameters average pooling parameters
+ * @param ctx pointer to Native model context for logging
+ * @retval 0 if the execution succeeds
+ * @retval DNN_ERROR if the execution fails
+ */
 int ff_dnn_execute_layer_conv2d(DnnOperand *operands, const int32_t *input_operand_indexes,
                                 int32_t output_operand_index, const void *parameters, NativeContext *ctx);
 #endif