Sum

Enumerations | Functions

Sum

Enumerations
enum	miopenSumNanPropagation_t {   MIOPEN_SUM_NOT_PROPAGATE_NAN = 0 ,   MIOPEN_SUM_PROPAGATE_NAN = 1 }

Functions
miopenStatus_t	miopenGetSumWorkspaceSize (miopenHandle_t handle, const miopenTensorDescriptor_t xDesc, const int32_t dim, const miopenTensorDescriptor_t yDesc, size_t *sizeInBytes)
	Helper function to query the minimum workspace size required by the ReduceTensor call. More...
miopenStatus_t	miopenSumForward (miopenHandle_t handle, miopenSumNanPropagation_t nanPropagation, void *workspace, size_t workspaceSizeInBytes, const miopenTensorDescriptor_t xDesc, const void *x, const int32_t dim, const miopenTensorDescriptor_t yDesc, void *y)
	Execute a sum forward layer. More...

Detailed Description

Enumeration Type Documentation

◆ miopenSumNanPropagation_t

enum miopenSumNanPropagation_t

Nan numbers propagation modes for sum

Enumerator
MIOPEN_SUM_NOT_PROPAGATE_NAN	does not propagate Nan number
MIOPEN_SUM_PROPAGATE_NAN	propagate the Nan number by the Reduction operation

Examples

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/latest/include/miopen/miopen.h.

Function Documentation

◆ miopenGetSumWorkspaceSize()

miopenStatus_t miopenGetSumWorkspaceSize	(	miopenHandle_t	handle,
		const miopenTensorDescriptor_t	xDesc,
		const int32_t	dim,
		const miopenTensorDescriptor_t	yDesc,
		size_t *	sizeInBytes
	)

Helper function to query the minimum workspace size required by the ReduceTensor call.

Parameters

handle	MIOpen Handle (input)
xDesc	Tensor descriptor for data input tensor x (input)
dim	Dimensions to sum. (input)
yDesc	Tensor descriptor for output data tensor y (input)
sizeInBytes	Pointer to data to return the minimum workspace size

Returns

miopenStatus_t

Examples

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/latest/include/miopen/miopen.h.

◆ miopenSumForward()

miopenStatus_t miopenSumForward	(	miopenHandle_t	handle,
		miopenSumNanPropagation_t	nanPropagation,
		void *	workspace,
		size_t	workspaceSizeInBytes,
		const miopenTensorDescriptor_t	xDesc,
		const void *	x,
		const int32_t	dim,
		const miopenTensorDescriptor_t	yDesc,
		void *	y
	)

Execute a sum forward layer.

Parameters

handle	MIOpen handle (input)
nanPropagation	Nan number propagation mode (input)
workspace	Address of the allocated workspace data (input)
workspaceSizeInBytes	Size in bytes of the allocated workspace data (input)
xDesc	Tensor descriptor for data input tensor x (input)
x	Data tensor x (input)
dim	Dimensions to sum. (input)
yDesc	Tensor descriptor for output data tensor y (input)
y	Data tensor y (output)

Returns

miopenStatus_t

Examples

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-miopen/checkouts/latest/include/miopen/miopen.h.