Specifies the parameters for the PoolingLayer. More...

Inheritance diagram for MyCaffe.param.PoolingParameter:

Public Types
enum	PoolingReshapeAlgorithm { DEFAULT , CAFFE , ONNX }
	Defines the pooling reshape algorithm to use. More...

enum	PoolingMethod { MAX = 0 , AVE = 1 , STOCHASTIC = 2 }
	Defines the pooling method. More...

Public Types inherited from MyCaffe.param.EngineParameter
enum	Engine { DEFAULT = 0 , CAFFE = 1 , CUDNN = 2 }
	Defines the type of engine to use. More...

Public Types inherited from MyCaffe.param.LayerParameterBase
enum	LABEL_TYPE { NONE , SINGLE , MULTIPLE , ONLY_ONE }
	Defines the label type. More...

Public Member Functions
	PoolingParameter ()
	Constructor for the parameter. More...

string	useCaffeReason ()
	Returns the reason that Caffe version was used instead of NVIDIA's cuDnn. More...

bool	useCudnn ()
	Queries whether or not to use NVIDIA's cuDnn. More...

override object	Load (System.IO.BinaryReader br, bool bNewInstance=true)
	Load the parameter from a binary reader. More...

override void	Copy (LayerParameterBase src)
	Copy on parameter to another. More...

override LayerParameterBase	Clone ()
	Creates a new copy of this instance of the parameter. More...

override RawProto	ToProto (string strName)
	Convert the parameter into a RawProto. More...

Public Member Functions inherited from MyCaffe.param.KernelParameter
	KernelParameter ()
	Constructor for the parameter. More...

override object	Load (System.IO.BinaryReader br, bool bNewInstance=true)
	Load the parameter from a binary reader. More...

Public Member Functions inherited from MyCaffe.param.EngineParameter
	EngineParameter ()
	Constructor for the parameter. More...

override object	Load (System.IO.BinaryReader br, bool bNewInstance=true)
	Load the parameter from a binary reader. More...

Public Member Functions inherited from MyCaffe.param.LayerParameterBase
	LayerParameterBase ()
	Constructor for the parameter. More...

virtual string	PrepareRunModelInputs ()
	This method gives derivative classes a chance specify model inputs required by the run model. More...

virtual void	PrepareRunModel (LayerParameter p)
	This method gives derivative classes a chance to prepare the layer for a run-model. More...

void	Save (BinaryWriter bw)
	Save this parameter to a binary writer. More...

abstract object	Load (BinaryReader br, bool bNewInstance=true)
	Load the parameter from a binary reader. More...

Public Member Functions inherited from MyCaffe.basecode.BaseParameter
	BaseParameter ()
	Constructor for the parameter. More...

virtual bool	Compare (BaseParameter p)
	Compare this parameter to another parameter. More...

Static Public Member Functions
static new PoolingParameter	FromProto (RawProto rp)
	Parses the parameter from a RawProto. More...

Static Public Member Functions inherited from MyCaffe.param.KernelParameter
static new KernelParameter	FromProto (RawProto rp)
	Parse a RawProto into a new instance of the parameter. More...

Static Public Member Functions inherited from MyCaffe.param.EngineParameter
static EngineParameter	FromProto (RawProto rp)
	Parses the parameter from a RawProto. More...

Static Public Member Functions inherited from MyCaffe.basecode.BaseParameter
static double	ParseDouble (string strVal)
	Parse double values using the US culture if the decimal separator = '.', then using the native culture, and if then lastly trying the US culture to handle prototypes containing '.' as the separator, yet parsed in a culture that does not use '.' as a decimal. More...

static bool	TryParse (string strVal, out double df)
	Parse double values using the US culture if the decimal separator = '.', then using the native culture, and if then lastly trying the US culture to handle prototypes containing '.' as the separator, yet parsed in a culture that does not use '.' as a decimal. More...

static float	ParseFloat (string strVal)
	Parse float values using the US culture if the decimal separator = '.', then using the native culture, and if then lastly trying the US culture to handle prototypes containing '.' as the separator, yet parsed in a culture that does not use '.' as a decimal. More...

static bool	TryParse (string strVal, out float f)
	Parse doufloatble values using the US culture if the decimal separator = '.', then using the native culture, and if then lastly trying the US culture to handle prototypes containing '.' as the separator, yet parsed in a culture that does not use '.' as a decimal. More...

Properties
PoolingMethod	pool `[getset]`
	Specifies the pooling method. More...

bool	global_pooling `[getset]`
	Specifies whether or not to enable global pooling. More...

PoolingReshapeAlgorithm	reshape_algorithm `[getset]`
	Specifies the reshape algorithm to use, either the original Caffe reshape (default = false) or the new Onnx reshape algorithm (true). See remarks for the difference. More...

Properties inherited from MyCaffe.param.KernelParameter
List< uint >	pad `[getset]`
	Pad is given as a single value for equal dimensions in all spatial dimensions, or once per spatial dimension. More...

List< uint >	stride `[getset]`
	Stride is given as a single value for equal dimensions in all spatial dimensions, or once per spatial dimension. More...

List< uint >	kernel_size `[getset]`
	Kernel size is given as a single value for equal dimensions in all spatial dimensions, or once per spatial dimension. More...

List< uint >	dilation `[getset]`
	Factor used to dilate the kernel, (implicitly) zero-filling the resulting holes. (Kernel dilation is sometimes referred to by its use in the algorithm 'a trous from Holschneider et al. 1987.) More...

uint?	pad_h `[getset]`
	The padding height (2D only) More...

uint?	pad_w `[getset]`
	The padding width (2D only) More...

uint?	stride_h `[getset]`
	The stride height (2D only) More...

uint?	stride_w `[getset]`
	The stride width (2D only) More...

uint?	kernel_h `[getset]`
	The kernel height (2D only) More...

uint?	kernel_w `[getset]`
	The kernel width (2D only) More...

Properties inherited from MyCaffe.param.EngineParameter
Engine	engine `[getset]`
	Specifies the Engine in use. More...

Detailed Description

Specifies the parameters for the PoolingLayer.

See also: A guide to convolution arithmetic for deep learning by Vincent Dumoulin and Francesco Visin, 2016.; Learning Deep Features for Discriminative Localization by Bolei Zhou, Aditya Khosla, Agata Lapedriza, Aude Oliva, and Antonio Torralba, 2015.; Gradient-Based Learning Applied to Document Recognition by Yann LeCun, Léon Bottou, Yoshua Bengio, and Patrick Haffner, 1998.

Definition at line 20 of file PoolingParameter.cs.

Member Enumeration Documentation

◆ PoolingMethod

enum MyCaffe.param.PoolingParameter.PoolingMethod

Defines the pooling method.

Enumerator
MAX	Select the maximum value from the pooling kernel.
AVE	Select the average value from the pooling kernel.
STOCHASTIC	Select the stochastic value from the pooling kernel.

Definition at line 48 of file PoolingParameter.cs.

◆ PoolingReshapeAlgorithm

enum MyCaffe.param.PoolingParameter.PoolingReshapeAlgorithm

Defines the pooling reshape algorithm to use.

Enumerator
DEFAULT	Specifies the default reshape algorithm (CAFFE)
CAFFE	Specifies to use the default CAFFE reshape algorithm.
ONNX	Specifies to use the ONNX reshape algorithm.

Definition at line 29 of file PoolingParameter.cs.

Constructor & Destructor Documentation

◆ PoolingParameter()

MyCaffe.param.PoolingParameter.PoolingParameter ( )

Constructor for the parameter.

Definition at line 65 of file PoolingParameter.cs.

Member Function Documentation

◆ Clone()

override LayerParameterBase MyCaffe.param.PoolingParameter.Clone ( )

virtual

Creates a new copy of this instance of the parameter.

Returns: A new instance of this parameter is returned.

Reimplemented from MyCaffe.param.KernelParameter.

Definition at line 164 of file PoolingParameter.cs.

◆ Copy()

override void MyCaffe.param.PoolingParameter.Copy ( LayerParameterBase src )

virtual

Copy on parameter to another.

Parameters

src	Specifies the parameter to copy.

Reimplemented from MyCaffe.param.KernelParameter.

Definition at line 150 of file PoolingParameter.cs.

◆ FromProto()

static new PoolingParameter MyCaffe.param.PoolingParameter.FromProto ( RawProto rp )

static

Parses the parameter from a RawProto.

Parameters

rp	Specifies the RawProto to parse.

Returns: A new instance of the parameter is returned.

Definition at line 195 of file PoolingParameter.cs.

◆ Load()

override object MyCaffe.param.PoolingParameter.Load	(	System.IO.BinaryReader	br,
		bool	bNewInstance = `true`
	)

Load the parameter from a binary reader.

Parameters

br	Specifies the binary reader.
bNewInstance	When true a new instance is created (the default), otherwise the existing instance is loaded from the binary reader.

Returns: Returns an instance of the parameter.

Definition at line 138 of file PoolingParameter.cs.

◆ ToProto()

override RawProto MyCaffe.param.PoolingParameter.ToProto ( string strName )

virtual

Convert the parameter into a RawProto.

Parameters

strName Specifies the base name for the raw proto.

Returns: The RawProto is returned.

Reimplemented from MyCaffe.param.KernelParameter.

Definition at line 172 of file PoolingParameter.cs.

◆ useCaffeReason()

string MyCaffe.param.PoolingParameter.useCaffeReason ( )

Returns the reason that Caffe version was used instead of NVIDIA's cuDnn.

Returns

Definition at line 73 of file PoolingParameter.cs.

◆ useCudnn()

bool MyCaffe.param.PoolingParameter.useCudnn ( )

Queries whether or not to use NVIDIA's cuDnn.

Returns: Returns true when cuDnn is to be used, false otherwise.

Definition at line 88 of file PoolingParameter.cs.

Property Documentation

◆ global_pooling

bool MyCaffe.param.PoolingParameter.global_pooling

getset

Specifies whether or not to enable global pooling.

Definition at line 113 of file PoolingParameter.cs.

◆ pool

PoolingMethod MyCaffe.param.PoolingParameter.pool

getset

Specifies the pooling method.

Definition at line 103 of file PoolingParameter.cs.

◆ reshape_algorithm

PoolingReshapeAlgorithm MyCaffe.param.PoolingParameter.reshape_algorithm

getset

Specifies the reshape algorithm to use, either the original Caffe reshape (default = false) or the new Onnx reshape algorithm (true). See remarks for the difference.

The original CAFFE reshape algorithm used is as follows: PoolHeight = (int)ceil((height + 2 * padh - kernelh) / strideh) + 1 PoolWidth = (int)ceil((width + 2 * padw - kernelw) / stridew) + 1

And the new ONNX reshape algorithm (default) is as follows: PoolHeight = (int)floor((height + 2 * padh - kernelh) / strideh + 1) PoolWidth = (int)floor((width + 2 * padw - kernelw) / stridew + 1)

Definition at line 131 of file PoolingParameter.cs.

The documentation for this class was generated from the following file:

C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe/param/PoolingParameter.cs

Public Types

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ PoolingMethod

◆ PoolingReshapeAlgorithm

Constructor & Destructor Documentation

◆ PoolingParameter()

Member Function Documentation

◆ Clone()

◆ Copy()

◆ FromProto()

◆ Load()

◆ ToProto()

◆ useCaffeReason()

◆ useCudnn()

Property Documentation

◆ global_pooling

◆ pool

◆ reshape_algorithm