MyCaffe.trainers.StateBase Class Reference

The StateBase is the base class for the state of each observation - this is defined by actual trainer that overrides the MyCaffeCustomTrainer. More...

Public Member Functions
	StateBase (int nActionCount)
	The constructor. More...
virtual StateBase	Clone ()
	Copy the state base information. More...
override string	ToString ()
	Return the string representation of the state. More...

Properties
double	TestingPercent [getset]
	Get/set the percentage of the data to reserve for testing. More...
bool	IsValid [getset]
	Get/set whether or not the state is valid. More...
double	Reward [getset]
	Get/set the reward of the state. More...
bool	Done [getset]
	Get/set whether the state is done or not. More...
List< DataPoint >	History [getset]
	Get/set the data history (if any exists). More...
int	ActionCount [get]
	Returns the number of actions. More...
SimpleDatum	Data [getset]
	Returns other data associated with the state. More...
double[]	RawState [getset]
	Get/set the raw state data. More...
SimpleDatum	Clip [getset]
	Returns the clip data assoicated with the state. More...
double[]	RawClip [getset]
	Get/set the raw clip data. More...
SimpleDatum	Label [getset]
	Get/set the label data associated with the state. This field is optional. More...
Image	RawImage [getset]
	Get/set the image (if any exists) More...

Detailed Description

The StateBase is the base class for the state of each observation - this is defined by actual trainer that overrides the MyCaffeCustomTrainer.

Definition at line 15 of file StateBase.cs.

Constructor & Destructor Documentation

StateBase()

MyCaffe.trainers.StateBase.StateBase

(

int

nActionCount

)

The constructor.

Definition at line 33 of file StateBase.cs.

Member Function Documentation

Clone()

virtual StateBase MyCaffe.trainers.StateBase.Clone ( )

virtual

Copy the state base information.

Returns

A new state base is returned.

Definition at line 152 of file StateBase.cs.

ToString()

override string MyCaffe.trainers.StateBase.ToString

(

)

Return the string representation of the state.

Returns

The string representation is returned.

Definition at line 174 of file StateBase.cs.

Property Documentation

ActionCount

int MyCaffe.trainers.StateBase.ActionCount

get

Returns the number of actions.

Definition at line 89 of file StateBase.cs.

Clip

SimpleDatum MyCaffe.trainers.StateBase.Clip

getset

Returns the clip data assoicated with the state.

Definition at line 115 of file StateBase.cs.

Data

SimpleDatum MyCaffe.trainers.StateBase.Data

getset

Returns other data associated with the state.

Definition at line 97 of file StateBase.cs.

Done

bool MyCaffe.trainers.StateBase.Done

getset

Get/set whether the state is done or not.

Definition at line 71 of file StateBase.cs.

History

List<DataPoint> MyCaffe.trainers.StateBase.History

getset

Get/set the data history (if any exists).

Definition at line 80 of file StateBase.cs.

IsValid

bool MyCaffe.trainers.StateBase.IsValid

getset

Get/set whether or not the state is valid.

Definition at line 53 of file StateBase.cs.

Label

SimpleDatum MyCaffe.trainers.StateBase.Label

getset

Get/set the label data associated with the state. This field is optional.

Definition at line 133 of file StateBase.cs.

RawClip

double [] MyCaffe.trainers.StateBase.RawClip

getset

Get/set the raw clip data.

Definition at line 124 of file StateBase.cs.

RawImage

Image MyCaffe.trainers.StateBase.RawImage

getset

Get/set the image (if any exists)

Definition at line 142 of file StateBase.cs.

RawState

double [] MyCaffe.trainers.StateBase.RawState

getset

Get/set the raw state data.

Definition at line 106 of file StateBase.cs.

Reward

double MyCaffe.trainers.StateBase.Reward

getset

Get/set the reward of the state.

Definition at line 62 of file StateBase.cs.

TestingPercent

double MyCaffe.trainers.StateBase.TestingPercent

getset

Get/set the percentage of the data to reserve for testing.

When set to 0, the same data is used for both testing and training (not recommended).

Definition at line 44 of file StateBase.cs.

---

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

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