MyCaffe  1.12.2.41
Deep learning software for Windows C# programmers.
MyCaffe.param.ReductionParameter Class Reference

Specifies the parameters used by ReductionLayer. More...

Inheritance diagram for MyCaffe.param.ReductionParameter:
MyCaffe.param.LayerParameterBase MyCaffe.basecode.BaseParameter MyCaffe.basecode.IBinaryPersist

Public Types

enum  ReductionOp {
  SUM = 1 , ASUM = 2 , SUMSQ = 3 , MEAN = 4 ,
  MIN = 5 , MAX = 6
}
 Defines the reduction operation. More...
 
- Public Types inherited from MyCaffe.param.LayerParameterBase
enum  LABEL_TYPE { NONE , SINGLE , MULTIPLE , ONLY_ONE }
 Defines the label type. More...
 

Public Member Functions

 ReductionParameter ()
 Constructor for the parameter. 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.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 ReductionParameter 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

ReductionOp operation [getset]
 Specifies the reduction operation. More...
 
int axis [getset]
 The first axis to reduce to scalar – may be negative index from the end (e.g., -1 for the last axis). (Currently, only reduction along ALL 'tail' axes is supported; reduction on axis M through N, where N less than num_axis - 1, is unsupported.) Suppose we have an n-axis bottom Blob with shape: (d0, d1, d2, ..., d(m-1), dm, d(m+1), ..., d(n-1)). More...
 
double coeff [getset]
 Specifies the coefficient used to scale the output. More...
 

Detailed Description

Specifies the parameters used by ReductionLayer.

Definition at line 15 of file ReductionParameter.cs.

Member Enumeration Documentation

◆ ReductionOp

Defines the reduction operation.

Enumerator
SUM 

Sum the values.

ASUM 

Sum the absolute values.

SUMSQ 

Sum the squared values.

MEAN 

Calculate the mean value.

MIN 

Calculate the min value.

MAX 

Calculate the max value.

Definition at line 20 of file ReductionParameter.cs.

Constructor & Destructor Documentation

◆ ReductionParameter()

MyCaffe.param.ReductionParameter.ReductionParameter ( )

Constructor for the parameter.

Definition at line 53 of file ReductionParameter.cs.

Member Function Documentation

◆ Clone()

override LayerParameterBase MyCaffe.param.ReductionParameter.Clone ( )
virtual

Creates a new copy of this instance of the parameter.

Returns
A new instance of this parameter is returned.

Implements MyCaffe.param.LayerParameterBase.

Definition at line 124 of file ReductionParameter.cs.

◆ Copy()

override void MyCaffe.param.ReductionParameter.Copy ( LayerParameterBase  src)
virtual

Copy on parameter to another.

Parameters
srcSpecifies the parameter to copy.

Implements MyCaffe.param.LayerParameterBase.

Definition at line 115 of file ReductionParameter.cs.

◆ FromProto()

static ReductionParameter MyCaffe.param.ReductionParameter.FromProto ( RawProto  rp)
static

Parses the parameter from a RawProto.

Parameters
rpSpecifies the RawProto to parse.
Returns
A new instance of the parameter is returned.

Definition at line 156 of file ReductionParameter.cs.

◆ Load()

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

Load the parameter from a binary reader.

Parameters
brSpecifies the binary reader.
bNewInstanceWhen 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 103 of file ReductionParameter.cs.

◆ ToProto()

override RawProto MyCaffe.param.ReductionParameter.ToProto ( string  strName)
virtual

Convert the parameter into a RawProto.

Parameters
strNameSpecifies the name to associate with the RawProto.
Returns
The new RawProto is returned.

Implements MyCaffe.basecode.BaseParameter.

Definition at line 136 of file ReductionParameter.cs.

Property Documentation

◆ axis

int MyCaffe.param.ReductionParameter.axis
getset

The first axis to reduce to scalar – may be negative index from the end (e.g., -1 for the last axis). (Currently, only reduction along ALL 'tail' axes is supported; reduction on axis M through N, where N less than num_axis - 1, is unsupported.) Suppose we have an n-axis bottom Blob with shape: (d0, d1, d2, ..., d(m-1), dm, d(m+1), ..., d(n-1)).

if (axis == m, the output Blob will have shape (d0, d1, d2, ..., d(m-1)),

and the ReductionOp operation is performed (d0 * d1 * d2 * ... * d(m-1)) times, each including (dm * d(m+1) * ... * d(n-1)) individual data.

if axis == 0 (the default), the output Blob always has the empty shape (count 1), performing reduction across the entire input – often useful for creating new loss functions.

Definition at line 86 of file ReductionParameter.cs.

◆ coeff

double MyCaffe.param.ReductionParameter.coeff
getset

Specifies the coefficient used to scale the output.

Definition at line 96 of file ReductionParameter.cs.

◆ operation

ReductionOp MyCaffe.param.ReductionParameter.operation
getset

Specifies the reduction operation.

Definition at line 61 of file ReductionParameter.cs.


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