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

Specifies the parameters for the MergeLayer. More...

Inheritance diagram for MyCaffe.param.beta.MergeParameter:
MyCaffe.param.LayerParameterBase MyCaffe.basecode.BaseParameter MyCaffe.basecode.IBinaryPersist

Public Member Functions

 MergeParameter ()
 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 MergeParameter FromProto (RawProto rp)
 Parses the parameter from a RawProto. More...
 
static List< int > Reshape (Log log, MergeParameter p, List< int > rgShape1, List< int > rgShape2)
 Calculate the new shape based on the merge parameter settings and the specified input shapes. 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

int order_major_axis [get]
 Specifies axis providing the major ordering (e.g. axis=1 uses axis 1 as the major ordering with axis 0 following). More...
 
int copy_axis [get]
 Specifies axis along which the indexing is applied when copying. More...
 
int copy_count [getset]
 Specifies the number of skip copies along the copy_axis to copy (e.g. this is the number of skips to perform and is usually = the batch size). More...
 
int src_start_idx1 [getset]
 Specifies the src start index where copying begins in the first blob in bottom(0). More...
 
int dst_start_idx1 [getset]
 Specifies the dst start index where copying begins in the destination blob in top(0). More...
 
int src_spatialdim_start_idx1 [getset]
 Specifies the src1 spatial dim start index (only used when > 0). More...
 
int dst_spatialdim_start_idx1 [getset]
 Specifies the dst1 spatial dim start index (only used when > 0). More...
 
int src_spatialdim_start_idx2 [getset]
 Specifies the src2 spatial dim start index (only used when > 0). More...
 
int dst_spatialdim_start_idx2 [getset]
 Specifies the dst2 spatial dim start index (only used when > 0). More...
 
int spatialdim_copy_count [getset]
 Specifies the spatial dim copy count, used when less than the entire spatial dim is to be copied. More...
 
int dst_spatialdim [getset]
 Specifies the dst spatial dim which if not copied into is set to zero. More...
 
int copy_dim1 [getset]
 Specifies the dimension (sans the spatial dimension) to be copied (the full copy size = copy_dim * spatial_dim which is calculated using axis dims after the copy axis). More...
 
int src_start_idx2 [getset]
 Specifies the src start index where copying begins in the second input blob in bottom(1). More...
 
int dst_start_idx2 [getset]
 Specifies the dst start index where copying begins for the second copy to dst blob in top(0). More...
 
int copy_dim2 [getset]
 Specifies the dimension (sans the spatial dimension) to be copied (the full copy size = copy_dim * spatial_dim which is calculated using axis dims after the copy axis). More...
 

Additional Inherited Members

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

Detailed Description

Specifies the parameters for the MergeLayer.

Definition at line 21 of file MergeParameter.cs.

Constructor & Destructor Documentation

◆ MergeParameter()

MyCaffe.param.beta.MergeParameter.MergeParameter ( )

Constructor for the parameter.

Definition at line 40 of file MergeParameter.cs.

Member Function Documentation

◆ Clone()

override LayerParameterBase MyCaffe.param.beta.MergeParameter.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 245 of file MergeParameter.cs.

◆ Copy()

override void MyCaffe.param.beta.MergeParameter.Copy ( LayerParameterBase  src)
virtual

Copy on parameter to another.

Parameters
srcSpecifies the parameter to copy.

Implements MyCaffe.param.LayerParameterBase.

Definition at line 221 of file MergeParameter.cs.

◆ FromProto()

static MergeParameter MyCaffe.param.beta.MergeParameter.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 285 of file MergeParameter.cs.

◆ Load()

override object MyCaffe.param.beta.MergeParameter.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 206 of file MergeParameter.cs.

◆ Reshape()

static List< int > MyCaffe.param.beta.MergeParameter.Reshape ( Log  log,
MergeParameter  p,
List< int >  rgShape1,
List< int >  rgShape2 
)
static

Calculate the new shape based on the merge parameter settings and the specified input shapes.

Parameters
pSpecifies the merge parameter.
rgShape1Specifies the shape of the first input.
rgShape2Specifies the shape of the second input.
logSpecifies the output log.
Returns
The new shape is returned.

Definition at line 346 of file MergeParameter.cs.

◆ ToProto()

override RawProto MyCaffe.param.beta.MergeParameter.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 257 of file MergeParameter.cs.

Property Documentation

◆ copy_axis

int MyCaffe.param.beta.MergeParameter.copy_axis
get

Specifies axis along which the indexing is applied when copying.

LSTM layers using sequnce ordering have shapes (T,N,...) where T = the sequence and N = the batch. These layers use copying_axis = 0.

Definition at line 64 of file MergeParameter.cs.

◆ copy_count

int MyCaffe.param.beta.MergeParameter.copy_count
getset

Specifies the number of skip copies along the copy_axis to copy (e.g. this is the number of skips to perform and is usually = the batch size).

Definition at line 74 of file MergeParameter.cs.

◆ copy_dim1

int MyCaffe.param.beta.MergeParameter.copy_dim1
getset

Specifies the dimension (sans the spatial dimension) to be copied (the full copy size = copy_dim * spatial_dim which is calculated using axis dims after the copy axis).

Definition at line 164 of file MergeParameter.cs.

◆ copy_dim2

int MyCaffe.param.beta.MergeParameter.copy_dim2
getset

Specifies the dimension (sans the spatial dimension) to be copied (the full copy size = copy_dim * spatial_dim which is calculated using axis dims after the copy axis).

Definition at line 194 of file MergeParameter.cs.

◆ dst_spatialdim

int MyCaffe.param.beta.MergeParameter.dst_spatialdim
getset

Specifies the dst spatial dim which if not copied into is set to zero.

Definition at line 154 of file MergeParameter.cs.

◆ dst_spatialdim_start_idx1

int MyCaffe.param.beta.MergeParameter.dst_spatialdim_start_idx1
getset

Specifies the dst1 spatial dim start index (only used when > 0).

Definition at line 114 of file MergeParameter.cs.

◆ dst_spatialdim_start_idx2

int MyCaffe.param.beta.MergeParameter.dst_spatialdim_start_idx2
getset

Specifies the dst2 spatial dim start index (only used when > 0).

Definition at line 134 of file MergeParameter.cs.

◆ dst_start_idx1

int MyCaffe.param.beta.MergeParameter.dst_start_idx1
getset

Specifies the dst start index where copying begins in the destination blob in top(0).

Definition at line 94 of file MergeParameter.cs.

◆ dst_start_idx2

int MyCaffe.param.beta.MergeParameter.dst_start_idx2
getset

Specifies the dst start index where copying begins for the second copy to dst blob in top(0).

Definition at line 184 of file MergeParameter.cs.

◆ order_major_axis

int MyCaffe.param.beta.MergeParameter.order_major_axis
get

Specifies axis providing the major ordering (e.g. axis=1 uses axis 1 as the major ordering with axis 0 following).

LSTM layers using sequnce ordering have shapes (T,N,...) where T = the sequence and N = the batch. These layers use ordering_major_axis = 1.

Definition at line 51 of file MergeParameter.cs.

◆ spatialdim_copy_count

int MyCaffe.param.beta.MergeParameter.spatialdim_copy_count
getset

Specifies the spatial dim copy count, used when less than the entire spatial dim is to be copied.

Definition at line 144 of file MergeParameter.cs.

◆ src_spatialdim_start_idx1

int MyCaffe.param.beta.MergeParameter.src_spatialdim_start_idx1
getset

Specifies the src1 spatial dim start index (only used when > 0).

Definition at line 104 of file MergeParameter.cs.

◆ src_spatialdim_start_idx2

int MyCaffe.param.beta.MergeParameter.src_spatialdim_start_idx2
getset

Specifies the src2 spatial dim start index (only used when > 0).

Definition at line 124 of file MergeParameter.cs.

◆ src_start_idx1

int MyCaffe.param.beta.MergeParameter.src_start_idx1
getset

Specifies the src start index where copying begins in the first blob in bottom(0).

Definition at line 84 of file MergeParameter.cs.

◆ src_start_idx2

int MyCaffe.param.beta.MergeParameter.src_start_idx2
getset

Specifies the src start index where copying begins in the second input blob in bottom(1).

Definition at line 174 of file MergeParameter.cs.


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