MyCaffe
1.12.2.41
Deep learning software for Windows C# programmers.
|
The IXMyCaffeCustomTrainer interface is used by the MyCaffeCustomTraininer components that provide various training techniques such as Reinforcement Training. More...
Public Member Functions | |
void | Initialize (string strProperties, IXMyCaffeCustomTrainerCallback icallback) |
Initialize the trainer passing in a set of key-value pairs as properties. More... | |
void | CleanUp () |
Clean-up the trainer by releasing all resources used. More... | |
bool | GetUpdateSnapshot (out int nIteration, out double dfAccuracy) |
Returns true when the training is ready for a snap-shot, false otherwise. More... | |
DatasetDescriptor | GetDatasetOverride (int nProjectID, ConnectInfo ci=null) |
Returns a dataset override to use (if any) instead of the project's dataset. If there is no dataset override null is returned and the project's dataset is used. More... | |
void | Train (Component mycaffe, int nIterationOverride, ITERATOR_TYPE type=ITERATOR_TYPE.ITERATION, TRAIN_STEP step=TRAIN_STEP.NONE) |
Train the network using the training technique implemented by this trainer. More... | |
void | Test (Component mycaffe, int nIterationOverride, ITERATOR_TYPE type=ITERATOR_TYPE.ITERATION) |
Test the network using the testing technique implemented by this trainer. More... | |
double | GetProperty (string strName) |
Returns a specific property value. More... | |
void | OpenUi () |
Open the user interface if one exists for the trainer. More... | |
Properties | |
Stage | Stage [get] |
Returns the stage that the trainer is running under based on the trainer type. More... | |
string | Name [get] |
Returns the name of the custom trainer. More... | |
TRAINING_CATEGORY | TrainingCategory [get] |
Returns the training category supported by the implementer of the interface. More... | |
bool | IsTrainingSupported [get] |
Returns true when the 'Train' method is supported - this should almost always be true. More... | |
bool | IsTestingSupported [get] |
Returns true when the 'Test' method is supported. More... | |
bool | IsRunningSupported [get] |
Returns true when the 'Run' method is supported. More... | |
string | Information [get] |
Returns general information about the custom trainer. More... | |
The IXMyCaffeCustomTrainer interface is used by the MyCaffeCustomTraininer components that provide various training techniques such as Reinforcement Training.
Definition at line 37 of file Interfaces.cs.
void MyCaffe.trainers.IXMyCaffeCustomTrainer.CleanUp | ( | ) |
Clean-up the trainer by releasing all resources used.
Implemented in MyCaffe.trainers.MyCaffeTrainerDual, MyCaffe.trainers.MyCaffeTrainerRL, and MyCaffe.trainers.MyCaffeTrainerRNN.
DatasetDescriptor MyCaffe.trainers.IXMyCaffeCustomTrainer.GetDatasetOverride | ( | int | nProjectID, |
ConnectInfo | ci = null |
||
) |
Returns a dataset override to use (if any) instead of the project's dataset. If there is no dataset override null is returned and the project's dataset is used.
nProjectID | Specifies the project ID associated with the trainer (if any) |
ci | Optionally, specifies the database connection information (default = null). |
Implemented in MyCaffe.trainers.MyCaffeTrainerDual, MyCaffe.trainers.MyCaffeTrainerRL, and MyCaffe.trainers.MyCaffeTrainerRNN.
double MyCaffe.trainers.IXMyCaffeCustomTrainer.GetProperty | ( | string | strName | ) |
Returns a specific property value.
strName | Specifies the property to get. |
The following properties are supported by all trainers: 'GlobalLoss'
The following properties are supported by the RL trainers: 'GlobalRewards' 'GlobalEpisodeCount' 'ExplorationRate'
The following properties are supported by the RNN trainers: 'GlobalIteration'
Implemented in MyCaffe.trainers.MyCaffeTrainerDual, MyCaffe.trainers.MyCaffeTrainerRL, and MyCaffe.trainers.MyCaffeTrainerRNN.
bool MyCaffe.trainers.IXMyCaffeCustomTrainer.GetUpdateSnapshot | ( | out int | nIteration, |
out double | dfAccuracy | ||
) |
Returns true when the training is ready for a snap-shot, false otherwise.
nIteration | Specifies the current iteration. |
dfAccuracy | Specifies the current accuracy or rewards for Reinforcement trainers. |
Implemented in MyCaffe.trainers.MyCaffeTrainerDual, MyCaffe.trainers.MyCaffeTrainerRL, and MyCaffe.trainers.MyCaffeTrainerRNN.
void MyCaffe.trainers.IXMyCaffeCustomTrainer.Initialize | ( | string | strProperties, |
IXMyCaffeCustomTrainerCallback | icallback | ||
) |
Initialize the trainer passing in a set of key-value pairs as properties.
Use the ProeprtySet object to easily parse the key-value pair properties.
strProperties | Specifies the properties. |
icallback | Specifies the parent callback for updates. |
Implemented in MyCaffe.trainers.MyCaffeTrainerDual, MyCaffe.trainers.MyCaffeTrainerRL, and MyCaffe.trainers.MyCaffeTrainerRNN.
void MyCaffe.trainers.IXMyCaffeCustomTrainer.OpenUi | ( | ) |
Open the user interface if one exists for the trainer.
Implemented in MyCaffe.trainers.MyCaffeTrainerDual, MyCaffe.trainers.MyCaffeTrainerRL, and MyCaffe.trainers.MyCaffeTrainerRNN.
void MyCaffe.trainers.IXMyCaffeCustomTrainer.Test | ( | Component | mycaffe, |
int | nIterationOverride, | ||
ITERATOR_TYPE | type = ITERATOR_TYPE.ITERATION |
||
) |
Test the network using the testing technique implemented by this trainer.
mycaffe | Specifies an instance to the MyCaffeControl component. |
nIterationOverride | Specifies the iteration override if any. |
type | Specifies the type of iterator to use. |
Implemented in MyCaffe.trainers.MyCaffeTrainerDual, MyCaffe.trainers.MyCaffeTrainerRL, and MyCaffe.trainers.MyCaffeTrainerRNN.
void MyCaffe.trainers.IXMyCaffeCustomTrainer.Train | ( | Component | mycaffe, |
int | nIterationOverride, | ||
ITERATOR_TYPE | type = ITERATOR_TYPE.ITERATION , |
||
TRAIN_STEP | step = TRAIN_STEP.NONE |
||
) |
Train the network using the training technique implemented by this trainer.
mycaffe | Specifies an instance to the MyCaffeControl component. |
nIterationOverride | Specifies the iteration override if any. |
type | Specifies the type of iterator to use. |
step | Specifies whether or not to step the training for debugging. |
Implemented in MyCaffe.trainers.MyCaffeTrainerDual, MyCaffe.trainers.MyCaffeTrainerRL, and MyCaffe.trainers.MyCaffeTrainerRNN.
|
get |
Returns general information about the custom trainer.
Definition at line 123 of file Interfaces.cs.
|
get |
Returns true when the 'Run' method is supported.
Definition at line 86 of file Interfaces.cs.
|
get |
Returns true when the 'Test' method is supported.
Definition at line 82 of file Interfaces.cs.
|
get |
Returns true when the 'Train' method is supported - this should almost always be true.
Definition at line 78 of file Interfaces.cs.
|
get |
Returns the name of the custom trainer.
Definition at line 57 of file Interfaces.cs.
|
get |
Returns the stage that the trainer is running under based on the trainer type.
Definition at line 53 of file Interfaces.cs.
|
get |
Returns the training category supported by the implementer of the interface.
Definition at line 61 of file Interfaces.cs.