MyCaffe.trainers.IXMyCaffeCustomTrainerRNN Interface Reference

The IXMyCaffeCustomTrainer interface is used by the MyCaffeCustomTraininer components that provide various training techniques such as Reinforcement Training. More...

Inheritance diagram for MyCaffe.trainers.IXMyCaffeCustomTrainerRNN:

Public Member Functions
float[]	Run (Component mycaffe, int nN)
	Run the network using the run technique implemented by this trainer. More...
byte[]	Run (Component mycaffe, int nN, out string type)
	Run the network using the run technique implemented by this trainer. More...
BucketCollection	PreloadData (Log log, CancelEvent evtCancel, int nProjectID, PropertySet propertyOverride=null, ConnectInfo ci=null)
	The PreloadData method gives the custom trainer an opportunity to pre-load any data. More...
string	ResizeModel (Log log, string strModel, BucketCollection rgVocabulary)
	The ResizeModel method gives the custom trainer the opportunity to resize the model if needed. More...
Public Member Functions inherited from MyCaffe.trainers.IXMyCaffeCustomTrainer
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...

Additional Inherited Members
Properties inherited from MyCaffe.trainers.IXMyCaffeCustomTrainer
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...

Detailed Description

The IXMyCaffeCustomTrainer interface is used by the MyCaffeCustomTraininer components that provide various training techniques such as Reinforcement Training.

Definition at line 157 of file Interfaces.cs.

Member Function Documentation

PreloadData()

BucketCollection MyCaffe.trainers.IXMyCaffeCustomTrainerRNN.PreloadData	(	Log	log,
		CancelEvent	evtCancel,
		int	nProjectID,
		PropertySet	propertyOverride = null,
		ConnectInfo	ci = null
	)

The PreloadData method gives the custom trainer an opportunity to pre-load any data.

Parameters

log	Specifies the output log to use.
evtCancel	Specifies the event used to cancel the pre-load.
nProjectID	Specifies the ProjectID if any.
propertyOverride	Optionally, specifies the properites to override those already specified during initialization (default = null).
ci	Optionally, specifies the database connection information (default = null).

Returns

When data is pre-loaded the vocabulary discovered is returned as a Bucket Collection.

Implemented in MyCaffe.trainers.MyCaffeTrainerRNN.

ResizeModel()

string MyCaffe.trainers.IXMyCaffeCustomTrainerRNN.ResizeModel	(	Log	log,
		string	strModel,
		BucketCollection	rgVocabulary
	)

The ResizeModel method gives the custom trainer the opportunity to resize the model if needed.

Parameters

strModel	Specifies the model descriptor.
rgVocabulary	Specifies the vocabulary, if any.
log	Specifies the output log.

Returns

A new model discriptor is returned (or the same 'strModel' if no changes were made).

Note, this method is called after PreloadData.

Implemented in MyCaffe.trainers.MyCaffeTrainerRNN.

Run() [1/2]

float[] MyCaffe.trainers.IXMyCaffeCustomTrainerRNN.Run	(	Component	mycaffe,
		int	nN
	)

Run the network using the run technique implemented by this trainer.

Parameters

mycaffe	Specifies an instance to the MyCaffeControl component.
nN	specifies the number of samples to run.

Returns

The run results are returned.

Implemented in MyCaffe.trainers.MyCaffeTrainerRNN.

Run() [2/2]

byte[] MyCaffe.trainers.IXMyCaffeCustomTrainerRNN.Run	(	Component	mycaffe,
		int	nN,
		out string	type
	)

Run the network using the run technique implemented by this trainer.

Parameters

mycaffe	Specifies an instance to the MyCaffeControl component.
nN	Specifies the number of samples to run.
type	Specifies the output data type returned as a raw byte stream.

Returns

The run results are returned in the same native type as that of the CustomQuery used.

Implemented in MyCaffe.trainers.MyCaffeTrainerDual, and MyCaffe.trainers.MyCaffeTrainerRNN.

---

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

• C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.trainers/Interfaces.cs