MyCaffe  1.12.2.41
Deep learning software for Windows C# programmers.
MyCaffe.param.LayerParameterBase Class Referenceabstract

The LayerParameterBase is the base class for all other layer specific parameters. More...

Inheritance diagram for MyCaffe.param.LayerParameterBase:
MyCaffe.basecode.BaseParameter MyCaffe.basecode.IBinaryPersist MyCaffe.param.AccuracyParameter MyCaffe.param.ArgMaxParameter MyCaffe.param.AttentionParameter MyCaffe.param.BiasParameter MyCaffe.param.ClipParameter MyCaffe.param.ConcatParameter MyCaffe.param.ConstantParameter MyCaffe.param.ContrastiveLossParameter MyCaffe.param.ConvolutionOctaveParameter MyCaffe.param.CropParameter MyCaffe.param.DataNormalizerParameter MyCaffe.param.DataParameter MyCaffe.param.DebugParameter MyCaffe.param.DummyDataParameter MyCaffe.param.EltwiseParameter MyCaffe.param.EmbedParameter MyCaffe.param.EngineParameter MyCaffe.param.ExpParameter MyCaffe.param.FlattenParameter MyCaffe.param.GradientScaleParameter MyCaffe.param.HDF5DataParameter MyCaffe.param.HingeLossParameter MyCaffe.param.ImageDataParameter MyCaffe.param.InfogainLossParameter MyCaffe.param.InnerProductParameter MyCaffe.param.InputParameter MyCaffe.param.InterpParameter MyCaffe.param.LSTMAttentionParameter MyCaffe.param.LSTMSimpleParameter MyCaffe.param.LabelMappingParameter MyCaffe.param.LogParameter MyCaffe.param.LossParameter MyCaffe.param.MVNParameter MyCaffe.param.MathParameter MyCaffe.param.MeanErrorLossParameter MyCaffe.param.MemoryDataParameter MyCaffe.param.ModelDataParameter MyCaffe.param.PReLUParameter MyCaffe.param.ParameterParameter MyCaffe.param.PowerParameter MyCaffe.param.ReductionParameter MyCaffe.param.ReshapeParameter MyCaffe.param.SliceParameter MyCaffe.param.TextDataParameter MyCaffe.param.ThresholdParameter MyCaffe.param.TileParameter MyCaffe.param.TransformationParameter MyCaffe.param.beta.DataSequenceParameter MyCaffe.param.beta.DecodeParameter MyCaffe.param.beta.GatherParameter MyCaffe.param.beta.KnnParameter MyCaffe.param.beta.MergeParameter MyCaffe.param.beta.Normalization1Parameter MyCaffe.param.beta.SqueezeParameter MyCaffe.param.beta.TransposeParameter MyCaffe.param.beta.TripletLossParameter MyCaffe.param.gpt.CausalSelfAttentionParameter MyCaffe.param.gpt.GeluParameter MyCaffe.param.gpt.LayerNormParameter MyCaffe.param.gpt.MultiheadAttentionParameter MyCaffe.param.gpt.NLLLossParameter MyCaffe.param.gpt.PositionalEncoderParameter MyCaffe.param.gpt.TokenizedDataParameter MyCaffe.param.gpt.TransformerBlockParameter MyCaffe.param.lnn.CfcParameter MyCaffe.param.lnn.CfcUnitParameter MyCaffe.param.lnn.LtcUnitParameter MyCaffe.param.nt.GramParameter MyCaffe.param.nt.OneHotParameter MyCaffe.param.nt.ScalarParameter MyCaffe.param.nt.TVLossParameter MyCaffe.param.python.PythonParameter MyCaffe.param.ssd.AnnotatedDataParameter MyCaffe.param.ssd.DetectionEvaluateParameter MyCaffe.param.ssd.DetectionOutputParameter MyCaffe.param.ssd.MultiBoxLossParameter MyCaffe.param.ssd.Normalization2Parameter MyCaffe.param.ssd.PermuteParameter MyCaffe.param.ssd.PriorBoxParameter MyCaffe.param.ssd.VideoDataParameter MyCaffe.param.tft.CategoricalTransformationParameter MyCaffe.param.tft.DataTemporalParameter MyCaffe.param.tft.GateAddNormParameter MyCaffe.param.tft.GluParameter MyCaffe.param.tft.GrnParameter MyCaffe.param.tft.MultiHeadAttentionInterpParameter MyCaffe.param.tft.NumericTransformationParameter MyCaffe.param.tft.QuantileAccuracyParameter MyCaffe.param.tft.QuantileLossParameter MyCaffe.param.tft.ReshapeTemporalParameter MyCaffe.param.tft.VarSelNetParameter

Public Types

enum  LABEL_TYPE { NONE , SINGLE , MULTIPLE , ONLY_ONE }
 Defines the label type. More...
 

Public Member Functions

 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...
 
abstract LayerParameterBase Clone ()
 Creates a new copy of this instance of the parameter. More...
 
abstract void Copy (LayerParameterBase src)
 Copy on parameter to another. 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...
 
abstract RawProto ToProto (string strName)
 Convert the parameter into a RawProto. More...
 
virtual bool Compare (BaseParameter p)
 Compare this parameter to another parameter. More...
 

Additional Inherited Members

- 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...
 

Detailed Description

The LayerParameterBase is the base class for all other layer specific parameters.

Definition at line 17 of file LayerParameterBase.cs.

Member Enumeration Documentation

◆ LABEL_TYPE

Defines the label type.

Enumerator
NONE 

Specifies that no label is used.

SINGLE 

Specifies a single label value per batch item so if the batch size = 8 there should be 8 labels, which is the default.

MULTIPLE 

Specifies multiple values for the label such as are used in segmentation problems, the label's are stored in each Data Item's DataCriteria field.

ONLY_ONE 

Specifies to force the label to a single value regardless of the batch size, so if the batch size is 8, the label count remains only 1.

Definition at line 22 of file LayerParameterBase.cs.

Constructor & Destructor Documentation

◆ LayerParameterBase()

MyCaffe.param.LayerParameterBase.LayerParameterBase ( )

Constructor for the parameter.

Definition at line 44 of file LayerParameterBase.cs.

Member Function Documentation

◆ Clone()

abstract LayerParameterBase MyCaffe.param.LayerParameterBase.Clone ( )
pure virtual

Creates a new copy of this instance of the parameter.

Returns
A new instance of this parameter is returned.

Implemented in MyCaffe.param.AttentionParameter, MyCaffe.param.ConvolutionOctaveParameter, MyCaffe.param.beta.DataSequenceParameter, MyCaffe.param.beta.DecodeParameter, MyCaffe.param.beta.GatherParameter, MyCaffe.param.InterpParameter, MyCaffe.param.beta.KnnParameter, MyCaffe.param.LSTMAttentionParameter, MyCaffe.param.MeanErrorLossParameter, MyCaffe.param.beta.MergeParameter, MyCaffe.param.beta.MishParameter, MyCaffe.param.ModelDataParameter, MyCaffe.param.beta.Normalization1Parameter, MyCaffe.param.beta.SerfParameter, MyCaffe.param.beta.SqueezeParameter, MyCaffe.param.TextDataParameter, MyCaffe.param.beta.TransposeParameter, MyCaffe.param.beta.TripletLossParameter, MyCaffe.param.beta.UnPoolingParameter, MyCaffe.param.gpt.CausalSelfAttentionParameter, MyCaffe.param.gpt.GeluParameter, MyCaffe.param.gpt.LayerNormParameter, MyCaffe.param.gpt.MultiheadAttentionParameter, MyCaffe.param.gpt.NLLLossParameter, MyCaffe.param.gpt.PositionalEncoderParameter, MyCaffe.param.gpt.TokenizedDataPairsParameter, MyCaffe.param.gpt.TokenizedDataParameter, MyCaffe.param.gpt.TransformerBlockParameter, MyCaffe.param.HDF5DataParameter, MyCaffe.param.lnn.CfcParameter, MyCaffe.param.lnn.CfcUnitParameter, MyCaffe.param.lnn.LtcUnitParameter, MyCaffe.param.nt.GramParameter, MyCaffe.param.nt.OneHotParameter, MyCaffe.param.nt.ScalarParameter, MyCaffe.param.nt.TVLossParameter, MyCaffe.param.python.PythonParameter, MyCaffe.param.ssd.AnnotatedDataParameter, MyCaffe.param.ssd.DetectionEvaluateParameter, MyCaffe.param.ssd.DetectionOutputParameter, MyCaffe.param.ssd.MultiBoxLossParameter, MyCaffe.param.ssd.Normalization2Parameter, MyCaffe.param.ssd.PermuteParameter, MyCaffe.param.ssd.PriorBoxParameter, MyCaffe.param.ssd.VideoDataParameter, MyCaffe.param.tft.CategoricalTransformationParameter, MyCaffe.param.tft.DataTemporalParameter, MyCaffe.param.tft.GateAddNormParameter, MyCaffe.param.tft.GluParameter, MyCaffe.param.tft.GrnParameter, MyCaffe.param.tft.MultiHeadAttentionInterpParameter, MyCaffe.param.tft.NumericTransformationParameter, MyCaffe.param.tft.QuantileAccuracyParameter, MyCaffe.param.tft.QuantileLossParameter, MyCaffe.param.tft.ReshapeTemporalParameter, MyCaffe.param.tft.VarSelNetParameter, MyCaffe.param.AccuracyParameter, MyCaffe.param.ArgMaxParameter, MyCaffe.param.BatchNormParameter, MyCaffe.param.BiasParameter, MyCaffe.param.ClipParameter, MyCaffe.param.ConcatParameter, MyCaffe.param.ConstantParameter, MyCaffe.param.ContrastiveLossParameter, MyCaffe.param.ConvolutionParameter, MyCaffe.param.CropParameter, MyCaffe.param.DataNormalizerParameter, MyCaffe.param.DataParameter, MyCaffe.param.DebugParameter, MyCaffe.param.DropoutParameter, MyCaffe.param.DummyDataParameter, MyCaffe.param.EltwiseParameter, MyCaffe.param.EluParameter, MyCaffe.param.EmbedParameter, MyCaffe.param.EngineParameter, MyCaffe.param.ExpParameter, MyCaffe.param.FlattenParameter, MyCaffe.param.GradientScaleParameter, MyCaffe.param.HingeLossParameter, MyCaffe.param.ImageDataParameter, MyCaffe.param.InfogainLossParameter, MyCaffe.param.InnerProductParameter, MyCaffe.param.InputParameter, MyCaffe.param.KernelParameter, MyCaffe.param.LabelMappingParameter, MyCaffe.param.LogParameter, MyCaffe.param.LossParameter, MyCaffe.param.LRNParameter, MyCaffe.param.LSTMSimpleParameter, MyCaffe.param.MathParameter, MyCaffe.param.MemoryDataParameter, MyCaffe.param.MVNParameter, MyCaffe.param.ParameterParameter, MyCaffe.param.PoolingParameter, MyCaffe.param.PowerParameter, MyCaffe.param.PReLUParameter, MyCaffe.param.RecurrentParameter, MyCaffe.param.ReductionParameter, MyCaffe.param.ReLUParameter, MyCaffe.param.ReshapeParameter, MyCaffe.param.ScaleParameter, MyCaffe.param.SigmoidParameter, MyCaffe.param.SliceParameter, MyCaffe.param.SoftmaxParameter, MyCaffe.param.SPPParameter, MyCaffe.param.SwishParameter, MyCaffe.param.TanhParameter, MyCaffe.param.ThresholdParameter, MyCaffe.param.TileParameter, and MyCaffe.param.TransformationParameter.

◆ Copy()

abstract void MyCaffe.param.LayerParameterBase.Copy ( LayerParameterBase  src)
pure virtual

Copy on parameter to another.

Parameters
srcSpecifies the parameter to copy.

Implemented in MyCaffe.param.AttentionParameter, MyCaffe.param.ConvolutionOctaveParameter, MyCaffe.param.beta.DataSequenceParameter, MyCaffe.param.beta.DecodeParameter, MyCaffe.param.beta.GatherParameter, MyCaffe.param.InterpParameter, MyCaffe.param.beta.KnnParameter, MyCaffe.param.LSTMAttentionParameter, MyCaffe.param.MeanErrorLossParameter, MyCaffe.param.beta.MergeParameter, MyCaffe.param.beta.MishParameter, MyCaffe.param.ModelDataParameter, MyCaffe.param.beta.Normalization1Parameter, MyCaffe.param.beta.SerfParameter, MyCaffe.param.beta.SqueezeParameter, MyCaffe.param.TextDataParameter, MyCaffe.param.beta.TransposeParameter, MyCaffe.param.beta.TripletLossParameter, MyCaffe.param.beta.UnPoolingParameter, MyCaffe.param.gpt.CausalSelfAttentionParameter, MyCaffe.param.gpt.GeluParameter, MyCaffe.param.gpt.LayerNormParameter, MyCaffe.param.gpt.MultiheadAttentionParameter, MyCaffe.param.gpt.NLLLossParameter, MyCaffe.param.gpt.PositionalEncoderParameter, MyCaffe.param.gpt.TokenizedDataPairsParameter, MyCaffe.param.gpt.TokenizedDataParameter, MyCaffe.param.gpt.TransformerBlockParameter, MyCaffe.param.HDF5DataParameter, MyCaffe.param.lnn.CfcParameter, MyCaffe.param.lnn.CfcUnitParameter, MyCaffe.param.lnn.LtcUnitParameter, MyCaffe.param.nt.GramParameter, MyCaffe.param.nt.OneHotParameter, MyCaffe.param.nt.ScalarParameter, MyCaffe.param.nt.TVLossParameter, MyCaffe.param.python.PythonParameter, MyCaffe.param.ssd.AnnotatedDataParameter, MyCaffe.param.ssd.DetectionEvaluateParameter, MyCaffe.param.ssd.DetectionOutputParameter, MyCaffe.param.ssd.MultiBoxLossParameter, MyCaffe.param.ssd.Normalization2Parameter, MyCaffe.param.ssd.PermuteParameter, MyCaffe.param.ssd.PriorBoxParameter, MyCaffe.param.ssd.VideoDataParameter, MyCaffe.param.tft.CategoricalTransformationParameter, MyCaffe.param.tft.DataTemporalParameter, MyCaffe.param.tft.GateAddNormParameter, MyCaffe.param.tft.GluParameter, MyCaffe.param.tft.GrnParameter, MyCaffe.param.tft.MultiHeadAttentionInterpParameter, MyCaffe.param.tft.NumericTransformationParameter, MyCaffe.param.tft.QuantileAccuracyParameter, MyCaffe.param.tft.QuantileLossParameter, MyCaffe.param.tft.ReshapeTemporalParameter, MyCaffe.param.tft.VarSelNetParameter, MyCaffe.param.AccuracyParameter, MyCaffe.param.ArgMaxParameter, MyCaffe.param.BatchNormParameter, MyCaffe.param.BiasParameter, MyCaffe.param.ClipParameter, MyCaffe.param.ConcatParameter, MyCaffe.param.ConstantParameter, MyCaffe.param.ContrastiveLossParameter, MyCaffe.param.ConvolutionParameter, MyCaffe.param.CropParameter, MyCaffe.param.DataNormalizerParameter, MyCaffe.param.DataParameter, MyCaffe.param.DebugParameter, MyCaffe.param.DropoutParameter, MyCaffe.param.DummyDataParameter, MyCaffe.param.EltwiseParameter, MyCaffe.param.EluParameter, MyCaffe.param.EmbedParameter, MyCaffe.param.EngineParameter, MyCaffe.param.ExpParameter, MyCaffe.param.FlattenParameter, MyCaffe.param.GradientScaleParameter, MyCaffe.param.HingeLossParameter, MyCaffe.param.ImageDataParameter, MyCaffe.param.InfogainLossParameter, MyCaffe.param.InnerProductParameter, MyCaffe.param.InputParameter, MyCaffe.param.KernelParameter, MyCaffe.param.LabelMappingParameter, MyCaffe.param.LogParameter, MyCaffe.param.LossParameter, MyCaffe.param.LRNParameter, MyCaffe.param.LSTMSimpleParameter, MyCaffe.param.MathParameter, MyCaffe.param.MemoryDataParameter, MyCaffe.param.MVNParameter, MyCaffe.param.ParameterParameter, MyCaffe.param.PoolingParameter, MyCaffe.param.PowerParameter, MyCaffe.param.PReLUParameter, MyCaffe.param.RecurrentParameter, MyCaffe.param.ReductionParameter, MyCaffe.param.ReLUParameter, MyCaffe.param.ReshapeParameter, MyCaffe.param.ScaleParameter, MyCaffe.param.SliceParameter, MyCaffe.param.SoftmaxParameter, MyCaffe.param.SPPParameter, MyCaffe.param.SwishParameter, MyCaffe.param.ThresholdParameter, MyCaffe.param.TileParameter, and MyCaffe.param.TransformationParameter.

◆ Load()

abstract object MyCaffe.param.LayerParameterBase.Load ( BinaryReader  br,
bool  bNewInstance = true 
)
pure virtual

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.

Implements MyCaffe.basecode.IBinaryPersist.

Implemented in MyCaffe.param.ssd.AnnotatedDataParameter, MyCaffe.param.ssd.MultiBoxLossParameter, MyCaffe.param.ssd.PriorBoxParameter, MyCaffe.param.InputParameter, and MyCaffe.param.RecurrentParameter.

◆ PrepareRunModel()

virtual void MyCaffe.param.LayerParameterBase.PrepareRunModel ( LayerParameter  p)
virtual

This method gives derivative classes a chance to prepare the layer for a run-model.

Parameters
pSpecifies the full layer parameter.

Reimplemented in MyCaffe.param.ModelDataParameter, and MyCaffe.param.TextDataParameter.

Definition at line 62 of file LayerParameterBase.cs.

◆ PrepareRunModelInputs()

virtual string MyCaffe.param.LayerParameterBase.PrepareRunModelInputs ( )
virtual

This method gives derivative classes a chance specify model inputs required by the run model.

Returns
The model inputs required by the layer (if any) or null.

Reimplemented in MyCaffe.param.ModelDataParameter, and MyCaffe.param.TextDataParameter.

Definition at line 53 of file LayerParameterBase.cs.

◆ Save()

void MyCaffe.param.LayerParameterBase.Save ( BinaryWriter  bw)

Save this parameter to a binary writer.

Parameters
bwSpecifies the binary writer to use.

Implements MyCaffe.basecode.IBinaryPersist.

Definition at line 82 of file LayerParameterBase.cs.


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