MyCaffe.trainers.IxTrainerCallback Interface Reference

The IxTrainerCallback provides functions used by each trainer to 'call-back' to the parent for information and updates. More...

Inheritance diagram for MyCaffe.trainers.IxTrainerCallback:

Public Member Functions
void	OnInitialize (InitializeArgs e)
	The OnIntialize callback fires when initializing the trainer. More...
void	OnShutdown ()
	The OnShutdown callback fires when shutting down the trainer. More...
void	OnGetData (GetDataArgs e)
	The OnGetData callback fires from within the Train method and is used to get a new observation data. More...
void	OnUpdateStatus (GetStatusArgs e)
	The OnGetStatus callback fires on each iteration within the Train method. More...
void	OnWait (WaitArgs e)
	The OnWait callback fires when waiting for a shutdown. More...

Detailed Description

The IxTrainerCallback provides functions used by each trainer to 'call-back' to the parent for information and updates.

The IxTrainerCallback is passed to each trainer.

Definition at line 302 of file Interfaces.cs.

Member Function Documentation

OnGetData()

void MyCaffe.trainers.IxTrainerCallback.OnGetData

(

GetDataArgs

e

)

The OnGetData callback fires from within the Train method and is used to get a new observation data.

Parameters

e	Specifies the argument sent with the callback.

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

OnInitialize()

void MyCaffe.trainers.IxTrainerCallback.OnInitialize

(

InitializeArgs

e

)

The OnIntialize callback fires when initializing the trainer.

Parameters

e	Specifies the argument sent with the callback.

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

OnShutdown()

void MyCaffe.trainers.IxTrainerCallback.OnShutdown

(

)

The OnShutdown callback fires when shutting down the trainer.

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

OnUpdateStatus()

void MyCaffe.trainers.IxTrainerCallback.OnUpdateStatus

(

GetStatusArgs

e

)

The OnGetStatus callback fires on each iteration within the Train method.

Parameters

e	Specifies the argument sent with the callback.

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

OnWait()

void MyCaffe.trainers.IxTrainerCallback.OnWait

(

WaitArgs

e

)

The OnWait callback fires when waiting for a shutdown.

Parameters

e	Specifies the argument sent with the callback.

Implemented in MyCaffe.trainers.MyCaffeTrainerDual, MyCaffe.trainers.MyCaffeTrainerRL, 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