Pooling Functions

Content
	GetBufferSizePooling

Functions
arm_cmsis_nn_status	arm_max_pool_f32 (const cmsis_nn_context *ctx, const cmsis_nn_pool_params_f32 *pool_params, const cmsis_nn_dims *input_dims, const float32_t *src, const cmsis_nn_dims *filter_dims, const cmsis_nn_dims *output_dims, float32_t *dst)
	Max pooling.
arm_cmsis_nn_status	arm_avg_pool_f32 (const cmsis_nn_context *ctx, const cmsis_nn_pool_params_f32 *pool_params, const cmsis_nn_dims *input_dims, const float32_t *src, const cmsis_nn_dims *filter_dims, const cmsis_nn_dims *output_dims, float32_t *dst)
	Average pooling.
arm_cmsis_nn_status	arm_max_pool_f16 (const cmsis_nn_context *ctx, const cmsis_nn_pool_params_f16 *pool_params, const cmsis_nn_dims *input_dims, const float16_t *src, const cmsis_nn_dims *filter_dims, const cmsis_nn_dims *output_dims, float16_t *dst)
	Max pooling.
arm_cmsis_nn_status	arm_avg_pool_f16 (const cmsis_nn_context *ctx, const cmsis_nn_pool_params_f16 *pool_params, const cmsis_nn_dims *input_dims, const float16_t *src, const cmsis_nn_dims *filter_dims, const cmsis_nn_dims *output_dims, float16_t *dst)
	Average pooling.
arm_cmsis_nn_status	arm_avg_pool_nhwc_f16 (const cmsis_nn_context *ctx, const cmsis_nn_pool_params_f16 *pool_params, const cmsis_nn_dims *input_dims, const float16_t *src, const cmsis_nn_dims *filter_dims, const cmsis_nn_dims *output_dims, float16_t *dst)
arm_cmsis_nn_status	arm_avg_pool_nhwc_f32 (const cmsis_nn_context *ctx, const cmsis_nn_pool_params_f32 *pool_params, const cmsis_nn_dims *input_dims, const float32_t *src, const cmsis_nn_dims *filter_dims, const cmsis_nn_dims *output_dims, float32_t *dst)
arm_cmsis_nn_status	arm_avgpool_s16 (const cmsis_nn_context *ctx, const cmsis_nn_pool_params *pool_params, const cmsis_nn_dims *input_dims, const int16_t *src, const cmsis_nn_dims *filter_dims, const cmsis_nn_dims *output_dims, int16_t *dst)
	s16 average pooling function.
arm_cmsis_nn_status	arm_avgpool_s8 (const cmsis_nn_context *ctx, const cmsis_nn_pool_params *pool_params, const cmsis_nn_dims *input_dims, const int8_t *src, const cmsis_nn_dims *filter_dims, const cmsis_nn_dims *output_dims, int8_t *dst)
	s8 average pooling function.
arm_cmsis_nn_status	arm_max_pool_nhwc_f16 (const cmsis_nn_context *ctx, const cmsis_nn_pool_params_f16 *pool_params, const cmsis_nn_dims *input_dims, const float16_t *src, const cmsis_nn_dims *filter_dims, const cmsis_nn_dims *output_dims, float16_t *dst)
arm_cmsis_nn_status	arm_max_pool_s16 (const cmsis_nn_context *ctx, const cmsis_nn_pool_params *pool_params, const cmsis_nn_dims *input_dims, const int16_t *src, const cmsis_nn_dims *filter_dims, const cmsis_nn_dims *output_dims, int16_t *dst)
	s16 max pooling function.
arm_cmsis_nn_status	arm_max_pool_s8 (const cmsis_nn_context *ctx, const cmsis_nn_pool_params *pool_params, const cmsis_nn_dims *input_dims, const int8_t *src, const cmsis_nn_dims *filter_dims, const cmsis_nn_dims *output_dims, int8_t *dst)
	s8 max pooling function.

Description

Perform max and average pooling operations

Function Documentation

arm_avg_pool_f16()

arm_cmsis_nn_status arm_avg_pool_f16	(	const cmsis_nn_context *	ctx,
		const cmsis_nn_pool_params_f16 *	pool_params,
		const cmsis_nn_dims *	input_dims,
		const float16_t *	src,
		const cmsis_nn_dims *	filter_dims,
		const cmsis_nn_dims *	output_dims,
		float16_t *	dst
	)

Average pooling.

Parameters

[in,out]	ctx	Function context that may hold a temporary scratch buffer.
[in]	pool_params	Pooling parameters (stride, padding and activation clamp).
[in]	input_dims	Input tensor dimensions.
[in]	src	Pointer to the input tensor data.
[in]	filter_dims	Pooling kernel dimensions.
[in]	output_dims	Output tensor dimensions.
[out]	dst	Pointer to the output tensor data.

Returns

ARM_CMSIS_NN_SUCCESS on success or ARM_CMSIS_NN_ARG_ERROR on invalid arguments.

arm_avg_pool_f32()

arm_cmsis_nn_status arm_avg_pool_f32	(	const cmsis_nn_context *	ctx,
		const cmsis_nn_pool_params_f32 *	pool_params,
		const cmsis_nn_dims *	input_dims,
		const float32_t *	src,
		const cmsis_nn_dims *	filter_dims,
		const cmsis_nn_dims *	output_dims,
		float32_t *	dst
	)

Average pooling.

Parameters

[in,out]	ctx	Function context that may hold a temporary scratch buffer.
[in]	pool_params	Pooling parameters (stride, padding and activation clamp).
[in]	input_dims	Input tensor dimensions.
[in]	src	Pointer to the input tensor data.
[in]	filter_dims	Pooling kernel dimensions.
[in]	output_dims	Output tensor dimensions.
[out]	dst	Pointer to the output tensor data.

Returns

ARM_CMSIS_NN_SUCCESS on success or ARM_CMSIS_NN_ARG_ERROR on invalid arguments.

arm_avg_pool_nhwc_f16()

arm_cmsis_nn_status arm_avg_pool_nhwc_f16	(	const cmsis_nn_context *	ctx,
		const cmsis_nn_pool_params_f16 *	pool_params,
		const cmsis_nn_dims *	input_dims,
		const float16_t *	src,
		const cmsis_nn_dims *	filter_dims,
		const cmsis_nn_dims *	output_dims,
		float16_t *	dst
	)

arm_avg_pool_nhwc_f32()

arm_cmsis_nn_status arm_avg_pool_nhwc_f32	(	const cmsis_nn_context *	ctx,
		const cmsis_nn_pool_params_f32 *	pool_params,
		const cmsis_nn_dims *	input_dims,
		const float32_t *	src,
		const cmsis_nn_dims *	filter_dims,
		const cmsis_nn_dims *	output_dims,
		float32_t *	dst
	)

arm_avgpool_s16()

arm_cmsis_nn_status arm_avgpool_s16	(	const cmsis_nn_context *	ctx,
		const cmsis_nn_pool_params *	pool_params,
		const cmsis_nn_dims *	input_dims,
		const int16_t *	input_data,
		const cmsis_nn_dims *	filter_dims,
		const cmsis_nn_dims *	output_dims,
		int16_t *	output_data
	)

s16 average pooling function.

Parameters

[in,out]	ctx	Function context (e.g. temporary buffer). Check the function definition file to see if an additional buffer is required. Optional function {API}_get_buffer_size() provides the buffer size if an additional buffer is required. The caller is expected to clear the buffer, if applicable, for security reasons.
[in]	pool_params	Pooling parameters
[in]	input_dims	Input (activation) tensor dimensions. Format: [H, W, C_IN]
[in]	input_data	Input (activation) data pointer. Data type: int16
[in]	filter_dims	Filter tensor dimensions. Format: [H, W] Argument N and C are not used.
[in]	output_dims	Output tensor dimensions. Format: [H, W, C_OUT] Argument N is not used. C_OUT equals C_IN.
[in,out]	output_data	Output data pointer. Data type: int16

Returns

The function returns ARM_CMSIS_NN_SUCCESS - Successful operation ARM_CMSIS_NN_ARG_ERROR - In case of invalid arguments

• Supported Framework: TensorFlow Lite

arm_avgpool_s8()

arm_cmsis_nn_status arm_avgpool_s8	(	const cmsis_nn_context *	ctx,
		const cmsis_nn_pool_params *	pool_params,
		const cmsis_nn_dims *	input_dims,
		const int8_t *	input_data,
		const cmsis_nn_dims *	filter_dims,
		const cmsis_nn_dims *	output_dims,
		int8_t *	output_data
	)

s8 average pooling function.

Parameters

[in,out]	ctx	Function context (e.g. temporary buffer). Check the function definition file to see if an additional buffer is required. Optional function {API}_get_buffer_size() provides the buffer size if an additional buffer is required. The caller is expected to clear the buffer, if applicable, for security reasons.
[in]	pool_params	Pooling parameters
[in]	input_dims	Input (activation) tensor dimensions. Format: [H, W, C_IN]
[in]	input_data	Input (activation) data pointer. Data type: int8
[in]	filter_dims	Filter tensor dimensions. Format: [H, W] Argument N and C are not used.
[in]	output_dims	Output tensor dimensions. Format: [H, W, C_OUT] Argument N is not used. C_OUT equals C_IN.
[in,out]	output_data	Output data pointer. Data type: int8

Returns

The function returns either ARM_CMSIS_NN_ARG_ERROR if argument constraints fail. or, ARM_CMSIS_NN_SUCCESS on successful completion.

• Supported Framework: TensorFlow Lite

arm_max_pool_f16()

arm_cmsis_nn_status arm_max_pool_f16	(	const cmsis_nn_context *	ctx,
		const cmsis_nn_pool_params_f16 *	pool_params,
		const cmsis_nn_dims *	input_dims,
		const float16_t *	src,
		const cmsis_nn_dims *	filter_dims,
		const cmsis_nn_dims *	output_dims,
		float16_t *	dst
	)

Max pooling.

Parameters

[in,out]	ctx	Function context that may hold a temporary scratch buffer.
[in]	pool_params	Pooling parameters (stride, padding and activation clamp).
[in]	input_dims	Input tensor dimensions.
[in]	src	Pointer to the input tensor data.
[in]	filter_dims	Pooling kernel dimensions.
[in]	output_dims	Output tensor dimensions.
[out]	dst	Pointer to the output tensor data.

Returns

ARM_CMSIS_NN_SUCCESS on success or ARM_CMSIS_NN_ARG_ERROR on invalid arguments.

arm_max_pool_f32()

arm_cmsis_nn_status arm_max_pool_f32	(	const cmsis_nn_context *	ctx,
		const cmsis_nn_pool_params_f32 *	pool_params,
		const cmsis_nn_dims *	input_dims,
		const float32_t *	src,
		const cmsis_nn_dims *	filter_dims,
		const cmsis_nn_dims *	output_dims,
		float32_t *	dst
	)

Max pooling.

Parameters

[in,out]	ctx	Function context that may hold a temporary scratch buffer.
[in]	pool_params	Pooling parameters (stride, padding and activation clamp).
[in]	input_dims	Input tensor dimensions.
[in]	src	Pointer to the input tensor data.
[in]	filter_dims	Pooling kernel dimensions.
[in]	output_dims	Output tensor dimensions.
[out]	dst	Pointer to the output tensor data.

Returns

ARM_CMSIS_NN_SUCCESS on success or ARM_CMSIS_NN_ARG_ERROR on invalid arguments.

arm_max_pool_nhwc_f16()

arm_cmsis_nn_status arm_max_pool_nhwc_f16	(	const cmsis_nn_context *	ctx,
		const cmsis_nn_pool_params_f16 *	pool_params,
		const cmsis_nn_dims *	input_dims,
		const float16_t *	src,
		const cmsis_nn_dims *	filter_dims,
		const cmsis_nn_dims *	output_dims,
		float16_t *	dst
	)

arm_max_pool_s16()

arm_cmsis_nn_status arm_max_pool_s16	(	const cmsis_nn_context *	ctx,
		const cmsis_nn_pool_params *	pool_params,
		const cmsis_nn_dims *	input_dims,
		const int16_t *	src,
		const cmsis_nn_dims *	filter_dims,
		const cmsis_nn_dims *	output_dims,
		int16_t *	dst
	)

s16 max pooling function.

Parameters

[in,out]	ctx	Function context (e.g. temporary buffer). Check the function definition file to see if an additional buffer is required. Optional function {API}_get_buffer_size() provides the buffer size if an additional buffer is required. The caller is expected to clear the buffer, if applicable, for security reasons.
[in]	pool_params	Pooling parameters
[in]	input_dims	Input (activation) tensor dimensions. Format: [H, W, C_IN]
[in]	src	Input (activation) data pointer. The input tensor must not overlap with the output tensor. Data type: int16
[in]	filter_dims	Filter tensor dimensions. Format: [H, W] Argument N and C are not used.
[in]	output_dims	Output tensor dimensions. Format: [H, W, C_OUT] Argument N is not used. C_OUT equals C_IN.
[in,out]	dst	Output data pointer. Data type: int16

Returns

The function returns either ARM_CMSIS_NN_ARG_ERROR if argument constraints fail. or, ARM_CMSIS_NN_SUCCESS on successful completion.

• Supported Framework: TensorFlow Lite

arm_max_pool_s8()

arm_cmsis_nn_status arm_max_pool_s8	(	const cmsis_nn_context *	ctx,
		const cmsis_nn_pool_params *	pool_params,
		const cmsis_nn_dims *	input_dims,
		const int8_t *	input_data,
		const cmsis_nn_dims *	filter_dims,
		const cmsis_nn_dims *	output_dims,
		int8_t *	output_data
	)

s8 max pooling function.

Parameters

[in,out]	ctx	Function context (e.g. temporary buffer). Check the function definition file to see if an additional buffer is required. Optional function {API}_get_buffer_size() provides the buffer size if an additional buffer is required. The caller is expected to clear the buffer, if applicable, for security reasons.
[in]	pool_params	Pooling parameters
[in]	input_dims	Input (activation) tensor dimensions. Format: [H, W, C_IN]
[in]	input_data	Input (activation) data pointer. The input tensor must not overlap with the output tensor. Data type: int8
[in]	filter_dims	Filter tensor dimensions. Format: [H, W] Argument N and C are not used.
[in]	output_dims	Output tensor dimensions. Format: [H, W, C_OUT] Argument N is not used. C_OUT equals C_IN.
[in,out]	output_data	Output data pointer. Data type: int8

Returns

The function returns either ARM_CMSIS_NN_ARG_ERROR if argument constraints fail. or, ARM_CMSIS_NN_SUCCESS on successful completion.

• Supported Framework: TensorFlow Lite