diff mbox series

[FFmpeg-devel,V5,5/5] lavfi/dnn_backend_native_layer_mathunary.h: Documentation

Message ID 20210514071104.23670-4-shubhanshu.e01@gmail.com
State Accepted
Commit 11b489d592553da3d5e61a83482ee188005b0da9
Headers show
Series Untitled series #3970
Related show

Commit Message

Shubhanshu Saxena May 14, 2021, 7:11 a.m. UTC
Add documentation for Unary Math Layer

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

Comments

Guo, Yejun May 17, 2021, 1:48 a.m. UTC | #1
> -----Original Message-----
> From: ffmpeg-devel <ffmpeg-devel-bounces@ffmpeg.org> On Behalf Of
> Shubhanshu Saxena
> Sent: 2021年5月14日 15:11
> To: ffmpeg-devel@ffmpeg.org
> Cc: Shubhanshu Saxena <shubhanshu.e01@gmail.com>
> Subject: [FFmpeg-devel] [PATCH V5 5/5]
> lavfi/dnn_backend_native_layer_mathunary.h: Documentation
> 
> Add documentation for Unary Math Layer
> 
> Signed-off-by: Shubhanshu Saxena <shubhanshu.e01@gmail.com>
> ---
>  .../dnn/dnn_backend_native_layer_mathunary.h  | 30
> +++++++++++++++++++
>  1 file changed, 30 insertions(+)
> 
> diff --git a/libavfilter/dnn/dnn_backend_native_layer_mathunary.h
> b/libavfilter/dnn/dnn_backend_native_layer_mathunary.h
> index 151a73200a..ed79947896 100644
> --- a/libavfilter/dnn/dnn_backend_native_layer_mathunary.h
> +++ b/libavfilter/dnn/dnn_backend_native_layer_mathunary.h
> @@ -54,7 +54,37 @@ typedef struct DnnLayerMathUnaryParams{
>      DNNMathUnaryOperation un_op;
>  } DnnLayerMathUnaryParams;
> 
> +/**
> + * @brief Load the Unary Math Layer.
> + *
> + * It assigns the unary math layer with DnnLayerMathUnaryParams
> + * 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 out of memory or an error occurs
> + */
>  int ff_dnn_load_layer_math_unary(Layer *layer, AVIOContext
> *model_file_context, int file_size, int operands_num);
> +
> +/**
> + * @brief Execute the Unary Math Layer.
> + *
> + * It applies the unary operator parsed while
> + * loading to the given input operands.
> + *
> + * @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 unary math layer 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_math_unary(DnnOperand *operands, const
> int32_t *input_operand_indexes,
>                                      int32_t output_operand_index,
> const void *parameters, NativeContext *ctx);
> 
LGTM, will push soon, thanks.
diff mbox series

Patch

diff --git a/libavfilter/dnn/dnn_backend_native_layer_mathunary.h b/libavfilter/dnn/dnn_backend_native_layer_mathunary.h
index 151a73200a..ed79947896 100644
--- a/libavfilter/dnn/dnn_backend_native_layer_mathunary.h
+++ b/libavfilter/dnn/dnn_backend_native_layer_mathunary.h
@@ -54,7 +54,37 @@  typedef struct DnnLayerMathUnaryParams{
     DNNMathUnaryOperation un_op;
 } DnnLayerMathUnaryParams;
 
+/**
+ * @brief Load the Unary Math Layer.
+ *
+ * It assigns the unary math layer with DnnLayerMathUnaryParams
+ * 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 out of memory or an error occurs
+ */
 int ff_dnn_load_layer_math_unary(Layer *layer, AVIOContext *model_file_context, int file_size, int operands_num);
+
+/**
+ * @brief Execute the Unary Math Layer.
+ *
+ * It applies the unary operator parsed while
+ * loading to the given input operands.
+ *
+ * @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 unary math layer 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_math_unary(DnnOperand *operands, const int32_t *input_operand_indexes,
                                     int32_t output_operand_index, const void *parameters, NativeContext *ctx);