registry entry to register simple operators via functions. More...

#include <operator_util.h>

Collaboration diagram for mxnet::op::SimpleOpRegEntry:

Public Types
typedef SimpleOpRegEntry	TSelf
	declare self type More...

Public Member Functions
virtual TSelf &	set_symbol_op_name (char const *symbol_name)=0
	set a seperate name for symbol This must be called before set_function. Default: this is set to be same as the name of operator. More...

virtual TSelf &	set_enable_scalar (bool enable_scalar, SimpleOpScalarOption type_mask=kArrayBeforeScalar)=0
	set number of scalar arguments needed to be passed in env A function cannot have both kwargs and scalar arguments. Default: this is set to false More...

virtual TSelf &	set_enable_kwargs (bool enable_kwargs)=0
	set whether to enable kwargs A function cannot have both kwargs and scalar arguments. Default: this is set to false More...

virtual TSelf &	set_resource_request (const std::vector< ResourceRequest > &reqs)=0
	set resource request By default there is no resource request. The resource will be presented in both forward and backward. More...

virtual TSelf &	set_resource_request (ResourceRequest req)=0
	set resource request By default there is no resource request. The resource will be presented in both forward and backward. More...

virtual TSelf &	set_shape_function (SourceShapeFunction fshapeinfer)=0
	set source inference function. More...

virtual TSelf &	set_shape_function (UnaryShapeFunction fshapeinfer)=0
	set shape inference function. Default: out_shape = in_shape More...

virtual TSelf &	set_shape_function (BinaryShapeFunction fshapeinfer)=0
	set shape inference function to be the binary inference function Default: out_shape = lhs_shape, and lhs_shape must equal rhs_shape. More...

virtual TSelf &	set_function (int dev_mask, SourceFunction fsource, SimpleOpRegOption register_symbolic=kRegisterSymbolic)=0
	set function of the function to be fsource More...

virtual TSelf &	set_function (int dev_mask, UnaryFunction funary, SimpleOpInplaceOption inplace_in_out, SimpleOpRegOption register_symbolic=kRegisterSymbolic)=0
	set function of the function to be funary More...

virtual TSelf &	set_function (int dev_mask, BinaryFunction fbinary, SimpleOpInplaceOption inplace_lhs_out, SimpleOpRegOption register_symbolic=kRegisterSymbolic)=0
	set function of the function to be funary More...

virtual TSelf &	set_gradient (int dev_mask, UnaryGradFunctionT0 fgrad, SimpleOpInplaceOption inplace_out_in_grad)=0
	set gradient of the function of this function. More...

virtual TSelf &	set_gradient (int dev_mask, UnaryGradFunctionT1 fgrad, SimpleOpInplaceOption inplace_out_in_grad)=0
	set gradient of the function of this function. More...

virtual TSelf &	set_gradient (int dev_mask, UnaryGradFunctionT2 fgrad, SimpleOpInplaceOption inplace_out_in_grad)=0
	set gradient of the function of this function. More...

virtual TSelf &	set_gradient (int dev_mask, BinaryGradFunctionT0 fgrad, SimpleOpInplaceOption inplace_out_lhs_grad)=0
	set gradient of the function of this function. More...

virtual TSelf &	set_gradient (int dev_mask, BinaryGradFunctionT1 fgrad, SimpleOpInplaceOption inplace_out_lhs_grad)=0
	set gradient of the function of this function. More...

virtual TSelf &	describe (const std::string &description)=0
	Describe the function. More...

virtual TSelf &	add_arguments (const std::vector< dmlc::ParamFieldInfo > &args)=0
	Describe the function. More...

virtual	~SimpleOpRegEntry ()
	virtual destructor More...

Public Attributes
std::string	name
	name of the operator More...

Detailed Description

registry entry to register simple operators via functions.

Member Typedef Documentation

typedef SimpleOpRegEntry mxnet::op::SimpleOpRegEntry::TSelf

declare self type

Constructor & Destructor Documentation

virtual mxnet::op::SimpleOpRegEntry::~SimpleOpRegEntry ( )

inlinevirtual

virtual destructor

Member Function Documentation

virtual TSelf& mxnet::op::SimpleOpRegEntry::add_arguments ( const std::vector< dmlc::ParamFieldInfo > & args )

pure virtual

Describe the function.

Parameters

args	argument information. Add additional arguments to the function.

Returns: reference to self.

virtual TSelf& mxnet::op::SimpleOpRegEntry::describe ( const std::string & description )

pure virtual

Describe the function.

Parameters

description The description of the function.

Returns: reference to self.

virtual TSelf& mxnet::op::SimpleOpRegEntry::set_enable_kwargs ( bool enable_kwargs )

pure virtual

set whether to enable kwargs A function cannot have both kwargs and scalar arguments. Default: this is set to false

Parameters

enable_kwargs whether to enable kwargs

virtual TSelf& mxnet::op::SimpleOpRegEntry::set_enable_scalar	(	bool	enable_scalar,
		SimpleOpScalarOption	type_mask = `kArrayBeforeScalar`
	)

pure virtual

set number of scalar arguments needed to be passed in env A function cannot have both kwargs and scalar arguments. Default: this is set to false

Parameters

enable_scalar	whether to enable scalar argument
type_mask	the position of the scalar argument.

virtual TSelf& mxnet::op::SimpleOpRegEntry::set_function	(	int	dev_mask,
		SourceFunction	fsource,
		SimpleOpRegOption	register_symbolic = `kRegisterSymbolic`
	)

pure virtual

set function of the function to be fsource

Parameters

dev_mask	The device mask of the function can act on.
fsource	The unary function that peforms the operation.
register_symbolic	Whether register a symbolic operator as well.

virtual TSelf& mxnet::op::SimpleOpRegEntry::set_function	(	int	dev_mask,
		UnaryFunction	funary,
		SimpleOpInplaceOption	inplace_in_out,
		SimpleOpRegOption	register_symbolic = `kRegisterSymbolic`
	)

pure virtual

set function of the function to be funary

Parameters

dev_mask	The device mask of the function can act on.
funary	The unary function that peforms the operation.
inplace_in_out	Whether do inplace optimization on in and out.
register_symbolic	Whether register a symbolic operator as well.

virtual TSelf& mxnet::op::SimpleOpRegEntry::set_function	(	int	dev_mask,
		BinaryFunction	fbinary,
		SimpleOpInplaceOption	inplace_lhs_out,
		SimpleOpRegOption	register_symbolic = `kRegisterSymbolic`
	)

pure virtual

set function of the function to be funary

Parameters

dev_mask	The device mask of the function can act on.
fbinary	The binary function that peforms the operation.
inplace_lhs_out	Whether do inplace optimization on lhs and out.
register_symbolic	Whether register a symbolic operator as well.

virtual TSelf& mxnet::op::SimpleOpRegEntry::set_gradient	(	int	dev_mask,
		UnaryGradFunctionT0	fgrad,
		SimpleOpInplaceOption	inplace_out_in_grad
	)

pure virtual