MyCaffe  0.11.2.9-beta1
Deep learning software for Windows C# programmers.
MyCaffe.basecode.SettingsCaffe Class Reference

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 [get, set]
 Get/set whether or not to verify the dataset on load (only applies when using the LOAD_ALL loading method). More...
 
IMGDB_VERSION ImageDbVersion [get, set]
 Get/set the version of the MyCaffeImageDatabase to use. More...
 
bool EnableLabelBalancing [get, set]
 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 [get, set]
 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 [get, set]
 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 [get, set]
 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 [get, set]
 Get/set whether or not to use the training datasource when testing. More...
 
double SuperBoostProbability [get, set]
 Get/set the superboost probability used when selecting boosted images. More...
 
int MaximumIterationOverride [get, set]
 Get/set the maximum iteration override. When set, this overrides the training iterations specified in the solver description. More...
 
int TestingIterationOverride [get, set]
 Get/set the testing iteration override. When set, this overrides the testing iterations specified in the solver description. More...
 
string DefaultModelGroup [get, set]
 Get/set the default model group to use. More...
 
string GpuIds [get, set]
 Get/set the default GPU ID's to use when training. More...
 
IMAGEDB_LOAD_METHOD ImageDbLoadMethod [get, set]
 Get/set the image database loading method. More...
 
int ImageDbLoadLimit [get, set]
 Get/set the image database load limit. More...
 
int ImageDbAutoRefreshScheduledUpdateInMs [get, set]
 Get/set the automatic refresh scheduled udpate period (default = 10000, only applies when ImageDbLoadLimit > 0). More...
 
double ImageDbAutoRefreshScheduledReplacementPercent [get, set]
 Get/set the automatic refresh scheduled update replacement percentage used on refresh (default = 0.3, only applies when ImageDbLoadLimit > 0). More...
 
bool ImageDbLoadDataCriteria [get, set]
 Specifies whether or not to load the image criteria data from file (default = false). More...
 
bool ImageDbLoadDebugData [get, set]
 Specifies whether or not to load the debug data from file (default = false). More...
 
SNAPSHOT_WEIGHT_UPDATE_METHOD SnapshotWeightUpdateMethod [get, set]
 Get/set the snapshot update method. More...
 
SNAPSHOT_LOAD_METHOD SnapshotLoadMethod [get, set]
 Get/set the snapshot load method. More...
 
bool SkipMeanCheck [get, set]
 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
infoSpecifies the serialization information.
contextSpecifies 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
infoSpecifies the serialization information.
contextSpecifies the serialization context.

Definition at line 155 of file SettingsCaffe.cs.

Property Documentation

◆ DefaultModelGroup

string MyCaffe.basecode.SettingsCaffe.DefaultModelGroup
getset

Get/set the default model group to use.

Definition at line 312 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 236 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 246 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 267 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 256 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 325 of file SettingsCaffe.cs.

◆ ImageDbAutoRefreshScheduledReplacementPercent

double MyCaffe.basecode.SettingsCaffe.ImageDbAutoRefreshScheduledReplacementPercent
getset

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

Definition at line 375 of file SettingsCaffe.cs.

◆ ImageDbAutoRefreshScheduledUpdateInMs

int MyCaffe.basecode.SettingsCaffe.ImageDbAutoRefreshScheduledUpdateInMs
getset

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

Definition at line 366 of file SettingsCaffe.cs.

◆ ImageDbLoadDataCriteria

bool MyCaffe.basecode.SettingsCaffe.ImageDbLoadDataCriteria
getset

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

Definition at line 384 of file SettingsCaffe.cs.

◆ ImageDbLoadDebugData

bool MyCaffe.basecode.SettingsCaffe.ImageDbLoadDebugData
getset

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

Definition at line 393 of file SettingsCaffe.cs.

◆ ImageDbLoadLimit

int MyCaffe.basecode.SettingsCaffe.ImageDbLoadLimit
getset

Get/set the image database load limit.

Definition at line 343 of file SettingsCaffe.cs.

◆ ImageDbLoadMethod

IMAGEDB_LOAD_METHOD MyCaffe.basecode.SettingsCaffe.ImageDbLoadMethod
getset

Get/set the image database loading method.

Definition at line 334 of file SettingsCaffe.cs.

◆ ImageDbVersion

IMGDB_VERSION MyCaffe.basecode.SettingsCaffe.ImageDbVersion
getset

Get/set the version of the MyCaffeImageDatabase to use.

Definition at line 226 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 294 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 420 of file SettingsCaffe.cs.

◆ SnapshotLoadMethod

SNAPSHOT_LOAD_METHOD MyCaffe.basecode.SettingsCaffe.SnapshotLoadMethod
getset

Get/set the snapshot load method.

Definition at line 411 of file SettingsCaffe.cs.

◆ SnapshotWeightUpdateMethod

SNAPSHOT_WEIGHT_UPDATE_METHOD MyCaffe.basecode.SettingsCaffe.SnapshotWeightUpdateMethod
getset

Get/set the snapshot update method.

Definition at line 402 of file SettingsCaffe.cs.

◆ SuperBoostProbability

double MyCaffe.basecode.SettingsCaffe.SuperBoostProbability
getset

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

Definition at line 285 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 303 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 276 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 217 of file SettingsCaffe.cs.


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