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

/b DEPRECIATED (use DataLayer DataLabelMappingParameter instead) Specifies the parameters for the LabelMappingLayer. More...

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

Public Member Functions

 LabelMappingParameter ()
 Constructor for the parameter. More...
 
int MapLabel (int nLabel)
 Queries the mapped label for a given label. 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 LabelMappingParameter 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

List< LabelMappingmapping [getset]
 Specifies the label mapping where the original label is mapped to the new label specified. More...
 
bool update_database [getset]
 Specifies whether or not to directly update the database with the label mapping for the data source used - when 'false' only the 'in-memory' labels are updated. WARNING: Updating the database sets the label mapping globally and will impact all other projects using this data source. More...
 
bool reset_database_labels [getset]
 Specifies whether or not to reset the database labels to the original label values for the data source used. WARNING: This resets the labels globally to their original setting and will impact all other projects using this data source. More...
 
string label_boosts [getset]
 DEPRECIATED: Specifies the labels for which the label boost is to be set. When set, all labels specified are given a boost such that images are selected with equal probability between all labels specified. 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

/b DEPRECIATED (use DataLayer DataLabelMappingParameter instead) Specifies the parameters for the LabelMappingLayer.

Definition at line 16 of file LabelMappingParameter.cs.

Constructor & Destructor Documentation

◆ LabelMappingParameter()

MyCaffe.param.LabelMappingParameter.LabelMappingParameter ( )

Constructor for the parameter.

Definition at line 24 of file LabelMappingParameter.cs.

Member Function Documentation

◆ Clone()

override LayerParameterBase MyCaffe.param.LabelMappingParameter.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 102 of file LabelMappingParameter.cs.

◆ Copy()

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

Copy on parameter to another.

Parameters
srcSpecifies the parameter to copy.

Implements MyCaffe.param.LayerParameterBase.

Definition at line 91 of file LabelMappingParameter.cs.

◆ FromProto()

static LabelMappingParameter MyCaffe.param.LabelMappingParameter.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 137 of file LabelMappingParameter.cs.

◆ Load()

override object MyCaffe.param.LabelMappingParameter.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 79 of file LabelMappingParameter.cs.

◆ MapLabel()

int MyCaffe.param.LabelMappingParameter.MapLabel ( int  nLabel)

Queries the mapped label for a given label.

Parameters
nLabelSpecifies the label to query the mapped label from.
Returns
The mapped label is returned.

Definition at line 73 of file LabelMappingParameter.cs.

◆ ToProto()

override RawProto MyCaffe.param.LabelMappingParameter.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 114 of file LabelMappingParameter.cs.

Property Documentation

◆ label_boosts

string MyCaffe.param.LabelMappingParameter.label_boosts
getset

DEPRECIATED: Specifies the labels for which the label boost is to be set. When set, all labels specified are given a boost such that images are selected with equal probability between all labels specified.

Definition at line 62 of file LabelMappingParameter.cs.

◆ mapping

List<LabelMapping> MyCaffe.param.LabelMappingParameter.mapping
getset

Specifies the label mapping where the original label is mapped to the new label specified.

Definition at line 32 of file LabelMappingParameter.cs.

◆ reset_database_labels

bool MyCaffe.param.LabelMappingParameter.reset_database_labels
getset

Specifies whether or not to reset the database labels to the original label values for the data source used. WARNING: This resets the labels globally to their original setting and will impact all other projects using this data source.

Definition at line 52 of file LabelMappingParameter.cs.

◆ update_database

bool MyCaffe.param.LabelMappingParameter.update_database
getset

Specifies whether or not to directly update the database with the label mapping for the data source used - when 'false' only the 'in-memory' labels are updated. WARNING: Updating the database sets the label mapping globally and will impact all other projects using this data source.

Definition at line 42 of file LabelMappingParameter.cs.


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