The IXMyCaffeState interface contains functions related to the MyCaffeComponent state. More...

Inheritance diagram for MyCaffe.common.IXMyCaffeState< T >:

Public Member Functions
void	SetOnTestOverride (EventHandler< TestArgs > onTest)
	Sets the root solver's onTest event function. More...

void	AddCancelOverrideByName (string strEvtCancel)
	Add a cancel override. More...

void	AddCancelOverride (CancelEvent evtCancel)
	Add a cancel override. More...

void	RemoveCancelOverrideByName (string strEvtCancel)
	Remove a cancel override. More...

void	RemoveCancelOverride (CancelEvent evtCancel)
	Remove a cancel override. More...

int	GetDeviceCount ()
	Returns the total number of devices installed on this computer. More...

string	GetDeviceName (int nDeviceID)
	Returns the device name of a given device ID. More...

bool	ReInitializeParameters (WEIGHT_TARGET target, params string[] rgstrLayers)
	Re-initializes each of the specified layers by re-running the filler (if any) specified by the layer. When the 'rgstr' parameter is null or otherwise empty, the blobs of all layers are re-initialized. More...

bool	VerifyCompute (string strExtra=null, int nDeviceID=-1, bool bThrowException=true)
	VerifyCompute compares the current compute of the current device (or device specified) against the required compute of the current CudaDnnDLL.dll used. More...

Properties
bool	EnableBlobDebugging `[getset]`
	Enable/disable blob debugging. More...

bool	EnableBreakOnFirstNaN `[getset]`
	Enable/disable break training after first detecting a NaN. More...

bool	EnableDetailedNanDetection `[getset]`
	When enabled (requires EnableBlobDebugging = true), the detailed Nan (and Infinity) detection is perofmed on each blob when training Net. More...

bool	EnableSingleStep `[getset]`
	Enable/disable single step training. More...

bool	EnableLayerDebugging `[getset]`
	Enable/disable layer debugging which causes each layer to check for NAN/INF on each forward/backward pass and throw an exception when found. More...

IXPersist< T >	Persist `[get]`
	Returns the persist used to load and save weights. More...

IXDatabaseBase	Database `[get]`
	Returns the in-memory MyCaffeDatabase used. More...

CancelEvent	CancelEvent `[get]`
	Returns the CancelEvent used. More...

List< int >	ActiveGpus `[get]`
	Returns a list of Active GPU's used by the control. More...

string	ActiveLabelCounts `[get]`
	Returns a string describing the active label counts observed during training. More...

string	LabelQueryHitPercents `[get]`
	Returns a string describing the label query hit percentages observed during training. More...

string	LabelQueryEpochs `[get]`
	Returns a string describing the label query epochs observed during training. More...

string	CurrentDevice `[get]`
	Returns the name of the current device used. More...

ProjectEx	CurrentProject `[get]`
	Returns the name of the currently loaded project. More...

int	CurrentIteration `[get]`
	Returns the current iteration. More...

int	MaximumIteration `[get]`
	Returns the maximum iteration. More...

Detailed Description

The IXMyCaffeState interface contains functions related to the MyCaffeComponent state.

Template Parameters

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

Definition at line 257 of file Interfaces.cs.

Member Function Documentation

◆ AddCancelOverride()

void MyCaffe.common.IXMyCaffeState< T >.AddCancelOverride ( CancelEvent evtCancel )

Add a cancel override.

Parameters

evtCancel Specifies the cancel event to add.

Implemented in MyCaffe.MyCaffeControl< T >.

◆ AddCancelOverrideByName()

void MyCaffe.common.IXMyCaffeState< T >.AddCancelOverrideByName ( string strEvtCancel )

Add a cancel override.

Parameters

strEvtCancel Specifies the name of the new cancel event to add.

Implemented in MyCaffe.MyCaffeControl< T >.

◆ GetDeviceCount()

int MyCaffe.common.IXMyCaffeState< T >.GetDeviceCount ( )

Returns the total number of devices installed on this computer.

Returns

Implemented in MyCaffe.MyCaffeControl< T >.

◆ GetDeviceName()

string MyCaffe.common.IXMyCaffeState< T >.GetDeviceName ( int nDeviceID )

Returns the device name of a given device ID.

Parameters

nDeviceID Specifies the device ID.

Returns

Implemented in MyCaffe.MyCaffeControl< T >.

◆ ReInitializeParameters()

bool MyCaffe.common.IXMyCaffeState< T >.ReInitializeParameters	(	WEIGHT_TARGET	target,
		params string[]	rgstrLayers
	)

Re-initializes each of the specified layers by re-running the filler (if any) specified by the layer.
When the 'rgstr' parameter is null or otherwise empty, the blobs of all layers are re-initialized.

Parameters

target	Specifies the weights to target (e.g. weights, bias or both).
rgstrLayers	Specifies the layers to reinitialize, when null or empty, all layers are re-initialized

Returns: If a layer is specified and found, true is returned, otherwise false is returned.

Implemented in MyCaffe.MyCaffeControl< T >.

◆ RemoveCancelOverride()

void MyCaffe.common.IXMyCaffeState< T >.RemoveCancelOverride ( CancelEvent evtCancel )

Remove a cancel override.

Parameters

evtCancel Specifies the cancel event to remove.

Implemented in MyCaffe.MyCaffeControl< T >.

◆ RemoveCancelOverrideByName()

void MyCaffe.common.IXMyCaffeState< T >.RemoveCancelOverrideByName ( string strEvtCancel )

Remove a cancel override.

Parameters

strEvtCancel Specifies the name of the new cancel event to remove.

Implemented in MyCaffe.MyCaffeControl< T >.

◆ SetOnTestOverride()

void MyCaffe.common.IXMyCaffeState< T >.SetOnTestOverride ( EventHandler< TestArgs > onTest )

Sets the root solver's onTest event function.

Parameters

onTest Specifies the event handler called when testing.

Implemented in MyCaffe.MyCaffeControl< T >.

◆ VerifyCompute()

bool MyCaffe.common.IXMyCaffeState< T >.VerifyCompute	(	string	strExtra = `null`,
		int	nDeviceID = `-1`,
		bool	bThrowException = `true`
	)

VerifyCompute compares the current compute of the current device (or device specified) against the required compute of the current CudaDnnDLL.dll used.

Parameters

strExtra	Optionally, specifies extra information for the exception if one is thrown.
nDeviceID	Optionally, specifies a specific device ID to check, otherwise uses the current device used (default = -1, which uses the current device).
bThrowException	Optionally, specifies whether or not to throw an exception on a compute mis-match (default = true).

Returns: If the device's compute is >= to the required compute fo the CudaDnnDll.dll used, true is returned, otherwise false is returned.

Implemented in MyCaffe.MyCaffeControl< T >.

Property Documentation

◆ ActiveGpus

List<int> MyCaffe.common.IXMyCaffeState< T >.ActiveGpus

get

Returns a list of Active GPU's used by the control.

Definition at line 338 of file Interfaces.cs.

◆ ActiveLabelCounts

string MyCaffe.common.IXMyCaffeState< T >.ActiveLabelCounts

get

Returns a string describing the active label counts observed during training.

This string can help diagnos label balancing issue.

Definition at line 345 of file Interfaces.cs.

◆ CancelEvent

CancelEvent MyCaffe.common.IXMyCaffeState< T >.CancelEvent

get

Returns the CancelEvent used.

Definition at line 334 of file Interfaces.cs.

◆ CurrentDevice

string MyCaffe.common.IXMyCaffeState< T >.CurrentDevice

get

Returns the name of the current device used.

Definition at line 363 of file Interfaces.cs.

◆ CurrentIteration

int MyCaffe.common.IXMyCaffeState< T >.CurrentIteration

get

Returns the current iteration.

Definition at line 371 of file Interfaces.cs.

◆ CurrentProject

ProjectEx MyCaffe.common.IXMyCaffeState< T >.CurrentProject

get

Returns the name of the currently loaded project.

Definition at line 367 of file Interfaces.cs.

◆ Database

IXDatabaseBase MyCaffe.common.IXMyCaffeState< T >.Database

get

Returns the in-memory MyCaffeDatabase used.

Definition at line 329 of file Interfaces.cs.

◆ EnableBlobDebugging

bool MyCaffe.common.IXMyCaffeState< T >.EnableBlobDebugging

getset

Enable/disable blob debugging.

Note, when enabled, training will dramatically slow down.

Definition at line 295 of file Interfaces.cs.

◆ EnableBreakOnFirstNaN

bool MyCaffe.common.IXMyCaffeState< T >.EnableBreakOnFirstNaN

getset

Enable/disable break training after first detecting a NaN.

This option requires that EnableBlobDebugging == true.

Definition at line 302 of file Interfaces.cs.

◆ EnableDetailedNanDetection

bool MyCaffe.common.IXMyCaffeState< T >.EnableDetailedNanDetection

getset

When enabled (requires EnableBlobDebugging = true), the detailed Nan (and Infinity) detection is perofmed on each blob when training Net.

Definition at line 306 of file Interfaces.cs.

◆ EnableLayerDebugging

bool MyCaffe.common.IXMyCaffeState< T >.EnableLayerDebugging

getset

Enable/disable layer debugging which causes each layer to check for NAN/INF on each forward/backward pass and throw an exception when found.

This option dramatically slows down training and is only recommended during debugging.

Definition at line 320 of file Interfaces.cs.

◆ EnableSingleStep

bool MyCaffe.common.IXMyCaffeState< T >.EnableSingleStep

getset

Enable/disable single step training.

This option requires that EnableBlobDebugging == true.

Definition at line 313 of file Interfaces.cs.

◆ LabelQueryEpochs

string MyCaffe.common.IXMyCaffeState< T >.LabelQueryEpochs

get

Returns a string describing the label query epochs observed during training.

This string can help diagnose label balancing issue.

Definition at line 359 of file Interfaces.cs.

◆ LabelQueryHitPercents

string MyCaffe.common.IXMyCaffeState< T >.LabelQueryHitPercents

get

Returns a string describing the label query hit percentages observed during training.

This string can help diagnose label balancing issue.

Definition at line 352 of file Interfaces.cs.

◆ MaximumIteration

int MyCaffe.common.IXMyCaffeState< T >.MaximumIteration

get

Returns the maximum iteration.

Definition at line 375 of file Interfaces.cs.

◆ Persist

IXPersist<T> MyCaffe.common.IXMyCaffeState< T >.Persist

get

Returns the persist used to load and save weights.

Definition at line 325 of file Interfaces.cs.

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

C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe/common/Interfaces.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AddCancelOverride()

◆ AddCancelOverrideByName()

◆ GetDeviceCount()

◆ GetDeviceName()

◆ ReInitializeParameters()

◆ RemoveCancelOverride()

◆ RemoveCancelOverrideByName()

◆ SetOnTestOverride()

◆ VerifyCompute()

Property Documentation

◆ ActiveGpus

◆ ActiveLabelCounts

◆ CancelEvent

◆ CurrentDevice

◆ CurrentIteration

◆ CurrentProject

◆ Database

◆ EnableBlobDebugging

◆ EnableBreakOnFirstNaN

◆ EnableDetailedNanDetection

◆ EnableLayerDebugging

◆ EnableSingleStep

◆ LabelQueryEpochs

◆ LabelQueryHitPercents

◆ MaximumIteration

◆ Persist