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

The ProjectEx class manages a project containing the solver description, model description, data set (with training data source and testing data source) and project results. More...

Public Member Functions

 ProjectEx (string strName, string strDsName=null)
 The ProjectEx constructor. More...
 
 ProjectEx (ProjectDescriptor prj, StateDescriptor state=null, bool bExistTrain=false, bool bExistTest=false, bool bQueryModel=true, bool bQuerySolver=true)
 The ProjectEx constructor. More...
 
bool RequiresDataCriteria ()
 Returns whether or not the data criteria is required by the current project model (e.g. the model contains an AnnotatedData layer). More...
 
string GetCustomTrainer (out string strProperties)
 Returns the custom trainer and properties used by the project (if any). More...
 
int GetBatchSize (Phase phase)
 Returns the batch size of the project used in a given Phase. More...
 
double GetLayerSetting (Phase phase, string strLayer, string strParam)
 Returns the setting of a Layer (if found). More...
 
string GetSolverSetting (string strParam)
 Get a setting from the solver descriptor. More...
 
double GetSolverSettingAsNumeric (string strParam)
 Get a setting from the solver descriptor as a double value. More...
 
int GetSolverSettingAsInt (string strParam)
 Get a setting from the solver descriptor as an integer value. More...
 
bool GetSolverSettingAsBool (string strParam)
 Get a setting from the solver descriptor as a boolean value. More...
 
bool SetSolverVariable (string strVar, string strVal)
 Set a given Solver variable in the solver description script. More...
 
void LoadSolverFile (string strFile)
 Load the solver description from a file. More...
 
void LoadModelFile (string strFile)
 Load the model description from a file. More...
 
RawProto CreateModelForRunning (string strName, int nNum, int nChannels, int nHeight, int nWidth, out RawProto protoTransform, Stage stage=Stage.NONE, bool bSkipLossLayer=false)
 Create a model description as a RawProto for running the Project. More...
 
void SetDataset (DatasetDescriptor dataset)
 Sets the dataset used by the Project, overriding the current dataset used. More...
 
bool DisableTesting ()
 Disables the testing interval so that no test passes are run. More...
 
override string ToString ()
 Returns a string representation of the Project. More...
 

Static Public Member Functions

static RawProto CreateModelForTraining (string strModelDescription, string strName, bool bCaffeFormat=false)
 Create a model description as a RawProto for training the Project. More...
 
static RawProto CreateModelForRunning (string strModelDescription, string strName, int nNum, int nChannels, int nHeight, int nWidth, out RawProto protoTransform, Stage stage=Stage.NONE, bool bSkipLossLayer=false)
 Create a model description as a RawProto for running the Project. More...
 
static string SetDataset (string strModelDesc, DatasetDescriptor dataset, out bool bResized, bool bUpdateOutputs=false)
 Sets the dataset of a model, overriding the current dataset used. More...
 
static string FindLayerParameter (string strModelDescription, string strLayerName, string strLayerType, string strParam, string strField, Phase phaseMatch=Phase.NONE)
 This method searches for a given parameter within a given layer, optionally for a certain Phase. More...
 

Properties

bool DatasetAdjusted [get, set]
 Get/set whether or not the dataset for the project has been changed. More...
 
SettingsCaffe Settings [get, set]
 Get/set the Caffe setting to use with the Project. More...
 
string Name [get, set]
 Get/set the name of the Project. More...
 
int ID [get]
 Returns the ID of the Project in the database. More...
 
int OriginalID [get, set]
 Get/set the original project ID. More...
 
string Owner [get, set]
 Get/set the ID of the Project owner. More...
 
bool Active [get]
 Returns whether or not the Project is active. More...
 
TRAINING_CATEGORY TrainingCategory [get]
 Returns the training category of the project, or NONE if no custom trainer is used. More...
 
Stage Stage [get, set]
 Return the stage under which the project was opened. More...
 
double SuperBoostProbability [get, set]
 Get/set the super boost probability used by the Project. More...
 
bool UseTrainingSourceForTesting [get]
 Returns whether or not the Project uses the training data source when testing (default = false). More...
 
bool EnableLabelBalancing [get]
 Returns whether or not label balancing is enabled. 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]
 Returns whether or not label boosting is enabled. When using Label boosting, images are selected from boosted labels with a higher probability that images from other label sets. More...
 
bool EnableRandomSelection [get]
 Returns whether or not random image selection is enabled. When enabled, images are randomly selected from the entire set, or randomly from a label set when label balancing is in effect. More...
 
bool EnablePairSelection [get]
 Returns whether or not pair selection is enabled. 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...
 
string GpuOverride [get]
 Returns the list of comma separated GPU ID's that are to be used when training this Project. More...
 
IMAGEDB_LOAD_METHOD ImageLoadMethod [get]
 Returns the method used to load the images into memory. Loading all images into memory has the highest training performance for memory access is much faster than disk acces (even with an SSD). More...
 
int ImageLoadLimit [get]
 Returns the image load limit. More...
 
int ImageLoadLimitRefreshPeriod [get]
 Returns the image load limit refresh period in milliseconds. More...
 
double ImageLoadLimitRefreshPercent [get]
 Returns the image load limit refresh percentage (to update). More...
 
SNAPSHOT_WEIGHT_UPDATE_METHOD SnapshotWeightUpdateMethod [get]
 Returns the snapshot weight update favor. The snapshot can favor an improving accuracy, decreasing error, or both when saving weights. More...
 
SNAPSHOT_LOAD_METHOD SnapshotLoadMethod [get]
 Returns the snapshot load method. When loading the best error or accuracy, the snapshot loaded may not be the last one taken. More...
 
string SolverDescription [get, set]
 Get/set the solver description script used by the Project. More...
 
string ModelDescription [get, set]
 Get/set the model description script used by the Project. More...
 
GroupDescriptor ProjectGroup [get]
 Return the project group descriptor of the group that the Project resides (if any). More...
 
GroupDescriptor ModelGroup [get]
 Return the model group descriptor of the group that the Project participates in (if any). More...
 
GroupDescriptor DatasetGroup [get]
 Return the dataset group descriptor of the group that the Project participates in (if any). More...
 
ParameterDescriptorCollection Parameters [get]
 Returns any project parameters that may exist (if any). More...
 
int TotalIterations [get, set]
 Get/set the total number of iterations that the Project has been trained. More...
 
bool HasResults [get]
 Return whether or not the project has results from a training session. More...
 
int Iterations [get, set]
 Get/set the current number of iterations that the Project has been trained. More...
 
double BestAccuracy [get, set]
 Get/set the best accuracy observed while testing the Project. More...
 
double BestError [get, set]
 Get/set the best error observed while training the Project. More...
 
byte [] SolverState [get, set]
 Get/set the solver state. More...
 
byte [] WeightsState [get, set]
 Get/set the weight state. More...
 
string DatasetName [get]
 Return the name of the dataset used. More...
 
DatasetDescriptor Dataset [get]
 Return the descriptor of the dataset used. More...
 
DatasetDescriptor DatasetTarget [get]
 Returns the target dataset (if exists) or null if it does not. More...
 
int TargetDatasetID [get, set]
 Get/set the dataset ID of the target dataset (if exists), otherwise return 0. More...
 
bool ExistTestResults [get]
 Return whether or not testing results exist. More...
 
bool ExistTrainResults [get]
 Return whether or not training results exist. More...
 
ValueDescriptorCollection ProjectPerformanceItems [get]
 Return Project performance metrics. More...
 
string ModelName [get]
 Return the name of the model used by the Project. More...
 
string SolverType [get]
 Return the type of the Solver used by the Project. More...
 

Events

EventHandler< OverrideProjectArgsOnOverrideModel
 The OverrrideModel event fires each time the SetDataset function is called. More...
 
EventHandler< OverrideProjectArgsOnOverrideSolver
 The OverrideSolver event fires each time the SetDataset function is called. More...
 

Detailed Description

The ProjectEx class manages a project containing the solver description, model description, data set (with training data source and testing data source) and project results.

Definition at line 14 of file ProjectEx.cs.

Constructor & Destructor Documentation

◆ ProjectEx() [1/2]

MyCaffe.basecode.ProjectEx.ProjectEx ( string  strName,
string  strDsName = null 
)

The ProjectEx constructor.

Parameters
strNameSpecifies the name of the project.
strDsNameOptionally, specifies the name of the dataset used by the project.

Definition at line 41 of file ProjectEx.cs.

◆ ProjectEx() [2/2]

MyCaffe.basecode.ProjectEx.ProjectEx ( ProjectDescriptor  prj,
StateDescriptor  state = null,
bool  bExistTrain = false,
bool  bExistTest = false,
bool  bQueryModel = true,
bool  bQuerySolver = true 
)

The ProjectEx constructor.

Parameters
prjSpecifies the project descriptor for the project.
stateSpecifies the state descriptor for the project.
bExistTrainSpecifies whether or not training results exist for the proejct.
bExistTestSpecifies whether or not testing results exist for the project.
bQueryModelOptionally, specifies whether or not to set (and parse) the model.
bQuerySolverOptionally, specifies whether or not to set (and parse) the solver.

Definition at line 57 of file ProjectEx.cs.

Member Function Documentation

◆ CreateModelForRunning() [1/2]

RawProto MyCaffe.basecode.ProjectEx.CreateModelForRunning ( string  strName,
int  nNum,
int  nChannels,
int  nHeight,
int  nWidth,
out RawProto  protoTransform,
Stage  stage = Stage.NONE,
bool  bSkipLossLayer = false 
)

Create a model description as a RawProto for running the Project.

Parameters
strNameSpecifies the model name.
nNumSpecifies the batch size to use.
nChannelsSpecifies the number of channels of each item in the batch.
nHeightSpecifies the height of each item in the batch.
nWidthSpecifies the width of each item in the batch.
protoTransformReturns a RawProto describing the Data Transformation parameters to use.
stageOptionally, specifies the stage to create the run network on.
bSkipLossLayerOptionally, specifies to skip the loss layer and not output a converted layer to replace it (default = false).
Returns
The RawProto of the model description is returned.

Definition at line 1024 of file ProjectEx.cs.

◆ CreateModelForRunning() [2/2]

static RawProto MyCaffe.basecode.ProjectEx.CreateModelForRunning ( string  strModelDescription,
string  strName,
int  nNum,
int  nChannels,
int  nHeight,
int  nWidth,
out RawProto  protoTransform,
Stage  stage = Stage.NONE,
bool  bSkipLossLayer = false 
)
static

Create a model description as a RawProto for running the Project.

Parameters
strModelDescriptionSpecifies the model description to use.
strNameSpecifies the model name.
nNumSpecifies the batch size to use.
nChannelsSpecifies the number of channels of each item in the batch.
nHeightSpecifies the height of each item in the batch.
nWidthSpecifies the width of each item in the batch.
protoTransformReturns a RawProto describing the Data Transformation parameters to use.
stageOptionally, specifies the stage to create the run network on.
bSkipLossLayerOptionally, specifies to skip the loss layer and not output a converted layer to replace it (default = false).
Returns
The RawProto of the model description is returned.

Definition at line 1291 of file ProjectEx.cs.

◆ CreateModelForTraining()

static RawProto MyCaffe.basecode.ProjectEx.CreateModelForTraining ( string  strModelDescription,
string  strName,
bool  bCaffeFormat = false 
)
static

Create a model description as a RawProto for training the Project.

Parameters
strModelDescriptionSpecifies the model description.
strNameSpecifies the model name.
bCaffeFormatSpecifies whether or not the model description should use the native C++ caffe format where coloring is ordered in BGR, or use the MyCaffe format where coloring is ordered in RGB.
Returns
The RawProto of the model description is returned.

Definition at line 1036 of file ProjectEx.cs.

◆ DisableTesting()

bool MyCaffe.basecode.ProjectEx.DisableTesting ( )

Disables the testing interval so that no test passes are run.

Returns
Returns true if the testing was disabled, false if it was not setup in the first place.

Definition at line 1993 of file ProjectEx.cs.

◆ FindLayerParameter()

static string MyCaffe.basecode.ProjectEx.FindLayerParameter ( string  strModelDescription,
string  strLayerName,
string  strLayerType,
string  strParam,
string  strField,
Phase  phaseMatch = Phase.NONE 
)
static

This method searches for a given parameter within a given layer, optionally for a certain Phase.

An example usage may be: layer = 'data', param = 'data_param', field = 'source'

Parameters
strModelDescriptionSpecifies the model description to search.
strLayerNameSpecifies the name of the layer, when null only the layer type is used..
strLayerTypeSpecifies the type of the layer.
strParamSpecifies the name of the parameter, such as 'data_param'.
strFieldSpecifies the field of the parameter, such as 'source'.
phaseMatchOptionally, specifies the phase.
Returns
If found, the parameter value is returned, otherwise null is returned.

Definition at line 1931 of file ProjectEx.cs.

◆ GetBatchSize()

int MyCaffe.basecode.ProjectEx.GetBatchSize ( Phase  phase)

Returns the batch size of the project used in a given Phase.

Parameters
phaseSpecifies the Phase to use.
Returns
The batch size is returned.

Definition at line 359 of file ProjectEx.cs.

◆ GetCustomTrainer()

string MyCaffe.basecode.ProjectEx.GetCustomTrainer ( out string  strProperties)

Returns the custom trainer and properties used by the project (if any).

Parameters
strPropertiesSpecifies the properties associated with the custom trainer. The properties are stored in the solver parameter field 'custom_trainer_propeties' as a list of comma ('=') separated key value pairs each separated by ';'

An example set of properties uses the following format: key1=val1;key2=val2;...

Returns
The custom trainer name is returned.

Definition at line 312 of file ProjectEx.cs.

◆ GetLayerSetting()

double MyCaffe.basecode.ProjectEx.GetLayerSetting ( Phase  phase,
string  strLayer,
string  strParam 
)

Returns the setting of a Layer (if found).

Parameters
phaseSpecifies the Phase to use.
strLayerSpecifies the Layer name.
strParamSpecifies the Layer setting name to look for.
Returns
If found the setting value is returned, otherwise null is returned.

Definition at line 402 of file ProjectEx.cs.

◆ GetSolverSetting()

string MyCaffe.basecode.ProjectEx.GetSolverSetting ( string  strParam)

Get a setting from the solver descriptor.

Parameters
strParamSpecifies the setting to retrieve.
Returns
The setting is returned if found, otherwise null is returned.

Definition at line 437 of file ProjectEx.cs.

◆ GetSolverSettingAsBool()

bool MyCaffe.basecode.ProjectEx.GetSolverSettingAsBool ( string  strParam)

Get a setting from the solver descriptor as a boolean value.

Parameters
strParamSpecifies the setting to retrieve.
Returns
The setting is returned as a bool if found, otherwise null is returned.

Definition at line 486 of file ProjectEx.cs.

◆ GetSolverSettingAsInt()

int MyCaffe.basecode.ProjectEx.GetSolverSettingAsInt ( string  strParam)

Get a setting from the solver descriptor as an integer value.

Parameters
strParamSpecifies the setting to retrieve.
Returns
The setting is returned as a int if found, otherwise null is returned.

Definition at line 472 of file ProjectEx.cs.

◆ GetSolverSettingAsNumeric()

double MyCaffe.basecode.ProjectEx.GetSolverSettingAsNumeric ( string  strParam)

Get a setting from the solver descriptor as a double value.

Parameters
strParamSpecifies the setting to retrieve.
Returns
The setting is returned as a double if found, otherwise null is returned.

Definition at line 454 of file ProjectEx.cs.

◆ LoadModelFile()

void MyCaffe.basecode.ProjectEx.LoadModelFile ( string  strFile)

Load the model description from a file.

Parameters
strFileSpecifies the model file.

Definition at line 1004 of file ProjectEx.cs.

◆ LoadSolverFile()

void MyCaffe.basecode.ProjectEx.LoadSolverFile ( string  strFile)

Load the solver description from a file.

Parameters
strFileSpecifies the solver file.

Definition at line 992 of file ProjectEx.cs.

◆ RequiresDataCriteria()

bool MyCaffe.basecode.ProjectEx.RequiresDataCriteria ( )

Returns whether or not the data criteria is required by the current project model (e.g. the model contains an AnnotatedData layer).

Returns
If the model requires the data criteria be loaded, then true is returned, otherwise false.

Definition at line 84 of file ProjectEx.cs.

◆ SetDataset() [1/2]

void MyCaffe.basecode.ProjectEx.SetDataset ( DatasetDescriptor  dataset)

Sets the dataset used by the Project, overriding the current dataset used.

Note, this function 'fixes' up the model used by the Project to use the new dataset.

Parameters
datasetSpecifies the new dataset to use.

Definition at line 1732 of file ProjectEx.cs.

◆ SetDataset() [2/2]

static string MyCaffe.basecode.ProjectEx.SetDataset ( string  strModelDesc,
DatasetDescriptor  dataset,
out bool  bResized,
bool  bUpdateOutputs = false 
)
static

Sets the dataset of a model, overriding the current dataset used.

Note, this function 'fixes' up the model used by the Project to use the new dataset.

Parameters
strModelDescSpecifies the model description to update.
datasetSpecifies the new dataset to use.
bResizedReturns whether or not the model was resized with a different output size.
bUpdateOutputsOptionally, specifies whether or not to update the number of outputs in the last layer (e.g. the number of classes in the dataset).

Definition at line 1779 of file ProjectEx.cs.

◆ SetSolverVariable()

bool MyCaffe.basecode.ProjectEx.SetSolverVariable ( string  strVar,
string  strVal 
)

Set a given Solver variable in the solver description script.

Parameters
strVarSpecifies the variable name.
strValSpecifies the variable value.
Returns
If the variable is found and set, true is returned, otherwise false is returned.

Definition at line 969 of file ProjectEx.cs.

◆ ToString()

override string MyCaffe.basecode.ProjectEx.ToString ( )

Returns a string representation of the Project.

Returns
The string describing the Project is returned.

Definition at line 2041 of file ProjectEx.cs.

Property Documentation

◆ Active

bool MyCaffe.basecode.ProjectEx.Active
get

Returns whether or not the Project is active.

Definition at line 552 of file ProjectEx.cs.

◆ BestAccuracy

double MyCaffe.basecode.ProjectEx.BestAccuracy
getset

Get/set the best accuracy observed while testing the Project.

Definition at line 830 of file ProjectEx.cs.

◆ BestError

double MyCaffe.basecode.ProjectEx.BestError
getset

Get/set the best error observed while training the Project.

Definition at line 839 of file ProjectEx.cs.

◆ Dataset

DatasetDescriptor MyCaffe.basecode.ProjectEx.Dataset
get

Return the descriptor of the dataset used.

Definition at line 880 of file ProjectEx.cs.

◆ DatasetAdjusted

bool MyCaffe.basecode.ProjectEx.DatasetAdjusted
getset

Get/set whether or not the dataset for the project has been changed.

Definition at line 301 of file ProjectEx.cs.

◆ DatasetGroup

GroupDescriptor MyCaffe.basecode.ProjectEx.DatasetGroup
get

Return the dataset group descriptor of the group that the Project participates in (if any).

Definition at line 788 of file ProjectEx.cs.

◆ DatasetName

string MyCaffe.basecode.ProjectEx.DatasetName
get

Return the name of the dataset used.

Definition at line 866 of file ProjectEx.cs.

◆ DatasetTarget

DatasetDescriptor MyCaffe.basecode.ProjectEx.DatasetTarget
get

Returns the target dataset (if exists) or null if it does not.

The target dataset only applies when using both a source and target dataset.

Definition at line 891 of file ProjectEx.cs.

◆ EnableLabelBalancing

bool MyCaffe.basecode.ProjectEx.EnableLabelBalancing
get

Returns whether or not label balancing is enabled. 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 614 of file ProjectEx.cs.

◆ EnableLabelBoosting

bool MyCaffe.basecode.ProjectEx.EnableLabelBoosting
get

Returns whether or not label boosting is enabled. When using Label boosting, images are selected from boosted labels with a higher probability that images from other label sets.

Definition at line 623 of file ProjectEx.cs.

◆ EnablePairSelection

bool MyCaffe.basecode.ProjectEx.EnablePairSelection
get

Returns whether or not pair selection is enabled. 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 642 of file ProjectEx.cs.

◆ EnableRandomSelection

bool MyCaffe.basecode.ProjectEx.EnableRandomSelection
get

Returns whether or not random image selection is enabled. 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 632 of file ProjectEx.cs.

◆ ExistTestResults

bool MyCaffe.basecode.ProjectEx.ExistTestResults
get

Return whether or not testing results exist.

Definition at line 927 of file ProjectEx.cs.

◆ ExistTrainResults

bool MyCaffe.basecode.ProjectEx.ExistTrainResults
get

Return whether or not training results exist.

Definition at line 935 of file ProjectEx.cs.

◆ GpuOverride

string MyCaffe.basecode.ProjectEx.GpuOverride
get

Returns the list of comma separated GPU ID's that are to be used when training this Project.

Definition at line 650 of file ProjectEx.cs.

◆ HasResults

bool MyCaffe.basecode.ProjectEx.HasResults
get

Return whether or not the project has results from a training session.

Definition at line 813 of file ProjectEx.cs.

◆ ID

int MyCaffe.basecode.ProjectEx.ID
get

Returns the ID of the Project in the database.

Definition at line 517 of file ProjectEx.cs.

◆ ImageLoadLimit

int MyCaffe.basecode.ProjectEx.ImageLoadLimit
get

Returns the image load limit.

Definition at line 667 of file ProjectEx.cs.

◆ ImageLoadLimitRefreshPercent

double MyCaffe.basecode.ProjectEx.ImageLoadLimitRefreshPercent
get

Returns the image load limit refresh percentage (to update).

Definition at line 683 of file ProjectEx.cs.

◆ ImageLoadLimitRefreshPeriod

int MyCaffe.basecode.ProjectEx.ImageLoadLimitRefreshPeriod
get

Returns the image load limit refresh period in milliseconds.

Definition at line 675 of file ProjectEx.cs.

◆ ImageLoadMethod

IMAGEDB_LOAD_METHOD MyCaffe.basecode.ProjectEx.ImageLoadMethod
get

Returns the method used to load the images into memory. Loading all images into memory has the highest training performance for memory access is much faster than disk acces (even with an SSD).

Definition at line 659 of file ProjectEx.cs.

◆ Iterations

int MyCaffe.basecode.ProjectEx.Iterations
getset

Get/set the current number of iterations that the Project has been trained.

Definition at line 821 of file ProjectEx.cs.

◆ ModelDescription

string MyCaffe.basecode.ProjectEx.ModelDescription
getset

Get/set the model description script used by the Project.

Definition at line 741 of file ProjectEx.cs.

◆ ModelGroup

GroupDescriptor MyCaffe.basecode.ProjectEx.ModelGroup
get

Return the model group descriptor of the group that the Project participates in (if any).

Definition at line 780 of file ProjectEx.cs.

◆ ModelName

string MyCaffe.basecode.ProjectEx.ModelName
get

Return the name of the model used by the Project.

Definition at line 951 of file ProjectEx.cs.

◆ Name

string MyCaffe.basecode.ProjectEx.Name
getset

Get/set the name of the Project.

Definition at line 508 of file ProjectEx.cs.

◆ OriginalID

int MyCaffe.basecode.ProjectEx.OriginalID
getset

Get/set the original project ID.

Definition at line 525 of file ProjectEx.cs.

◆ Owner

string MyCaffe.basecode.ProjectEx.Owner
getset

Get/set the ID of the Project owner.

Definition at line 543 of file ProjectEx.cs.

◆ Parameters

ParameterDescriptorCollection MyCaffe.basecode.ProjectEx.Parameters
get

Returns any project parameters that may exist (if any).

Definition at line 796 of file ProjectEx.cs.

◆ ProjectGroup

GroupDescriptor MyCaffe.basecode.ProjectEx.ProjectGroup
get

Return the project group descriptor of the group that the Project resides (if any).

Definition at line 772 of file ProjectEx.cs.

◆ ProjectPerformanceItems

ValueDescriptorCollection MyCaffe.basecode.ProjectEx.ProjectPerformanceItems
get

Return Project performance metrics.

Definition at line 943 of file ProjectEx.cs.

◆ Settings

SettingsCaffe MyCaffe.basecode.ProjectEx.Settings
getset

Get/set the Caffe setting to use with the Project.

Definition at line 499 of file ProjectEx.cs.

◆ SnapshotLoadMethod

SNAPSHOT_LOAD_METHOD MyCaffe.basecode.ProjectEx.SnapshotLoadMethod
get

Returns the snapshot load method. When loading the best error or accuracy, the snapshot loaded may not be the last one taken.

Definition at line 702 of file ProjectEx.cs.

◆ SnapshotWeightUpdateMethod

SNAPSHOT_WEIGHT_UPDATE_METHOD MyCaffe.basecode.ProjectEx.SnapshotWeightUpdateMethod
get

Returns the snapshot weight update favor. The snapshot can favor an improving accuracy, decreasing error, or both when saving weights.

Note, weights updates are saved separately from the entire solver state that is snapshot on regular intervals.

Definition at line 694 of file ProjectEx.cs.

◆ SolverDescription

string MyCaffe.basecode.ProjectEx.SolverDescription
getset

Get/set the solver description script used by the Project.

Definition at line 710 of file ProjectEx.cs.

◆ SolverState

byte [] MyCaffe.basecode.ProjectEx.SolverState
getset

Get/set the solver state.

Definition at line 848 of file ProjectEx.cs.

◆ SolverType

string MyCaffe.basecode.ProjectEx.SolverType
get

Return the type of the Solver used by the Project.

Definition at line 959 of file ProjectEx.cs.

◆ Stage

Stage MyCaffe.basecode.ProjectEx.Stage
getset

Return the stage under which the project was opened.

Definition at line 587 of file ProjectEx.cs.

◆ SuperBoostProbability

double MyCaffe.basecode.ProjectEx.SuperBoostProbability
getset

Get/set the super boost probability used by the Project.

Definition at line 596 of file ProjectEx.cs.

◆ TargetDatasetID

int MyCaffe.basecode.ProjectEx.TargetDatasetID
getset

Get/set the dataset ID of the target dataset (if exists), otherwise return 0.

Definition at line 899 of file ProjectEx.cs.

◆ TotalIterations

int MyCaffe.basecode.ProjectEx.TotalIterations
getset

Get/set the total number of iterations that the Project has been trained.

Definition at line 804 of file ProjectEx.cs.

◆ TrainingCategory

TRAINING_CATEGORY MyCaffe.basecode.ProjectEx.TrainingCategory
get

Returns the training category of the project, or NONE if no custom trainer is used.

Definition at line 560 of file ProjectEx.cs.

◆ UseTrainingSourceForTesting

bool MyCaffe.basecode.ProjectEx.UseTrainingSourceForTesting
get

Returns whether or not the Project uses the training data source when testing (default = false).

Definition at line 605 of file ProjectEx.cs.

◆ WeightsState

byte [] MyCaffe.basecode.ProjectEx.WeightsState
getset

Get/set the weight state.

Definition at line 857 of file ProjectEx.cs.

Event Documentation

◆ OnOverrideModel

EventHandler<OverrideProjectArgs> MyCaffe.basecode.ProjectEx.OnOverrideModel

The OverrrideModel event fires each time the SetDataset function is called.

Definition at line 30 of file ProjectEx.cs.

◆ OnOverrideSolver

EventHandler<OverrideProjectArgs> MyCaffe.basecode.ProjectEx.OnOverrideSolver

The OverrideSolver event fires each time the SetDataset function is called.

Definition at line 34 of file ProjectEx.cs.


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