The BasePrefetchingDataLayer is the base class for data Layers that pre-fetch data before feeding the Blobs of data into the Net. More...

Inheritance diagram for MyCaffe.layers.BasePrefetchingDataLayer< T >:

Public Member Functions
	BasePrefetchingDataLayer (CudaDnn< T > cuda, Log log, LayerParameter p, IXDatabaseBase db, CancelEvent evtCancel)
	The BaseDataLayer constructor. More...

override void	LayerSetUp (BlobCollection< T > colBottom, BlobCollection< T > colTop)
	LayerSetUp implements common data layer setup functonality, and calls DatLayerSetUp to do special data layer setup for individual layer types. More...

Public Member Functions inherited from MyCaffe.layers.BaseDataLayer< T >
	BaseDataLayer (CudaDnn< T > cuda, Log log, LayerParameter p, IXDatabaseBase db)
	The BaseDataLayer constructor. More...

override void	Reshape (BlobCollection< T > colBottom, BlobCollection< T > colTop)
	Data layers have no bottoms, so reshaping is trivial. 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 void	ConnectLoss (LossLayer< T > layer)
	Called to connect the loss OnLoss event to a specified layer (typically the data layer). More...

virtual BlobCollection< T >	PreProcessInput (PropertySet customInput, out int nSeqLen, 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 bool	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 (e.g., detokenizing). More...

virtual List< Tuple< string, int, double > >	PostProcessLogitsOutput (int nCurIdx, Blob< T > blobLogits, Layer< T > softmax, int nAxis, int nK=1)
	The PostProcessLogitsOutput allows derivative data layers to post-process the results, converting them back into text results (e.g., detokenizing). More...

virtual string	PostProcessFullOutput (Blob< T > blobSoftmax)
	The PostProcessFullOutput allows derivative data layers to post-process the results, usually be detokenizing the data in the blobSoftmax. 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...

virtual bool	AllowForceBackward (int nBottomIdx)
	Return whether to allow 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...

Protected Member Functions
virtual void	preStop ()
	The preStop method is called just before stopping the internal thread. Overriding this method gives derivative classes a chance to cancel any waiting objects. More...

override void	dispose ()
	Releases all GPU and host resources used by the Layer. More...

void	statupPrefetch ()
	Starts the prefetch thread. More...

virtual void	final_process (Blob< T > blobTop)
	Provides a final processing step that may be utilized by derivative classes. More...

override void	forward (BlobCollection< T > colBottom, BlobCollection< T > colTop)
	The forward override implements the functionality to load pre-fetch data and feed it into the top (output) Blobs. More...

abstract void	load_batch (Batch< T > batch)
	The load_batch abstract function should be overriden by each derivative data Layer to load a batch of data. More...

Protected Member Functions inherited from MyCaffe.layers.BaseDataLayer< T >
virtual bool	setupSourceDescriptor ()
	Allows any derivative classes to pre-initialize the m_src which is used in LayerSetup before the DataLayerSetup. More...

abstract void	DataLayerSetUp (BlobCollection< T > colBottom, BlobCollection< T > colTop)
	Override this method to perform the actual data loading. More...

override void	backward (BlobCollection< T > colTop, List< bool > rgbPropagateDown, BlobCollection< T > colBottom)
	Not implemented - data Layers do not perform backward. More...

Protected Member Functions inherited from MyCaffe.layers.Layer< T >
void	dispose (ref Layer< T > l)
	Helper method used to dispose internal layers. More...

void	dispose (ref Blob< T > b)
	Helper method used to dispose internal blobs. More...

void	dispose (ref BlobCollection< T > rg, bool bSetToNull=true)
	Dispose the blob collection. 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...

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

void	setShapes (BlobCollection< T > colBottom, BlobCollection< T > colTop)
	Set the internal shape sizes - used when determining if a Reshape is necessary. More...

virtual void	setup_internal_blobs (BlobCollection< T > col)
	Derivative layers should add all internal blobws to the 'col' provided. 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...

LayerParameter	convertLayerParam (LayerParameter pChild, LayerParameter pParent)
	Called to convert a parent LayerParameterEx, used in blob sharing, with a child layer parameter. More...

bool	shareParameter (Blob< T > b, List< int > rgMinShape, bool bAllowEndsWithComparison=false)
	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 lSizeInBytes)
	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...

T	convert (double df)
	Converts a double to a generic. More...

T	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
Batch< T >[]	m_rgPrefetch
	Specifies the pre-fetch cache. More...

CancelEvent	m_evtCancel
	Specifies the cancellation event for the internal thread. More...

Protected Attributes inherited from MyCaffe.layers.BaseDataLayer< T >
DataTransformer< T >	m_transformer
	Specifies the DataTransformer used to transform each data item as it loaded. More...

bool	m_bOutputLabels
	Specifies whether or not the Layer should output labels. More...

IXImageDatabaseBase	m_imgdb
	Specifies the MyCaffeImageDatabase. More...

SourceDescriptor	m_src
	Specifies the SourceDescriptor of the data source. More...

SimpleDatum	m_imgMean = null
	Specifies the SimpleDatum that optionally contains the image Mean for data centering. 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...

BlobCollection< T >	m_colInternalBlobs = new BlobCollection<T>()
	Specifies internal blobs used by 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...

T	m_tOne
	Specifies a generic type equal to 1.0. More...

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

LayerParameter.? LayerType	m_parentLayerType = null
	Specifies the layer type of the parent. More...

Properties
virtual bool	delayPrefetch `[get]`
	Specifies whether or not to delay the prefetch. More...

Properties inherited from MyCaffe.layers.BaseDataLayer< T >
SimpleDatum	ImageMean `[getset]`
	Get/set the image mean. More...

DataTransformer< T >	Transformer `[get]`
	Returns the data transformer used. More...

Properties inherited from MyCaffe.layers.Layer< T >
LayerParameter.? LayerType	parent_layer_type `[get]`
	Optionally, specifies the parent layer type (e.g. LOSS, etc.) More...

virtual bool	SupportsPreProcessing `[get]`
	Should return true when PreProcessing methods are overriden. More...

virtual bool	SupportsPostProcessing `[get]`
	Should return true when pre PostProcessing methods are overriden. More...

virtual bool	SupportsPostProcessingLogits `[get]`
	Should return true when pre PostProcessingLogits methods are overriden. More...

virtual bool	SupportsPostProcessingFullOutput `[get]`
	Should return true when PostProcessingFullOutput is supported. More...

BlobCollection< T >	blobs `[get]`
	Returns the collection of learnable parameter Blobs for the Layer. More...

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, IXDatabaseBase db=null, TransferInput trxinput=null)
	Create a new Layer based on the LayerParameter. More...

Events inherited from MyCaffe.layers.Layer< T >
EventHandler< WorkspaceArgs >	OnGetWorkspace
	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< WorkspaceArgs >	OnSetWorkspace
	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< GetIterationArgs >	OnGetIteration
	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 BasePrefetchingDataLayer is the base class for data Layers that pre-fetch data before feeding the Blobs of data into the Net.

Template Parameters

T	Specifies the base type float or double. Using float is recommended to conserve GPU memory.

Definition at line 18 of file BasePrefetchingDataLayer.cs.

Constructor & Destructor Documentation

◆ BasePrefetchingDataLayer()

MyCaffe.layers.BasePrefetchingDataLayer< T >.BasePrefetchingDataLayer	(	CudaDnn< T >	cuda,
		Log	log,
		LayerParameter	p,
		IXDatabaseBase	db,
		CancelEvent	evtCancel
	)

The BaseDataLayer constructor.

Parameters

cuda	Specifies the CudaDnn connection to Cuda.
log	Specifies the Log for output.
p	Specifies the LayerParameter
db	Specifies the external database to use.
evtCancel	Specifies the CancelEvent used to cancel any pre-fetching operations.

Definition at line 42 of file BasePrefetchingDataLayer.cs.

Member Function Documentation

◆ dispose()

override void MyCaffe.layers.BasePrefetchingDataLayer< T >.dispose ( )

protectedvirtual

Releases all GPU and host resources used by the Layer.

Reimplemented from MyCaffe.layers.BaseDataLayer< T >.

Reimplemented in MyCaffe.layers.DataLayer< T >, and MyCaffe.layers.ImageDataLayer< T >.

Definition at line 89 of file BasePrefetchingDataLayer.cs.

◆ final_process()

virtual void MyCaffe.layers.BasePrefetchingDataLayer< T >.final_process ( Blob< T > blobTop )

protectedvirtual

Provides a final processing step that may be utilized by derivative classes.

Parameters

blobTop Specifies the top blob just about to be set out the forward operation as the Top[0] blob.

Reimplemented in MyCaffe.layers.DataLayer< T >.

Definition at line 211 of file BasePrefetchingDataLayer.cs.

◆ forward()

override void MyCaffe.layers.BasePrefetchingDataLayer< T >.forward	(	BlobCollection< T >	colBottom,
		BlobCollection< T >	colTop
	)

protectedvirtual

The forward override implements the functionality to load pre-fetch data and feed it into the top (output) Blobs.

Parameters

colBottom	Not used.
colTop	Specifies the collection of top (output) Blobs.

Implements MyCaffe.layers.Layer< T >.

Definition at line 222 of file BasePrefetchingDataLayer.cs.

◆ LayerSetUp()

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

virtual

LayerSetUp implements common data layer setup functonality, and calls DatLayerSetUp to do special data layer setup for individual layer types.

This method should not be overriden.

Parameters

colBottom	Not used.
colTop	Specifies the collection of top (output) Blobs.

Reimplemented from MyCaffe.layers.BaseDataLayer< T >.

Definition at line 117 of file BasePrefetchingDataLayer.cs.

◆ load_batch()

abstract void MyCaffe.layers.BasePrefetchingDataLayer< T >.load_batch ( Batch< T > batch )

protectedpure virtual

The load_batch abstract function should be overriden by each derivative data Layer to load a batch of data.

Parameters

batch Specifies the Batch of data loaded.

Implemented in MyCaffe.layers.ssd.AnnotatedDataLayer< T >, MyCaffe.layers.ssd.VideoDataLayer< T >, MyCaffe.layers.DataLayer< T >, and MyCaffe.layers.ImageDataLayer< T >.

◆ preStop()

virtual void MyCaffe.layers.BasePrefetchingDataLayer< T >.preStop ( )

protectedvirtual

The preStop method is called just before stopping the internal thread. Overriding this method gives derivative classes a chance to cancel any waiting objects.

Reimplemented in MyCaffe.layers.DataLayer< T >.

Definition at line 84 of file BasePrefetchingDataLayer.cs.