Enumerations
enum	miopenIndexType_t { miopenIndexUint8 = 0 , miopenIndexUint16 = 1 , miopenIndexUint32 = 2 , miopenIndexUint64 = 3 }

enum	miopenPoolingMode_t { miopenPoolingMax = 0 , miopenPoolingAverage = 1 , miopenPoolingAverageInclusive = 2 }

enum	miopenPoolingWorkspaceIndexMode_t { miopenPoolingWorkspaceIndexMask = 0 , miopenPoolingWorkspaceIndexImage = 1 }

Functions
	MIOPEN_DECLARE_OBJECT (miopenPoolingDescriptor)
	Creates the miopenPoolingDescriptor_t type. More...

miopenStatus_t	miopenCreatePoolingDescriptor (miopenPoolingDescriptor_t *poolDesc)
	Creates a pooling layer descriptor. More...

miopenStatus_t	miopenSetPoolingIndexType (miopenPoolingDescriptor_t poolDesc, miopenIndexType_t index_type)
	Set index data type for pooling layer. The default indexing type is uint8_t. Users can set the index type to any of the miopenIndexType_t sizes; 8, 16, 32, or 64 bit unsigned integers. More...

miopenStatus_t	miopenGetPoolingIndexType (miopenPoolingDescriptor_t poolDesc, miopenIndexType_t *index_type)
	Get the index data type for pooling layer. The index type to any of the miopenIndexType_t sizes; 8, 16, 32, or 64 bit unsigned integers. More...

miopenStatus_t	miopenSetPoolingWorkSpaceIndexMode (miopenPoolingDescriptor_t poolDesc, miopenPoolingWorkspaceIndexMode_t workspace_index)
	Set workspace index mode for pooling layer. The default mode is miopenPoolingWorkSpaceIndexMask. More...

miopenStatus_t	miopenGetPoolingWorkSpaceIndexMode (miopenPoolingDescriptor_t poolDesc, miopenPoolingWorkspaceIndexMode_t *workspace_index)
	Get workspace index mode for pooling layer. More...

miopenStatus_t	miopenSet2dPoolingDescriptor (miopenPoolingDescriptor_t poolDesc, miopenPoolingMode_t mode, int windowHeight, int windowWidth, int pad_h, int pad_w, int stride_h, int stride_w)
	Sets a 2-D pooling layer descriptor details. More...

miopenStatus_t	miopenGet2dPoolingDescriptor (const miopenPoolingDescriptor_t poolDesc, miopenPoolingMode_t mode, int windowHeight, int windowWidth, int pad_h, int pad_w, int stride_h, int *stride_w)
	Gets a 2-D pooling layer descriptor details. More...

miopenStatus_t	miopenGetPoolingForwardOutputDim (const miopenPoolingDescriptor_t poolDesc, const miopenTensorDescriptor_t tensorDesc, int n, int c, int h, int w)
	Gets the shape of the output tensor for 2-D pooling. More...

miopenStatus_t	miopenSetNdPoolingDescriptor (miopenPoolingDescriptor_t poolDesc, const miopenPoolingMode_t mode, int nbDims, const int windowDimA, const int padA, const int *stridesA)
	Set details of a N-D pooling layer descriptor. More...

miopenStatus_t	miopenGetNdPoolingDescriptor (const miopenPoolingDescriptor_t poolDesc, int nbDimsRequested, miopenPoolingMode_t mode, int nbDims, int windowDimA, int padA, int *stridesA)
	Get details of a N-D pooling layer descriptor. More...

miopenStatus_t	miopenGetPoolingNdForwardOutputDim (const miopenPoolingDescriptor_t poolDesc, const miopenTensorDescriptor_t tensorDesc, int dims, int *tensorDimArr)
	Gets the shape of the output tensor for N-D pooling. More...

miopenStatus_t	miopenPoolingGetWorkSpaceSize (const miopenTensorDescriptor_t yDesc, size_t *workSpaceSize)
	Get the amount of GPU memory required for pooling. More...

miopenStatus_t	miopenPoolingGetWorkSpaceSizeV2 (const miopenPoolingDescriptor_t poolDesc, const miopenTensorDescriptor_t yDesc, size_t *workSpaceSize)
	Get the amount of GPU memory required for pooling. More...

miopenStatus_t	miopenPoolingForward (miopenHandle_t handle, const miopenPoolingDescriptor_t poolDesc, const void alpha, const miopenTensorDescriptor_t xDesc, const void x, const void beta, const miopenTensorDescriptor_t yDesc, void y, bool do_backward, void *workSpace, size_t workSpaceSize)
	Execute a forward pooling layer. More...

miopenStatus_t	miopenPoolingBackward (miopenHandle_t handle, const miopenPoolingDescriptor_t poolDesc, const void alpha, const miopenTensorDescriptor_t yDesc, const void y, const miopenTensorDescriptor_t dyDesc, const void dy, const miopenTensorDescriptor_t xDesc, const void x, const void beta, const miopenTensorDescriptor_t dxDesc, void dx, void *workSpace)
	Execute a backward pooling layer. More...

miopenStatus_t	miopenDestroyPoolingDescriptor (miopenPoolingDescriptor_t poolDesc)
	Destroys the pooling descriptor object. More...

Detailed Description

Enumeration Type Documentation

◆ miopenIndexType_t

enum miopenIndexType_t

MIOpen index datatypes.

Enumerator
miopenIndexUint8	8-bit unsigned
miopenIndexUint16	16-bit unsigned
miopenIndexUint32	32-bit unsigned
miopenIndexUint64	64-bit unsigned

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

◆ miopenPoolingMode_t

enum miopenPoolingMode_t

Pooling layer mode

Enumerator
miopenPoolingMax	Maximum pooling
miopenPoolingAverage	Average pooling
miopenPoolingAverageInclusive	Inclusive Average pooling

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

◆ miopenPoolingWorkspaceIndexMode_t

enum miopenPoolingWorkspaceIndexMode_t

Pooling layer workspace index mode. miopenPoolingWorkspaceIndexMask mode records indices indicating the max values' positions in the filter/mask. miopenPoolingWorkspaceIndexImage mode records indices indicating the max values' positions in the image.

Enumerator
miopenPoolingWorkspaceIndexMask	Use mask indices, 2D pooling only
miopenPoolingWorkspaceIndexImage	Use image indices

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

Function Documentation

◆ MIOPEN_DECLARE_OBJECT()

MIOPEN_DECLARE_OBJECT ( miopenPoolingDescriptor )

Creates the miopenPoolingDescriptor_t type.

Pooling descriptor is an object that allows the user to specify the dimension sizes of the pooling windows, paddings, strides, and pooling mode.

◆ miopenCreatePoolingDescriptor()

miopenStatus_t miopenCreatePoolingDescriptor ( miopenPoolingDescriptor_t * poolDesc )

Creates a pooling layer descriptor.

Parameters

poolDesc Pointer to a pooling layer descriptor (output)

Returns: miopenStatus_t

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

◆ miopenDestroyPoolingDescriptor()

miopenStatus_t miopenDestroyPoolingDescriptor ( miopenPoolingDescriptor_t poolDesc )

Destroys the pooling descriptor object.

Parameters

poolDesc Pooling tensor descriptor type (input)

Returns: miopenStatus_t

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

◆ miopenGet2dPoolingDescriptor()

miopenStatus_t miopenGet2dPoolingDescriptor	(	const miopenPoolingDescriptor_t	poolDesc,
		miopenPoolingMode_t *	mode,
		int *	windowHeight,
		int *	windowWidth,
		int *	pad_h,
		int *	pad_w,
		int *	stride_h,
		int *	stride_w
	)

Gets a 2-D pooling layer descriptor details.

Gets the window shape, padding, and stride for a previously created 2-D pooling descriptor.

Parameters

poolDesc	Pointer to a pooling layer descriptor (input)
mode	Pooling mode enum (output)
windowHeight	Input window height dimension (output)
windowWidth	Input window width dimension (output)
pad_h	Number of elements to pad height (output)
pad_w	Number of elements to pad width (output)
stride_h	Vertical stride (output)
stride_w	Horizontal stride (output)

Returns: miopenStatus_t

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

◆ miopenGetNdPoolingDescriptor()

miopenStatus_t miopenGetNdPoolingDescriptor	(	const miopenPoolingDescriptor_t	poolDesc,
		int	nbDimsRequested,
		miopenPoolingMode_t *	mode,
		int *	nbDims,
		int *	windowDimA,
		int *	padA,
		int *	stridesA
	)

Get details of a N-D pooling layer descriptor.

Get the window shape, padding, and stride for a previously created N-D pooling descriptor.

Parameters

poolDesc	Pointer to a pooling layer descriptor (input)
nbDimsRequested	Dimension of the expected pooling descriptor (input)
mode	Pooling mode enum (output)
nbDims	Actual dimension of the pooling descriptor (output)
windowDimA	Array of input window dimensions with length equal to or larger than dimsRequested (output)
padA	Array of number of elements to padding with length equal to or larger than dimsRequested (output)
stridesA	Array of stride parameter with length equal to or larger than dimsRequested (output)

Returns: miopenStatus_t

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

◆ miopenGetPoolingForwardOutputDim()

miopenStatus_t miopenGetPoolingForwardOutputDim	(	const miopenPoolingDescriptor_t	poolDesc,
		const miopenTensorDescriptor_t	tensorDesc,
		int *	n,
		int *	c,
		int *	h,
		int *	w
	)

Gets the shape of the output tensor for 2-D pooling.

Retrieve the tensor dimensions for the forward 2-D pooling. This call is required for the forward if the output dimensions are different than the input tensor dimensions.

Parameters

poolDesc	Pointer to a pooling layer descriptor (input)
tensorDesc	Input tensor descriptor (input)
n	Mini-batch dim (output)
c	Number of channels (output)
h	Heights of input map (output)
w	Width of input map (output)

Returns: miopenStatus_t

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

◆ miopenGetPoolingIndexType()

miopenStatus_t miopenGetPoolingIndexType	(	miopenPoolingDescriptor_t	poolDesc,
		miopenIndexType_t *	index_type
	)

Get the index data type for pooling layer. The index type to any of the miopenIndexType_t sizes; 8, 16, 32, or 64 bit unsigned integers.

Parameters

poolDesc	Pointer to a pooling layer descriptor (input)
index_type	Index type (output)

Returns: miopenStatus_t

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

◆ miopenGetPoolingNdForwardOutputDim()

miopenStatus_t miopenGetPoolingNdForwardOutputDim	(	const miopenPoolingDescriptor_t	poolDesc,
		const miopenTensorDescriptor_t	tensorDesc,
		int	dims,
		int *	tensorDimArr
	)

Gets the shape of the output tensor for N-D pooling.

Retrieve the tensor dimensions for the forward N-D pooling. This call is required for the forward if the output dimensions are different than the input tensor dimensions.

Parameters

poolDesc	Pointer to a pooling layer descriptor (input)
tensorDesc	Input tensor descriptor (input)
dims	Dimension of the pooling (input)
tensorDimArr	Array of tensor dimension (output)

Returns: miopenStatus_t

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

◆ miopenGetPoolingWorkSpaceIndexMode()

miopenStatus_t miopenGetPoolingWorkSpaceIndexMode	(	miopenPoolingDescriptor_t	poolDesc,
		miopenPoolingWorkspaceIndexMode_t *	workspace_index
	)

Get workspace index mode for pooling layer.

Parameters

poolDesc	Pointer to a pooling layer descriptor (input)
workspace_index	Workspace index mode (output)

Returns: miopenStatus_t

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

◆ miopenPoolingBackward()

miopenStatus_t miopenPoolingBackward	(	miopenHandle_t	handle,
		const miopenPoolingDescriptor_t	poolDesc,
		const void *	alpha,
		const miopenTensorDescriptor_t	yDesc,
		const void *	y,
		const miopenTensorDescriptor_t	dyDesc,
		const void *	dy,
		const miopenTensorDescriptor_t	xDesc,
		const void *	x,
		const void *	beta,
		const miopenTensorDescriptor_t	dxDesc,
		void *	dx,
		void *	workSpace
	)

Execute a backward pooling layer.

Runs backward pooling. miopenPoolingGetWorkSpaceSize() must be called before miopenPoolingBackward() to determine the amount of workSpace to be allocated.

Parameters

handle	MIOpen handle (input)
poolDesc	Descriptor for pooling layer (input)
alpha	Floating point scaling factor, allocated on the host (input)
yDesc	Tensor descriptor for output data tensor y (input)
y	Data tensor y (input)
dyDesc	Tensor descriptor for data input tensor dy (input)
dy	Data delta tensor dy (input)
xDesc	Tensor descriptor for output data tensor x (input)
x	Data tensor x (output)
beta	Floating point shift factor, allocated on the host (input)
dxDesc	Tensor descriptor for tensor dx (input)
dx	Weights delta tensor dx (output)
workSpace	Pointer to user allocated workspace (input)

Returns: miopenStatus_t

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

◆ miopenPoolingForward()

miopenStatus_t miopenPoolingForward	(	miopenHandle_t	handle,
		const miopenPoolingDescriptor_t	poolDesc,
		const void *	alpha,
		const miopenTensorDescriptor_t	xDesc,
		const void *	x,
		const void *	beta,
		const miopenTensorDescriptor_t	yDesc,
		void *	y,
		bool	do_backward,
		void *	workSpace,
		size_t	workSpaceSize
	)

Execute a forward pooling layer.

Runs forward pooling. miopenGetPoolingForwardOutputDim() should be called before miopenPoolingForward(). If the parameter do_backward == 0, then set workSpace = nullptr and workSpaceSize = 0. However, for back-propagation do_backwards must be set to 1 in miopenPoolingForward().

Parameters

handle	MIOpen handle (input)
poolDesc	Descriptor for pooling layer (input)
alpha	Floating point scaling factor, allocated on the host (input)
xDesc	Tensor descriptor for data input tensor x (input)
x	Data tensor x (input)
beta	Floating point shift factor, allocated on the host (input)
yDesc	Tensor descriptor for output data tensor y (input)
y	Data tensor y (output)
do_backward	Boolean to toggle save data in workspace for backwards pass (input)
workSpace	Pointer user allocated memory (input)
workSpaceSize	Size in bytes of the memory needed (input)

Returns: miopenStatus_t

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

◆ miopenPoolingGetWorkSpaceSize()

miopenStatus_t miopenPoolingGetWorkSpaceSize	(	const miopenTensorDescriptor_t	yDesc,
		size_t *	workSpaceSize
	)

Get the amount of GPU memory required for pooling.

Retrieves the amount of workspace in bytes require for pooling. This call is required to determine the amount of GPU memory needed for the backwards pooling algorithms. For max- pooling, an assumption is that index data type is uint8_t, therefore the returned workspace size will be based on this assumption even if the user sets the index type with miopenSetPoolingIndexType().

Parameters

yDesc	Descriptor for pooling layer (input)
workSpaceSize	Pointer to workSpaceSize (output)

Returns: miopenStatus_t

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

◆ miopenPoolingGetWorkSpaceSizeV2()

miopenStatus_t miopenPoolingGetWorkSpaceSizeV2	(	const miopenPoolingDescriptor_t	poolDesc,
		const miopenTensorDescriptor_t	yDesc,
		size_t *	workSpaceSize
	)

Get the amount of GPU memory required for pooling.

Retrieves the amount of workspace in bytes require for pooling. This call is required to determine the amount of GPU memory needed for the backwards pooling algorithms. For max- pooling, there is no assumption on index data type. As the user can set the index datatype size using miopenSetPoolingIndexType().

Parameters

poolDesc	Pointer to a pooling layer descriptor (input)
yDesc	Descriptor for pooling layer (input)
workSpaceSize	Pointer to workSpaceSize (output)

Returns: miopenStatus_t

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

◆ miopenSet2dPoolingDescriptor()

miopenStatus_t miopenSet2dPoolingDescriptor	(	miopenPoolingDescriptor_t	poolDesc,
		miopenPoolingMode_t	mode,
		int	windowHeight,
		int	windowWidth,
		int	pad_h,
		int	pad_w,
		int	stride_h,
		int	stride_w
	)

Sets a 2-D pooling layer descriptor details.

Sets the window shape, padding, and stride for a previously created 2-D pooling descriptor.

Parameters

poolDesc	Pointer to a pooling layer descriptor (output)
mode	Pooling mode enum (input)
windowHeight	Input window height dimension (input)
windowWidth	Input window width dimension (input)
pad_h	Number of elements to pad height (input)
pad_w	Number of elements to pad width (input)
stride_h	Vertical stride (input)
stride_w	Horizontal stride (input)

Returns: miopenStatus_t

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

◆ miopenSetNdPoolingDescriptor()

miopenStatus_t miopenSetNdPoolingDescriptor	(	miopenPoolingDescriptor_t	poolDesc,
		const miopenPoolingMode_t	mode,
		int	nbDims,
		const int *	windowDimA,
		const int *	padA,
		const int *	stridesA
	)

Set details of a N-D pooling layer descriptor.

Set the window shape, padding, and stride for a previously created N-D pooling descriptor.

Parameters

poolDesc	Pointer to a pooling layer descriptor (input/output)
mode	Pooling mode enum (input)
nbDims	Dimension of the pooling (input)
windowDimA	Array of input window dimensions with length equal to or larger than dimsRequested (input)
padA	Array of number of elements to padding with length equal to or larger than dimsRequested (input)
stridesA	Array of stride parameter with length equal to or larger than dimsRequested (input)

Returns: miopenStatus_t

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

◆ miopenSetPoolingIndexType()

miopenStatus_t miopenSetPoolingIndexType	(	miopenPoolingDescriptor_t	poolDesc,
		miopenIndexType_t	index_type
	)

Set index data type for pooling layer. The default indexing type is uint8_t. Users can set the index type to any of the miopenIndexType_t sizes; 8, 16, 32, or 64 bit unsigned integers.

Parameters

poolDesc	Pointer to a pooling layer descriptor (input)
index_type	Index type (input)

Returns: miopenStatus_t

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

◆ miopenSetPoolingWorkSpaceIndexMode()

miopenStatus_t miopenSetPoolingWorkSpaceIndexMode	(	miopenPoolingDescriptor_t	poolDesc,
		miopenPoolingWorkspaceIndexMode_t	workspace_index
	)

Set workspace index mode for pooling layer. The default mode is miopenPoolingWorkSpaceIndexMask.

Parameters

poolDesc	Pointer to a pooling layer descriptor (input/output)
workspace_index	Workspace index mode (input)

Returns: miopenStatus_t

Examples: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/develop/include/miopen/miopen.h.

Pooling

Pooling#

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ miopenIndexType_t

◆ miopenPoolingMode_t

◆ miopenPoolingWorkspaceIndexMode_t

Function Documentation

◆ MIOPEN_DECLARE_OBJECT()

◆ miopenCreatePoolingDescriptor()

◆ miopenDestroyPoolingDescriptor()

◆ miopenGet2dPoolingDescriptor()

◆ miopenGetNdPoolingDescriptor()

◆ miopenGetPoolingForwardOutputDim()

◆ miopenGetPoolingIndexType()

◆ miopenGetPoolingNdForwardOutputDim()

◆ miopenGetPoolingWorkSpaceIndexMode()

◆ miopenPoolingBackward()

◆ miopenPoolingForward()

◆ miopenPoolingGetWorkSpaceSize()

◆ miopenPoolingGetWorkSpaceSizeV2()

◆ miopenSet2dPoolingDescriptor()

◆ miopenSetNdPoolingDescriptor()

◆ miopenSetPoolingIndexType()

◆ miopenSetPoolingWorkSpaceIndexMode()