MyCaffe  1.12.2.41
Deep learning software for Windows C# programmers.
MyCaffe.gym.IXMyCaffeGymData Interface Reference

The IXMyCaffeGym interface is used to interact with each Gym. More...

Inheritance diagram for MyCaffe.gym.IXMyCaffeGymData:
MyCaffe.gym.IXMyCaffeGym MyCaffe.gym.DataGeneralGym MyCaffe.gym.ModelGym

Public Member Functions

byte[] ConvertOutput (Stage stage, int nN, float[] rg, out string type)
 Converts the output values into the native type used by the Gym during queries. More...
 
- Public Member Functions inherited from MyCaffe.gym.IXMyCaffeGym
void Initialize (Log log, PropertySet properties)
 Initialize the gym using the properties in the PropertySet. More...
 
void Close ()
 Close a previously initialized gym. More...
 
IXMyCaffeGym Clone (PropertySet properties=null)
 Copy a gym creating a new one. More...
 
Tuple< State, double, bool > Reset (bool bGetLabel=false, PropertySet props=null)
 Resets the state of they gym. More...
 
Tuple< State, double, bool > Step (int nAction, bool bGetLabel=false, PropertySet extraProp=null)
 Run an action on the gym. More...
 
Tuple< Bitmap, SimpleDatumRender (bool bShowUi, int nWidth, int nHeight, bool bGetAction)
 Render the gym on a bitmap. More...
 
Tuple< Bitmap, SimpleDatumRender (bool bShowUi, int nWidth, int nHeight, double[] rgData, bool bGetAction)
 Render the gym on a bitmap. More...
 
Dictionary< string, int > GetActionSpace ()
 Returns a dictionary containing the action space where each entry contains the action name and action value. More...
 
DatasetDescriptor GetDataset (DATA_TYPE dt, Log log=null)
 Returns the dataset of the gym. More...
 

Properties

Phase ActivePhase [getset]
 Specifies the active phase under which to get the data reset and next. More...
 
- Properties inherited from MyCaffe.gym.IXMyCaffeGym
string Name [get]
 Returns the name of the gym. More...
 
int UiDelay [get]
 Returns the user-interface delay to use (if any). More...
 
DATA_TYPE SelectedDataType [get]
 Returns the selected data-type. More...
 
DATA_TYPE[] SupportedDataType [get]
 Returns an array of data types supported by the gym. More...
 
bool RequiresDisplayImage [get]
 Returns whether or not the gym requires the display image. More...
 
double TestingPercent [get]
 Returns the percentage of the data to use for testing, or -1 which then uses the default of 0.2. More...
 

Detailed Description

The IXMyCaffeGym interface is used to interact with each Gym.

Definition at line 191 of file Interfaces.cs.

Member Function Documentation

◆ ConvertOutput()

byte[] MyCaffe.gym.IXMyCaffeGymData.ConvertOutput ( Stage  stage,
int  nN,
float[]  rg,
out string  type 
)

Converts the output values into the native type used by the Gym during queries.

Parameters
stageSpecifies the stage under which the conversion is run.
nNSpecifies the number of outputs.
rgSpecifies the raw output data.
typeReturns the output type.
Returns
The converted output data is returned.

Implemented in MyCaffe.gym.DataGeneralGym, and MyCaffe.gym.ModelGym.

Property Documentation

◆ ActivePhase

Phase MyCaffe.gym.IXMyCaffeGymData.ActivePhase
getset

Specifies the active phase under which to get the data reset and next.

Definition at line 205 of file Interfaces.cs.


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