F_VN_CreateRTreesModelExp2

Create a random trees model of the specified type. The initial reference count is set to one if a new model is created and kept, otherwise. Models of this type neither support on-line training (sample by sample) nor retraining. Predictions can only be scalar. (expert function)

Syntax

Definition:

FUNCTION F_VN_CreateRTreesModelExp2 : HRESULT
VAR_INPUT
    ipMlModel           : Reference To  ITcVnMlModel;
    eRTreesType         : ETcVnRTrees;
    nMaxDepth           : UDINT;
    nMinSamples         : UDINT;
    nActiveVariables    : UDINT;
    nMaxIterations      : UDINT;
    fEpsilon            : LREAL;
    fRegressionAccuracy : REAL;
    ipClassPriors       : ITcVnContainer;
    hrPrev              : HRESULT;
END_VAR

Inputs

Name	Type	Description
ipMlModel	Reference To ITcVnMlModel	Returns the created model (Non-zero interface pointers are reused.)
eRTreesType	ETcVnRTrees	Random trees model type
nMaxDepth	UDINT	Maximum tree depth (default: 5)
nMinSamples	UDINT	Minimum number of samples within a node required for splitting (default: 10)
nActiveVariables	UDINT	Number of variables considered for splitting (0 means sqrt(total number of variables); default: 0)
nMaxIterations	UDINT	Maximum number of iterations (disabled if it equals 0 and fEpsilon is different from 0.0; triggers the usage of the default value of 50 if nMaxIterations and fEpsilon equal 0)
fEpsilon	LREAL	Maximum allowed difference of the error between two successive iterations (disabled if it equals 0.0 and nMaxIterations is different from 0; triggers the usage of the default value of 0.1 if nMaxIterations and fEpsilon equal 0)
fRegressionAccuracy	REAL	Termination criterion for regressors (only for regressors; set to default if not allowed; default: 0.0)
ipClassPriors	ITcVnContainer	Class priors (ContainerType_Vector_REAL or ContainerType_Vector_LREAL; only for classifiers; optional, set to 0 if not required or not allowed; default: 0)
hrPrev	HRESULT	HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.)

Return value

HRESULT

Weiterführende Informationen

Die Funktion F_VN_CreateRTReesModelExp2 ist eine Expert-Variante von F_VN_CreateRTreesModel. Sie enthält zusätzliche Parameter.

Parameter

Modell

In dem Interface Pointer ipMlModel wird das erstellte Modell zurückgegeben.

Modell-Typ

eRTreesType legt fest, ob das Random Forest-Modell zur Klassifizierung (TCVN_RT_CLASSIFIER) oder zur Regression (TCVN_RT_REGRESSOR) genutzt wird.

Maximale Baumtiefe

nMaxDepth gibt an, wie viele Entscheidungsebenen es maximal in einem Baum gibt.

Minimale Sample-Anzahl innerhalb eines Knotens

nMinSamples ist die minimale Anzahl an Samples, die während der Baumbildung in einem Knoten verbleiben muss. Aufspaltungen, die diese Anzahl unterschreiten würden, werden nicht durchgeführt.

Splitting-Merkmale

nActiveVariables ist die Anzahl an Merkmalen, die zum Aufteilen des Baumes genutzt werden. Bei 0 werden sqrt(N) Merkmale mit der Anzahl N aller verfügbaren Merkmale genutzt.

Maximale Iterationen

Für die Optimierung werden maximal so viele Iterationen genutzt, wie in nMaxIterations angegeben sind. Wenn der Wert 0 ist, wird der jeweilige Default-Wert verwendet.

Abbruchgrenze

Die Optimierung wird abgebrochen, sobald sich der Fehler zwischen zwei Iterationen nicht stärker verändert, als in fEpsilon angegeben ist. Wenn der Wert 0 ist, wird der jeweilige Default-Wert verwendet.

Regressionsgenauigkeit

fRegressionAccuracy ist das Abbruchkriterium für Regressionsoptimierung. Bei einer Klassifizierung muss der Wert auf 0 gesetzt werden.

Class-Priors

ipClassPriors ist ein Container, mit dem die Apriori-Wahrscheinlichkeiten der einzelnen Klassen angegeben werden können. Bei einer Regression sollte der Wert auf 0 gesetzt werden.

Anwendung

Ein RTrees-Modell zur Regression kann z.B. so erstellt werden:

hr := F_VN_CreateRTreesExp2(
    ipMlModel           := ipMlModel,
    eRTreesType         := TCVN_RT_REGRESSOR,
    nMaxDepth           := 8,
    nMinSamples         := 4,
    nActiveVariables    := 0,
    nMaxIterations      := 0,
    fEpsilon            := 0,
    fRegressionAccuracy := 0.3,
    ipClassPriors       := 0,
    hrPrev              := hr);

Required License

TC3 Vision Machine Learning

System Requirements

Development environment	Target platform	PLC libraries to include
TwinCAT V3.1. 4024.44 or later	PC or CX (x64) with PL50, e.g. Intel 4-core Atom CPU	Tc3_Vision