TaskET
TaskET()luaTable - to store named parameters
| DataTable | the DataTable, this task is based on |
| Description | Textual description of this object (up to 65535 characters) |
| DisabledFlag | If this task is disabled and cannot be run |
| ETTrunkCountMax | Maximal number of generated decision rules |
| FullDepthTreesOnlyFlag | Whether to generate the full-trees only. Set to false for generating partial trees also. |
| HypothesisCountMax | Maximal number of hypotheses before generation is interrupted |
| ID | Unique identifier (primary key) of the object |
| Name | Unique name of this object. Cannot be empty. |
| NodeFrequencyMin | Minimal node frequency (a node is not expanded further if below) |
| NodePurityMin | Desired minimal node purity (a node is not expanded further if reached) |
| Note | Text comment to this object (up to 255 characters) |
| PrunePermutationFullFlag | Whether to prune the full-length permutation of attributes |
| PrunePermutationFullFlag | Whether to prune splits with the same-class leaves |
| SplitAttributesMax | Maximal number of splits |
| SplitMaxDecreasePerLevel | Max-split-number decrease per level |
| SplitSignificanceChiSqAlpha | Chi-square significance level |
| SplitSignificanceChiSqTestFlag | Whether to perform the ChiSq test for an attribute selection |
| StoreDecisionTreesFlag | Whether to store decision trees after they are generated |
| StoreETTrunkFlag | Whether to store decision rules after they are generated |
| TargetSetting | the ETAttributeSetting, target class setting |
| TaskGenerationStatus | Status code for task, see TaskGenerationStatus codes |
| TaskGroup | the TaskGroup, this task belongs to |
| TestingDataSplitPercentage | The size of testing data (in percent of the whole data) for preparing random sample |
| TestingFolds | Number of folds for the cross-validation testing |
| TreeCountMax | Maximal number of generated decision trees |
| TreeDepthMax | Maximal tree depth frequency (it is not expanded further if reached) |
| TreeQualityMin | Threshold value for minimal tree quality |
| TreeQualityMinTestFlag | Whether to test minimal tree quality |
| canDel () | Returns true if the object could be deleted (is not used) |
| clone () | Creates a clone (an exact copy) of this task |
| findETPartialGroupSetting () | Tries to look-up a ETPartialGroupSetting with a unique property given as parameter. Just one parameter has to be specified. Returns nil if ETPartialGroupSetting with this property doesn't exists. |
| findFTWholeCedentSetting () | Tries to look-up a FTWholeCedentSetting with a unique property given as parameter. Just one parameter has to be specified. Returns nil if FTWholeCedentSetting with this property doesn't exists. |
| findHypothesis () | Tries to look-up a Hypothesis with a unique property given as parameter. Just one parameter has to be specified. Returns nil if Hypothesis with this property doesn't exists. |
| findHypothesisGroup () | Tries to look-up a HypothesisGroup with a unique property given as parameter. Just one parameter has to be specified. Returns nil if HypothesisGroup with this property doesn't exists. |
| getDataTable () | Returns the DataTable this task is based on, the value of DataTable property |
| getETPartialGroupSettingCount () | Returns number of ETPartialGroupSettings for attributes in this task |
| getFTWholeCedentSettingCount () | Returns number of whole cedents in this task |
| getHypothesisCount () | Returns number of hypotheses in this task (if the value of TaskGenerationStatus property is equal or greater then Running, see TaskGenerationStatus codes |
| getHypothesisCountMax () | Returns the value of HypothesisCountMax property |
| getHypothesisGroupCount () | Returns number of groups of hypotheses in this task |
| getID () | Returns unique identifier (primary key) of the object |
| getName () | Returns the value of Name property, name of this object |
| getNote () | Returns the value of Note property |
| getTaskGenerationStatus () | Returns the value of TaskGenerationStatus property |
| getTaskGenerationStatusStr () | Returns textual description of the value of TaskGenerationStatus property |
| getTaskGroup () | Returns the TaskGroup this task belongs to, the value of TaskGroup property |
| getTaskSubTypeCode () | Returns code of sub-type of this task (type of patterns it looks for), see TaskSubType codes |
| getTaskSubTypeKey () | Returns unique string key of sub-type of this task (type of patterns it looks for) |
| getTaskSubTypeName () | Returns string representation of sub-type of this task (type of patterns it looks for) |
| getTestingTypeCode () | Returns code of testing type, see TestingType codes |
| getTestingTypeKey () | Returns unique string key of testing type |
| getTestingTypeName () | Returns string representation of testing type |
| isDisabledFlag () | Returns the value of DisabledFlag property |
| isTaskGenerationStatusFinished () | Returns true when the value of TaskGenerationStatus property is Solved, Interrupted or Failed |
| isTaskGenerationStatusInProcess () | Returns true when the value of TaskGenerationStatus property is Request, Waiting or Running |
| onAdd () | Store the newly created object into metabase |
| onDel () | Delete the object from metabase (fails if canDel returns false) |
| onUpdate () | Save changes made to the object into metabase |
| prepareETPartialGroupSettingArray () | Returns array of ETPartialGroupSettings (groups of attributes in this task) |
| prepareFTWholeCedentSettingArray () | Returns array of FTWholeCedentSettings (the whole cedents in this task) |
| prepareHypothesisArray () | Returns array of hypotheses in this task. Returns objects of a descendant class corresponding to this task type (ie. HypothesisFT for TaskFT etc.) |
| prepareHypothesisGroupArray () | Returns array of groups of hypotheses in this task |
| queryTaskGenerationStatus () | Re-reads the task state from metabase and returns 1 if the the state has changed from isTaskGenerationStatusInProcess to isTaskGenerationStatusFinished, otherwise returns 0 |
| runAndWaitForResults () | Starts the data-mining task and waits till it has finished |
| runAsync () | Starts the task (if not already in isTaskGenerationStatusInProcess) in a parallel thread and returns immediately |
| setDisabledFlag () | Sets the value of DisabledFlag property |
| setHypothesisCountMax () | Sets the value of HypothesisCountMax property |
| setName () | Sets the value of Name property, name of this object (must be unique) |
| setNote () | Sets the value of Note property |
| setTaskGroup () | Sets the TaskGroup this task belongs to, the value of TaskGroup property |
| setTestingTypeCode () | Sets code of testing type, see TestingType codes |
| waitForResults () | Waits till the task state changes to isTaskGenerationStatusFinished |
DataTable (read-only) : DataTableDescription : stringDisabledFlag : booleanETTrunkCountMax : integerFullDepthTreesOnlyFlag : booleanHypothesisCountMax : integerID (read-only) : integerName : stringNodeFrequencyMin : integerNodePurityMin : integerNote : stringPrunePermutationFullFlag : booleanPrunePermutationFullFlag : booleanSplitAttributesMax : integerSplitMaxDecreasePerLevel : integerSplitSignificanceChiSqAlpha : integerSplitSignificanceChiSqTestFlag : booleanStoreDecisionTreesFlag : booleanStoreETTrunkFlag : booleanTargetSetting (read-only) : ETAttributeSettingTaskGenerationStatus (read-only) : integerTaskGroup (read-only) : TaskGroupTestingDataSplitPercentage : integerTestingFolds : integerTreeCountMax : integerTreeDepthMax : integerTreeQualityMin : integerTreeQualityMinTestFlag : booleancanDel() : booleanbooleanclone() : TaskTask - cloned taskfindETPartialGroupSetting() : ETPartialGroupSettingnil if ETPartialGroupSetting with this property doesn't exists.
luaTable - to store named parameters
nID : integer - an ID of the ETPartialGroupSetting to look-up
ETPartialGroupSetting - or nilfindFTWholeCedentSetting() : FTWholeCedentSettingnil if FTWholeCedentSetting with this property doesn't exists.
luaTable - to store named parameters
nCedentTypeCode : integer - CedentType code to identify the whole cedent to find
FTWholeCedentSetting - or nilfindHypothesis() : Hypothesisnil if Hypothesis with this property doesn't exists.
luaTable - to store named parameters
nID : integer - an ID of the Hypothesis to look-up
Hypothesis - or nilfindHypothesisGroup() : HypothesisGroupnil if HypothesisGroup with this property doesn't exists.
luaTable - to store named parameters
nID : integer - an ID of the HypothesisGroup to look-up
name : string - a name of the group of hypotheses to look-up
HypothesisGroup - or nilgetDataTable() : DataTablegetETPartialGroupSettingCount() : integerintegergetFTWholeCedentSettingCount() : integerintegergetHypothesisCount() : integerintegergetHypothesisCountMax() : integerintegergetHypothesisGroupCount() : integerintegergetID() : integerintegergetName() : stringstringgetNote() : stringstringgetTaskGenerationStatus() : integerintegergetTaskGenerationStatusStr() : stringstringgetTaskGroup() : TaskGroupgetTaskSubTypeCode() : integerintegergetTaskSubTypeKey() : stringstringgetTaskSubTypeName() : stringstringgetTestingTypeCode() : integerintegergetTestingTypeKey() : stringstringgetTestingTypeName() : stringstringisDisabledFlag() : booleanbooleanisTaskGenerationStatusFinished() : booleanbooleanisTaskGenerationStatusInProcess() : booleanbooleanonAdd()onDel()onUpdate()prepareETPartialGroupSettingArray() : luaTableluaTableprepareFTWholeCedentSettingArray() : luaTableluaTableprepareHypothesisArray() : luaTableluaTableprepareHypothesisGroupArray() : luaTableluaTablequeryTaskGenerationStatus() : integerinteger - one or zerorunAndWaitForResults()luaTable - to store named parameters
nTargetPlatform : integer - TargetPlatform code
bForceRunFinished : boolean - if true, forces the task to be run again even if it is already finished
integer - number of launched tasks (0 or 1)
runAsync()luaTable - to store named parameters
nTargetPlatform : integer - TargetPlatform code
bForceRunFinished : boolean - if true, forces the task to be run again even if it is already finished
integer - number of launched tasks
setDisabledFlag( boolean )booleansetHypothesisCountMax( integer )integersetName( string )string - cannot be emptysetNote( string )stringsetTaskGroup( TaskGroup )setTestingTypeCode( integer )integerwaitForResults()luaTable - to store named parameters
nSleepTime : integer - time (in milliseconds) between two checks for change in metabase