MyCaffe  1.12.2.41
Deep learning software for Windows C# programmers.
MyCaffe.trainers.GetStatusArgs Class Reference

The GetStatusArgs is passed to the OnGetStatus event. More...

Inheritance diagram for MyCaffe.trainers.GetStatusArgs:

Public Member Functions

 GetStatusArgs (int nIndex, int nIteration, int nFrames, int nMaxFrames, double dfTotalReward, double dfReward, double dfExplorationRate, double dfOptimalCoeff, double dfLoss, double dfLearningRate, bool bModelUpdated=false)
 The constructor. More...
 

Properties

int Index [get]
 Returns the index of the caller. More...
 
int Iteration [get]
 Returns the number of iterations (steps) run. More...
 
int NewFrameCount [getset]
 Get/set the new frame count. More...
 
int Frames [get]
 Returns the total frame count across all agents. More...
 
int MaxFrames [get]
 Returns the maximum frame count. More...
 
bool ModelUpdated [get]
 Returns whether or not the model has been updated or not. More...
 
double Loss [get]
 Returns the loss value. More...
 
double LearningRate [get]
 Returns the current learning rate. More...
 
double TotalReward [get]
 Returns the total rewards. More...
 
double Reward [get]
 Returns the immediate reward for the current episode. More...
 
double ExplorationRate [get]
 Returns the current exploration rate. More...
 
double OptimalSelectionCoefficient [get]
 Returns the optimal selection coefficient. More...
 

Detailed Description

The GetStatusArgs is passed to the OnGetStatus event.

Definition at line 165 of file EventArgs.cs.

Constructor & Destructor Documentation

◆ GetStatusArgs()

MyCaffe.trainers.GetStatusArgs.GetStatusArgs ( int  nIndex,
int  nIteration,
int  nFrames,
int  nMaxFrames,
double  dfTotalReward,
double  dfReward,
double  dfExplorationRate,
double  dfOptimalCoeff,
double  dfLoss,
double  dfLearningRate,
bool  bModelUpdated = false 
)

The constructor.

Parameters
nIndexSpecifies the index of the caller.
nFramesSpecifies the total number of frames across all agents.
nMaxFramesSpecifies the maximum number of frames across all agents.
nIterationSpecifies the number of iterations run.
dfTotalRewardSpecifies the total reward.
dfRewardSpecifies the immediate reward for the current episode.
dfExplorationRateSpecifies the current exploration rate.
dfOptimalCoeffSpecifies the current optimal selection coefficient.
dfLossSpecifies the loss.
dfLearningRateSpecifies the learning rate.
bModelUpdatedSpecifies whether or not the model has been updated.

Definition at line 194 of file EventArgs.cs.

Property Documentation

◆ ExplorationRate

double MyCaffe.trainers.GetStatusArgs.ExplorationRate
get

Returns the current exploration rate.

Definition at line 293 of file EventArgs.cs.

◆ Frames

int MyCaffe.trainers.GetStatusArgs.Frames
get

Returns the total frame count across all agents.

Definition at line 237 of file EventArgs.cs.

◆ Index

int MyCaffe.trainers.GetStatusArgs.Index
get

Returns the index of the caller.

Definition at line 212 of file EventArgs.cs.

◆ Iteration

int MyCaffe.trainers.GetStatusArgs.Iteration
get

Returns the number of iterations (steps) run.

Definition at line 220 of file EventArgs.cs.

◆ LearningRate

double MyCaffe.trainers.GetStatusArgs.LearningRate
get

Returns the current learning rate.

Definition at line 269 of file EventArgs.cs.

◆ Loss

double MyCaffe.trainers.GetStatusArgs.Loss
get

Returns the loss value.

Definition at line 261 of file EventArgs.cs.

◆ MaxFrames

int MyCaffe.trainers.GetStatusArgs.MaxFrames
get

Returns the maximum frame count.

Definition at line 245 of file EventArgs.cs.

◆ ModelUpdated

bool MyCaffe.trainers.GetStatusArgs.ModelUpdated
get

Returns whether or not the model has been updated or not.

Definition at line 253 of file EventArgs.cs.

◆ NewFrameCount

int MyCaffe.trainers.GetStatusArgs.NewFrameCount
getset

Get/set the new frame count.

Definition at line 228 of file EventArgs.cs.

◆ OptimalSelectionCoefficient

double MyCaffe.trainers.GetStatusArgs.OptimalSelectionCoefficient
get

Returns the optimal selection coefficient.

Definition at line 301 of file EventArgs.cs.

◆ Reward

double MyCaffe.trainers.GetStatusArgs.Reward
get

Returns the immediate reward for the current episode.

Definition at line 285 of file EventArgs.cs.

◆ TotalReward

double MyCaffe.trainers.GetStatusArgs.TotalReward
get

Returns the total rewards.

Definition at line 277 of file EventArgs.cs.


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