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

Specifies the parameters for the TripletLossLayer. More...

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

Public Member Functions

 TripletLossParameter ()
 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 TripletLossParameter 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

double alpha [getset]
 Specifies the margin. More...
 
int pregen_label_start [getset]
 Specifies the starting label for pre-generated targets, only used when 'colBottom.Count' = 5, which contains centroids. 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 TripletLossLayer.

See also
Deep Metric Learning Using Triplet Network by Hoffer and Ailon, 2018.
FaceNet: A Unified Embedding for Face Recognition and Clustering by Schroff, 2015.


Definition at line 33 of file TripletLossParameter.cs.

Constructor & Destructor Documentation

◆ TripletLossParameter()

MyCaffe.param.beta.TripletLossParameter.TripletLossParameter ( )

Constructor for the parameter.

Definition at line 39 of file TripletLossParameter.cs.

Member Function Documentation

◆ Clone()

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

◆ Copy()

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

Copy on parameter to another.

Parameters
srcSpecifies the parameter to copy.

Implements MyCaffe.param.LayerParameterBase.

Definition at line 83 of file TripletLossParameter.cs.

◆ FromProto()

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

◆ Load()

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

◆ ToProto()

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

Property Documentation

◆ alpha

double MyCaffe.param.beta.TripletLossParameter.alpha
getset

Specifies the margin.

Definition at line 46 of file TripletLossParameter.cs.

◆ pregen_label_start

int MyCaffe.param.beta.TripletLossParameter.pregen_label_start
getset

Specifies the starting label for pre-generated targets, only used when 'colBottom.Count' = 5, which contains centroids.

Definition at line 56 of file TripletLossParameter.cs.


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