MyCaffe  1.11.7.7
Deep learning software for Windows C# programmers.
MyCaffe.layers.LossLayer< T > Class Template Reference

The LossLayer provides an interface for Layer's that take two blobs as input – usually (1) predictions and (2) ground-truth labels – and output a singleton blob representing the loss. This layer is initialized with the MyCaffe.param.LossParameter. More...

Inheritance diagram for MyCaffe.layers.LossLayer< T >:
MyCaffe.layers.Layer< T > MyCaffe.layers.ContrastiveLossLayer< T > MyCaffe.layers.EuclideanLossLayer< T > MyCaffe.layers.HingeLossLayer< T > MyCaffe.layers.InfogainLossLayer< T > MyCaffe.layers.MemoryLossLayer< T > MyCaffe.layers.MultinomialLogisticLossLayer< T > MyCaffe.layers.SigmoidCrossEntropyLossLayer< T > MyCaffe.layers.SoftmaxCrossEntropyLossLayer< T > MyCaffe.layers.SoftmaxLossLayer< T > MyCaffe.layers.beta.MeanErrorLossLayer< T > MyCaffe.layers.beta.TripletLossLayer< T > MyCaffe.layers.nt.TVLossLayer< T > MyCaffe.layers.ssd.MultiBoxLossLayer< T > MyCaffe.layers.ssd.SmoothL1LossLayer< T >

Public Member Functions

 LossLayer (CudaDnn< T > cuda, Log log, LayerParameter p)
 The LossLayer constructor. More...
 
double GetNormalizer (LossParameter.NormalizationMode normalization_mode, int nOuterNum, int nInnerNum, int nValidCount)
 Returns the normalizer used to normalize the loss. More...
 
override bool AllowForceBackward (int nBottomIdx)
 We usually cannot backpropagate to the labels; ignore force_backward for these inputs. More...
 
override void LayerSetUp (BlobCollection< T > colBottom, BlobCollection< T > colTop)
 Setup the layer. More...
 
override void Reshape (BlobCollection< T > colBottom, BlobCollection< T > colTop)
 Reshape the bottom (input) and top (output) blobs. More...
 
- Public Member Functions inherited from MyCaffe.layers.Layer< T >
 Layer (CudaDnn< T > cuda, Log log, LayerParameter p)
 The Layer constructor. More...
 
void Dispose ()
 Releases all GPU and host resources used by the Layer. More...
 
virtual BlobCollection< T > PreProcessInput (PropertySet customInput, BlobCollection< T > colBottom=null)
 The PreprocessInput allows derivative data layers to convert a property set of input data into the bottom blob collection used as intput. More...
 
virtual void PreProcessInput (string strEncInput, int? nDecInput, BlobCollection< T > colBottom)
 Preprocess the input data for the RUN phase. More...
 
virtual List< Tuple< string, int, double > > PostProcessOutput (Blob< T > blobSofmtax, int nK=1)
 The PostprocessOutput allows derivative data layers to post-process the results, converting them back into text results. More...
 
virtual string PostProcessOutput (int nIdx)
 Convert the index to the word. More...
 
virtual void SetOnDebug (EventHandler< GetWorkBlobArgs< T > > fn)
 Set the OnDebug event. More...
 
virtual void ResetOnDebug (EventHandler< GetWorkBlobArgs< T > > fn)
 Reset the OnDebug event, disabling it. More...
 
virtual bool ReInitializeParameters (WEIGHT_TARGET target)
 Re-initialize the parameters of the layer. More...
 
void SetNetReshapeRequest ()
 Called by the Net when requesting a reshape. More...
 
void SetPhase (Phase phase)
 Changes the layer's Phase to the one specified. More...
 
void Setup (BlobCollection< T > colBottom, BlobCollection< T > colTop)
 Implements common Layer setup functionality. More...
 
virtual void SetNetParameterUsed (NetParameter np)
 This function allows other layers to gather needed information from the NetParameters if any, and is called when initialzing the Net. More...
 
void ConvertToBase (BlobCollection< T > col)
 ConvertToBase converts any blobs in a collection that are in half size to the base size. More...
 
double Forward (BlobCollection< T > colBottom, BlobCollection< T > colTop)
 Given the bottom (input) Blobs, this function computes the top (output) Blobs and the loss. More...
 
void Backward (BlobCollection< T > colTop, List< bool > rgbPropagateDown, BlobCollection< T > colBottom)
 Given the top Blob error gradients, compute the bottom Blob error gradients. More...
 
double loss (int nTopIdx)
 Returns the scalar loss associated with the top Blob at a given index. More...
 
void set_loss (int nTopIdx, double dfLoss)
 Sets the loss associated with a top Blob at a given index. More...
 
bool param_propagate_down (int nParamIdx)
 Returns whether or not the Layer should compute gradients w.r.t. a parameter at a particular index given by a parameter index. More...
 
void set_param_propagate_down (int nParamIdx, bool bPropagate)
 Sets whether or not the Layer should compute gradients w.r.t. a parameter at a particular index given by a parameter index. More...
 
void SetEnablePassthrough (bool bEnable)
 Enables/disables the pass-through mode. More...
 

Static Public Attributes

const double kLOG_THRESHOLD = 1e-20
 Specifies the minimum threshold for loss values. More...
 

Protected Member Functions

virtual double get_normalizer (LossParameter.NormalizationMode normalization_mode, int nValidCount)
 Returns the normalizer used to normalize the loss. More...
 
- Protected Member Functions inherited from MyCaffe.layers.Layer< T >
virtual void dispose ()
 Releases all GPU and host resources used by the Layer. More...
 
GetIterationArgs getCurrentIteration ()
 Fires the OnGetIteration event to query the current iteration. More...
 
long convert_to_full (int nCount, long hMem)
 Convert half memory to full memory. More...
 
void convert (BlobCollection< T > col)
 Convert a collection of blobs from / to half size. More...
 
bool reshapeNeeded (BlobCollection< T > colBottom, BlobCollection< T > colTop, bool bReset=true)
 Tests the shapes of both the bottom and top blobs and if they are the same as the previous sizing, returns false indicating that no reshape is needed. More...
 
bool compareShapes (BlobCollection< T > colBottom, BlobCollection< T > colTop)
 Compare the shapes of the top and bottom and if the same, return true, otherwise false. More...
 
abstract void forward (BlobCollection< T > colBottom, BlobCollection< T > colTop)
 This forward abstract function must be overriden by each derived Layer class to compute the top (output) Blobs for this layer. More...
 
abstract void backward (BlobCollection< T > colTop, List< bool > rgbPropagateDown, BlobCollection< T > colBottom)
 This backward abstract function must be overriden by each derived Layer class to compute the bottom (intput) Blob diffs for this Layer. More...
 
void CheckBlobCounts (BlobCollection< T > colBottom, BlobCollection< T > colTop)
 Called by the Layer::Setup function to check the number of bottom (input) and top (output) Blobs provided match the expected number of blobs expected via the {EactNum,Min,Max}{Bottom,Top}Blobs functions. More...
 
void SetLossWeights (BlobCollection< T > colTop)
 Called by Layer::Setup to initialize the weights associated with any top (output) Blobs in the loss function ans store non-zero loss weights in the diff Blob. More...
 
bool shareParameter (Blob< T > b, List< int > rgMinShape)
 Attempts to share a parameter Blob if another parameter Blob with the same name and accpetable size is found. More...
 
bool shareLayerBlob (Blob< T > b, List< int > rgMinShape)
 Attempts to share a Layer Blob if another parameter Blob with the same name and acceptable size is found. More...
 
bool shareLayerBlobs (Layer< T > layer)
 Attempts to share the Layer blobs and internal_blobs with matching names and sizes with those in another matching layer. More...
 
virtual WorkspaceArgs getWorkspace ()
 Returns the WorkspaceArgs used to share a workspace between Layers. More...
 
virtual bool setWorkspace (ulong lSize)
 Sets the workspace size (in items) and returns true if set, false otherwise. More...
 
void check_nan (Blob< T > b)
 Checks a Blob for NaNs and throws an exception if found. More...
 
convert (double df)
 Converts a double to a generic. More...
 
convert (float f)
 Converts a float to a generic. More...
 
double convertD (T df)
 Converts a generic to a double value. More...
 
float convertF (T df)
 Converts a generic to a float value. More...
 
double[] convertD (T[] rg)
 Converts an array of generic values into an array of double values. More...
 
T[] convert (double[] rg)
 Converts an array of double values into an array of generic values. More...
 
float[] convertF (T[] rg)
 Converts an array of float values into an array of generic values. More...
 
T[] convert (float[] rg)
 Converts an array of float values into an array of generic values. More...
 
int val_at (T[] rg, int nIdx)
 Returns the integer value at a given index in a generic array. More...
 
Size size_at (Blob< T > b)
 Returns the Size of a given two element Blob, such as one that stores Blob size information. More...
 

Protected Attributes

bool m_bIgnoreLabels = false
 Set to true when labels are to be ignored. More...
 
LossParameter.NormalizationMode m_normalization = LossParameter.NormalizationMode.NONE
 Specifies the normalization mode used to normalize the loss. More...
 
int m_nOuterNum = 0
 Specifies the outer num, such as the batch count (e.g. count(0, axis)). Each derivative class must set this value appropriately. More...
 
int m_nInnerNum = 0
 Specifies the inner num, such as the channel + height + width (e.g. count(axis + 1)). Each derivative class must set this value appropriately. More...
 
- Protected Attributes inherited from MyCaffe.layers.Layer< T >
LayerParameter.LayerType m_type = LayerParameter.LayerType._MAX
 Specifies the Layer type. More...
 
CudaDnn< T > m_cuda
 Specifies the CudaDnn connection to Cuda. More...
 
Log m_log
 Specifies the Log for output. More...
 
LayerParameter m_param
 Specifies the LayerParameter describing the Layer. More...
 
Phase m_phase
 Specifies the Phase under which the Layer is run. More...
 
BlobCollection< T > m_colBlobs
 Specifies the learnable parameter Blobs of the Layer. More...
 
DictionaryMap< bool > m_rgbParamPropagateDown
 Specifies whether or not to compute the learnable diff of each parameter Blob. More...
 
DictionaryMap< double > m_rgLoss
 Specifies the loss values that indeicate whether each top (output) Blob has a non-zero weight in the objective function.. More...
 
m_tOne
 Specifies a generic type equal to 1.0. More...
 
m_tZero
 Specifies a generic type equal to 0.0. More...
 
bool m_bEnablePassthrough = false
 Enables/disables the pass-through mode for the layer. Default = false. More...
 
bool m_bUseHalfSize = false
 Specifies that the half size of the top (if any) should be converted to the base size. More...
 
bool m_bConvertTopOnFwd = false
 Specifies whether or not the layer should convert the top on the forward pass when using half sized memory (typically only done with input data). More...
 
bool m_bConvertTopOnBwd = true
 Specifies whether or not to convert the top on the backward pass when using half sized memory (typically not done on loss layers). More...
 
bool m_bConvertBottom = true
 Specifies whether or not the layer should convert the bottom when using half sized memory. More...
 
bool m_bReshapeOnForwardNeeded = true
 Specifies whether or not the reshape on forward is needed or not. More...
 
bool m_bNetReshapeRequest = false
 Specifies whether the reshape is requested from a Net.Reshape call or not. More...
 

Properties

override int ExactNumBottomBlobs [get]
 Returns the exact number of required bottom (intput) Blobs: prediction, label More...
 
override int ExactNumTopBlobs [get]
 Returns the exact number of required top (output) Blobs: loss More...
 
override bool AutoTopBlobs [get]
 For convenience and backwards compatibility, insturct the Net to automatically allocate a single top Blob for LossLayers, into which they output their singleton loss, (even if the user didn't specify one in the prototxt, etc.). More...
 
- Properties inherited from MyCaffe.layers.Layer< T >
virtual bool SupportsPreProcessing [get]
 Should return true when pre processing methods are overriden. More...
 
virtual bool SupportsPostProcessing [get]
 Should return true when pre postprocessing methods are overriden. More...
 
BlobCollection< T > blobs [get]
 Returns the collection of learnable parameter Blobs for the Layer. More...
 
virtual BlobCollection< T > internal_blobs [get]
 Returns the collection of internal Blobs used by the Layer. More...
 
LayerParameter layer_param [get]
 Returns the LayerParameter for this Layer. More...
 
LayerParameter.LayerType type [get]
 Returns the LayerType of this Layer. More...
 
virtual int ExactNumBottomBlobs [get]
 Returns the exact number of bottom (input) Blobs required by the Layer, or -1 if no exact number is required. More...
 
virtual int MinBottomBlobs [get]
 Returns the minimum number of bottom (input) Blobs required by the Layer, or -1 if no minimum number is required. More...
 
virtual int MaxBottomBlobs [get]
 Returns the maximum number of bottom (input) Blobs required by the Layer, or -1 if no maximum number is required. More...
 
virtual int ExactNumTopBlobs [get]
 Returns the exact number of top (output) Blobs required by the Layer, or -1 if no exact number is required. More...
 
virtual int MinTopBlobs [get]
 Returns the minimum number of top (output) Blobs required by the Layer, or -1 if no minimum number is required. More...
 
virtual int MaxTopBlobs [get]
 Returns the maximum number of top (output) Blobs required by the Layer, or -1 if no maximum number is required. More...
 
virtual bool EqualNumBottomTopBlobs [get]
 Returns true if the Layer requires and equal number of bottom (input) and top (output) Blobs. More...
 
virtual bool AutoTopBlobs [get]
 Return whether "anonymous" top (output) Blobs are created automatically by the Layer. More...
 
double forward_timing [get]
 Returns the timing of the last forward pass in milliseconds. More...
 
double forward_timing_average [get]
 Returns the average timing of the forward passes in milliseconds. More...
 
double backward_timing [get]
 Returns the timing of the last backward pass in milliseconds. More...
 
double backward_timing_average [get]
 Returns the average timing of the backward passes in milliseconds. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MyCaffe.layers.Layer< T >
static Layer< T > Create (CudaDnn< T > cuda, Log log, LayerParameter p, CancelEvent evtCancel, IXImageDatabaseBase imgDb=null, TransferInput trxinput=null)
 Create a new Layer based on the LayerParameter. More...
 
- Events inherited from MyCaffe.layers.Layer< T >
EventHandler< WorkspaceArgsOnGetWorkspace
 Specifies the OnGetWorkspace event that fires when the getWorkspace() function is called by a layer to get a shareable workspace to conserve GPU memory. More...
 
EventHandler< WorkspaceArgsOnSetWorkspace
 Specifies the OnSetWorkspace event that fires when the setWorkspace() function is called by a layer to get a shareable workspace to conserve GPU memory. More...
 
EventHandler< GetIterationArgsOnGetIteration
 Specifies the OnGetIteration event that fires when a layer needs to get the current iteration from the solver. More...
 
EventHandler< GetWorkBlobArgs< T > > OnDebug
 Specifies the OnGetWorkBlob event that is only supported when debugging to get a work blob from the primary Net holding this layer. More...
 

Detailed Description

The LossLayer provides an interface for Layer's that take two blobs as input – usually (1) predictions and (2) ground-truth labels – and output a singleton blob representing the loss. This layer is initialized with the MyCaffe.param.LossParameter.

LossLayers are typically only capable of backpropagating to their first input – the predictions.

Template Parameters
TSpecifies the base type float or double. Using float is recommended to conserve GPU memory.

Definition at line 22 of file LossLayer.cs.

Constructor & Destructor Documentation

◆ LossLayer()

MyCaffe.layers.LossLayer< T >.LossLayer ( CudaDnn< T >  cuda,
Log  log,
LayerParameter  p 
)

The LossLayer constructor.

Parameters
cudaSpecifies the CudaDnn connection to Cuda.
logSpecifies the Log for output.
pSpecifies the LayerParameter of type LOSS with parameter loss_param, with options:
  • ignore_label (optional, default null). When specified, instances with the label are ignored.
  • normalization. The normalization mode to use: FULL, VALID, or BATCH_SIZE.

Definition at line 56 of file LossLayer.cs.

Member Function Documentation

◆ AllowForceBackward()

override bool MyCaffe.layers.LossLayer< T >.AllowForceBackward ( int  nBottomIdx)
virtual

We usually cannot backpropagate to the labels; ignore force_backward for these inputs.

Parameters
nBottomIdx
Returns

Reimplemented from MyCaffe.layers.Layer< T >.

Definition at line 157 of file LossLayer.cs.

◆ get_normalizer()

virtual double MyCaffe.layers.LossLayer< T >.get_normalizer ( LossParameter.NormalizationMode  normalization_mode,
int  nValidCount 
)
protectedvirtual

Returns the normalizer used to normalize the loss.

Parameters
normalization_modeSpecifies the normalization mode to use.
nValidCountSpecifies the number of valid.
Returns
The normalization value is returned.

Definition at line 68 of file LossLayer.cs.

◆ GetNormalizer()

double MyCaffe.layers.LossLayer< T >.GetNormalizer ( LossParameter.NormalizationMode  normalization_mode,
int  nOuterNum,
int  nInnerNum,
int  nValidCount 
)

Returns the normalizer used to normalize the loss.

Parameters
normalization_modeSpecifies the normalization mode to use.
nOuterNumSpecifies the outer number.
nInnerNumSpecifies the inner number.
nValidCountSpecifies the number of valid.
Returns
The normalization value is returned.

Definition at line 82 of file LossLayer.cs.

◆ LayerSetUp()

override void MyCaffe.layers.LossLayer< T >.LayerSetUp ( BlobCollection< T >  colBottom,
BlobCollection< T >  colTop 
)
virtual

Setup the layer.

Parameters
colBottomSpecifies the collection of bottom (input) Blobs.
colTopSpecifies the collection of top (output) Blobs.

Implements MyCaffe.layers.Layer< T >.

Reimplemented in MyCaffe.layers.MemoryLossLayer< T >, MyCaffe.layers.SigmoidCrossEntropyLossLayer< T >, MyCaffe.layers.SoftmaxCrossEntropyLossLayer< T >, and MyCaffe.layers.SoftmaxLossLayer< T >.

Definition at line 170 of file LossLayer.cs.

◆ Reshape()

override void MyCaffe.layers.LossLayer< T >.Reshape ( BlobCollection< T >  colBottom,
BlobCollection< T >  colTop 
)
virtual

Reshape the bottom (input) and top (output) blobs.

Parameters
colBottomSpecifies the collection of bottom (input) Blobs.
colTopSpecifies the collection of top (output) Blobs.

Implements MyCaffe.layers.Layer< T >.

Reimplemented in MyCaffe.layers.MemoryLossLayer< T >, MyCaffe.layers.MultinomialLogisticLossLayer< T >, MyCaffe.layers.SigmoidCrossEntropyLossLayer< T >, MyCaffe.layers.SoftmaxCrossEntropyLossLayer< T >, and MyCaffe.layers.SoftmaxLossLayer< T >.

Definition at line 188 of file LossLayer.cs.

Member Data Documentation

◆ kLOG_THRESHOLD

const double MyCaffe.layers.LossLayer< T >.kLOG_THRESHOLD = 1e-20
static

Specifies the minimum threshold for loss values.

Definition at line 27 of file LossLayer.cs.

◆ m_bIgnoreLabels

bool MyCaffe.layers.LossLayer< T >.m_bIgnoreLabels = false
protected

Set to true when labels are to be ignored.

Definition at line 31 of file LossLayer.cs.

◆ m_nInnerNum

int MyCaffe.layers.LossLayer< T >.m_nInnerNum = 0
protected

Specifies the inner num, such as the channel + height + width (e.g. count(axis + 1)). Each derivative class must set this value appropriately.

Definition at line 43 of file LossLayer.cs.

◆ m_normalization

LossParameter.NormalizationMode MyCaffe.layers.LossLayer< T >.m_normalization = LossParameter.NormalizationMode.NONE
protected

Specifies the normalization mode used to normalize the loss.

Definition at line 35 of file LossLayer.cs.

◆ m_nOuterNum

int MyCaffe.layers.LossLayer< T >.m_nOuterNum = 0
protected

Specifies the outer num, such as the batch count (e.g. count(0, axis)). Each derivative class must set this value appropriately.

Definition at line 39 of file LossLayer.cs.

Property Documentation

◆ AutoTopBlobs

override bool MyCaffe.layers.LossLayer< T >.AutoTopBlobs
get

For convenience and backwards compatibility, insturct the Net to automatically allocate a single top Blob for LossLayers, into which they output their singleton loss, (even if the user didn't specify one in the prototxt, etc.).

Definition at line 146 of file LossLayer.cs.

◆ ExactNumBottomBlobs

override int MyCaffe.layers.LossLayer< T >.ExactNumBottomBlobs
get

Returns the exact number of required bottom (intput) Blobs: prediction, label

Definition at line 127 of file LossLayer.cs.

◆ ExactNumTopBlobs

override int MyCaffe.layers.LossLayer< T >.ExactNumTopBlobs
get

Returns the exact number of required top (output) Blobs: loss

Definition at line 135 of file LossLayer.cs.


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