The SettingsCaffe defines the settings used by the MyCaffe CaffeControl. More...

Inheritance diagram for MyCaffe.basecode.SettingsCaffe:

Public Member Functions
	SettingsCaffe ()
	The SettingsCaffe constructor. More...

	SettingsCaffe (SettingsCaffe s)
	The SettingsCaffe constructor that copies another SettingsCaffe instance. More...

	SettingsCaffe (SerializationInfo info, StreamingContext context)
	The SettingsCaffe constructor used during deserialization. More...

void	GetObjectData (SerializationInfo info, StreamingContext context)
	The GetObjectData is used during serialization. More...

SettingsCaffe	Clone ()
	Returns a copy of the SettingsCaffe object. More...

Properties
bool	VeriyDatasetOnLoad `[getset]`
	Get/set whether or not to verify the dataset on load (only applies when using the LOAD_ALL loading method). More...

DB_VERSION	DbVersion `[getset]`
	Get/set the version of the MyCaffeImageDatabase to use. More...

bool	EnableLabelBalancing `[getset]`
	Get/set label balancing. When enabled, first the label set is randomly selected and then the image is selected from the label set using the image selection criteria (e.g. Random). More...

bool	EnableLabelBoosting `[getset]`
	DEPRECIATED: Get/set label boosting. When using Label boosting, images are selected from boosted labels with a higher probability that images from other label sets. More...

bool	EnableRandomInputSelection `[getset]`
	Get/set random image selection. When enabled, images are randomly selected from the entire set, or randomly from a label set when label balancing is in effect. More...

bool	EnablePairInputSelection `[getset]`
	Get/set pair image selection. When using pair selection, images are queried in pairs where the first query selects the image based on the image selection criteria (e.g. Random), and then the second image query returns the image just following the first image in the database. More...

bool	UseTrainingSourceForTesting `[getset]`
	Get/set whether or not to use the training datasource when testing. More...

double	SuperBoostProbability `[getset]`
	Get/set the superboost probability used when selecting boosted images. More...

int	MaximumIterationOverride `[getset]`
	Get/set the maximum iteration override. When set, this overrides the training iterations specified in the solver description. More...

int	TestingIterationOverride `[getset]`
	Get/set the testing iteration override. When set, this overrides the testing iterations specified in the solver description. More...

string	DefaultModelGroup `[getset]`
	Get/set the default model group to use. More...

string	GpuIds `[getset]`
	Get/set the default GPU ID's to use when training. More...

DB_LOAD_METHOD	DbLoadMethod `[getset]`
	Get/set the image database loading method. More...

int	DbLoadLimit `[getset]`
	Get/set the image database load limit. More...

int	DbAutoRefreshScheduledUpdateInMs `[getset]`
	Get/set the automatic refresh scheduled udpate period (default = 10000, only applies when ImageDbLoadLimit > 0). More...

double	DbAutoRefreshScheduledReplacementPercent `[getset]`
	Get/set the automatic refresh scheduled update replacement percentage used on refresh (default = 0.3, only applies when ImageDbLoadLimit > 0). More...

bool	ItemDbLoadDataCriteria `[getset]`
	Specifies whether or not to load the image criteria data from file (default = false). More...

bool	ItemDbLoadDebugData `[getset]`
	Specifies whether or not to load the debug data from file (default = false). More...

SNAPSHOT_WEIGHT_UPDATE_METHOD	SnapshotWeightUpdateMethod `[getset]`
	Get/set the snapshot update method. More...

SNAPSHOT_LOAD_METHOD	SnapshotLoadMethod `[getset]`
	Get/set the snapshot load method. More...

bool	SkipMeanCheck `[getset]`
	Skip checking for the mean of the dataset - this is not recommended for if the mean does not exist, using the mean value from the dataset will fail. More...

Detailed Description

The SettingsCaffe defines the settings used by the MyCaffe CaffeControl.

Definition at line 13 of file SettingsCaffe.cs.

Constructor & Destructor Documentation

◆ SettingsCaffe() [1/3]

MyCaffe.basecode.SettingsCaffe.SettingsCaffe ( )

The SettingsCaffe constructor.

Definition at line 40 of file SettingsCaffe.cs.

◆ SettingsCaffe() [2/3]

MyCaffe.basecode.SettingsCaffe.SettingsCaffe ( SettingsCaffe s )

The SettingsCaffe constructor that copies another SettingsCaffe instance.

Definition at line 47 of file SettingsCaffe.cs.

◆ SettingsCaffe() [3/3]

MyCaffe.basecode.SettingsCaffe.SettingsCaffe	(	SerializationInfo	info,
		StreamingContext	context
	)

The SettingsCaffe constructor used during deserialization.

Parameters

info	Specifies the serialization information.
context	Specifies the serialization context.

Definition at line 77 of file SettingsCaffe.cs.

Member Function Documentation

◆ Clone()

SettingsCaffe MyCaffe.basecode.SettingsCaffe.Clone ( )

Returns a copy of the SettingsCaffe object.

Returns: The copy of the SettingsCaffe object is returned.

Definition at line 184 of file SettingsCaffe.cs.

◆ GetObjectData()

void MyCaffe.basecode.SettingsCaffe.GetObjectData	(	SerializationInfo	info,
		StreamingContext	context
	)

The GetObjectData is used during serialization.

Parameters

info	Specifies the serialization information.
context	Specifies the serialization context.

Definition at line 155 of file SettingsCaffe.cs.

Property Documentation

◆ DbAutoRefreshScheduledReplacementPercent

double MyCaffe.basecode.SettingsCaffe.DbAutoRefreshScheduledReplacementPercent

getset

Get/set the automatic refresh scheduled update replacement percentage used on refresh (default = 0.3, only applies when ImageDbLoadLimit > 0).

Definition at line 374 of file SettingsCaffe.cs.

◆ DbAutoRefreshScheduledUpdateInMs

int MyCaffe.basecode.SettingsCaffe.DbAutoRefreshScheduledUpdateInMs

getset

Get/set the automatic refresh scheduled udpate period (default = 10000, only applies when ImageDbLoadLimit > 0).

Definition at line 365 of file SettingsCaffe.cs.

◆ DbLoadLimit

int MyCaffe.basecode.SettingsCaffe.DbLoadLimit

getset

Get/set the image database load limit.

Definition at line 342 of file SettingsCaffe.cs.

◆ DbLoadMethod

DB_LOAD_METHOD MyCaffe.basecode.SettingsCaffe.DbLoadMethod

getset

Get/set the image database loading method.

Definition at line 333 of file SettingsCaffe.cs.

◆ DbVersion

DB_VERSION MyCaffe.basecode.SettingsCaffe.DbVersion

getset

Get/set the version of the MyCaffeImageDatabase to use.

Definition at line 225 of file SettingsCaffe.cs.

◆ DefaultModelGroup

string MyCaffe.basecode.SettingsCaffe.DefaultModelGroup

getset

Get/set the default model group to use.

Definition at line 311 of file SettingsCaffe.cs.

◆ EnableLabelBalancing

bool MyCaffe.basecode.SettingsCaffe.EnableLabelBalancing

getset

Get/set label balancing. When enabled, first the label set is randomly selected and then the image is selected from the label set using the image selection criteria (e.g. Random).

Definition at line 235 of file SettingsCaffe.cs.

◆ EnableLabelBoosting

bool MyCaffe.basecode.SettingsCaffe.EnableLabelBoosting

getset

DEPRECIATED: Get/set label boosting. When using Label boosting, images are selected from boosted labels with a higher probability that images from other label sets.

Definition at line 245 of file SettingsCaffe.cs.

◆ EnablePairInputSelection

bool MyCaffe.basecode.SettingsCaffe.EnablePairInputSelection

getset

Get/set pair image selection. When using pair selection, images are queried in pairs where the first query selects the image based on the image selection criteria (e.g. Random), and then the second image query returns the image just following the first image in the database.

Definition at line 266 of file SettingsCaffe.cs.

◆ EnableRandomInputSelection

bool MyCaffe.basecode.SettingsCaffe.EnableRandomInputSelection

getset

Get/set random image selection. When enabled, images are randomly selected from the entire set, or randomly from a label set when label balancing is in effect.

Definition at line 255 of file SettingsCaffe.cs.

◆ GpuIds

string MyCaffe.basecode.SettingsCaffe.GpuIds

getset

Get/set the default GPU ID's to use when training.

When using multi-GPU training, it is highly recommended to only train on TCC enabled drivers, otherwise driver timeouts may occur on large models.

See also: NVIDIA Tesla Compute Cluster (TCC) Help

Definition at line 324 of file SettingsCaffe.cs.

◆ ItemDbLoadDataCriteria

bool MyCaffe.basecode.SettingsCaffe.ItemDbLoadDataCriteria

getset

Specifies whether or not to load the image criteria data from file (default = false).

Definition at line 383 of file SettingsCaffe.cs.

◆ ItemDbLoadDebugData

bool MyCaffe.basecode.SettingsCaffe.ItemDbLoadDebugData

getset

Specifies whether or not to load the debug data from file (default = false).

Definition at line 392 of file SettingsCaffe.cs.

◆ MaximumIterationOverride

int MyCaffe.basecode.SettingsCaffe.MaximumIterationOverride

getset

Get/set the maximum iteration override. When set, this overrides the training iterations specified in the solver description.

Definition at line 293 of file SettingsCaffe.cs.

◆ SkipMeanCheck

bool MyCaffe.basecode.SettingsCaffe.SkipMeanCheck

getset

Skip checking for the mean of the dataset - this is not recommended for if the mean does not exist, using the mean value from the dataset will fail.

Definition at line 419 of file SettingsCaffe.cs.

◆ SnapshotLoadMethod

SNAPSHOT_LOAD_METHOD MyCaffe.basecode.SettingsCaffe.SnapshotLoadMethod

getset

Get/set the snapshot load method.

Definition at line 410 of file SettingsCaffe.cs.

◆ SnapshotWeightUpdateMethod

SNAPSHOT_WEIGHT_UPDATE_METHOD MyCaffe.basecode.SettingsCaffe.SnapshotWeightUpdateMethod

getset

Get/set the snapshot update method.

Definition at line 401 of file SettingsCaffe.cs.

◆ SuperBoostProbability

double MyCaffe.basecode.SettingsCaffe.SuperBoostProbability

getset

Get/set the superboost probability used when selecting boosted images.

Definition at line 284 of file SettingsCaffe.cs.

◆ TestingIterationOverride

int MyCaffe.basecode.SettingsCaffe.TestingIterationOverride

getset

Get/set the testing iteration override. When set, this overrides the testing iterations specified in the solver description.

Definition at line 302 of file SettingsCaffe.cs.

◆ UseTrainingSourceForTesting

bool MyCaffe.basecode.SettingsCaffe.UseTrainingSourceForTesting

getset

Get/set whether or not to use the training datasource when testing.

Definition at line 275 of file SettingsCaffe.cs.

◆ VeriyDatasetOnLoad

bool MyCaffe.basecode.SettingsCaffe.VeriyDatasetOnLoad

getset

Get/set whether or not to verify the dataset on load (only applies when using the LOAD_ALL loading method).

Definition at line 216 of file SettingsCaffe.cs.

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

C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.basecode/SettingsCaffe.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ SettingsCaffe() [1/3]

◆ SettingsCaffe() [2/3]

◆ SettingsCaffe() [3/3]

Member Function Documentation

◆ Clone()

◆ GetObjectData()

Property Documentation

◆ DbAutoRefreshScheduledReplacementPercent

◆ DbAutoRefreshScheduledUpdateInMs

◆ DbLoadLimit

◆ DbLoadMethod

◆ DbVersion

◆ DefaultModelGroup

◆ EnableLabelBalancing

◆ EnableLabelBoosting

◆ EnablePairInputSelection

◆ EnableRandomInputSelection

◆ GpuIds

◆ ItemDbLoadDataCriteria

◆ ItemDbLoadDebugData

◆ MaximumIterationOverride

◆ SkipMeanCheck

◆ SnapshotLoadMethod

◆ SnapshotWeightUpdateMethod

◆ SuperBoostProbability

◆ TestingIterationOverride

◆ UseTrainingSourceForTesting

◆ VeriyDatasetOnLoad