F_VN_CreateKmppModelExp

Create a k-means++ 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. (expert function)

Syntax

Definition:

FUNCTION F_VN_CreateKmppModelExp : HRESULT
VAR_INPUT
    ipMlModel        : Reference To  ITcVnMlModel;
    eKmppType        : ETcVnPrototypeClusterer;
    nK               : UDINT;
    bDoublePrecision : BOOL;
    nMaxIterations   : UDINT;
    fEpsilon         : LREAL;
    hrPrev           : HRESULT;
END_VAR

Inputs

Name	Type	Description
ipMlModel	Reference To ITcVnMlModel	Returns the created model (Non-zero interface pointers are reused.)
eKmppType	ETcVnPrototypeClusterer	k-means++ model type
nK	UDINT	Parameter k (number of clusters)
bDoublePrecision	BOOL	If true, the model is generated with double precision (LREAL) instead of single precision (REAL). (default: FALSE)
nMaxIterations	UDINT	Maximum number of iterations (triggers the usage of the default value of 10 if it equals 0)
fEpsilon	LREAL	Maximum allowed difference of the error between two successive iterations (triggers the usage of the default value of 0.001 if it equals 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_CreateKmppModelExp ist die Expert-Variante von F_VN_CreateKmppModel. Sie enthält zusätzliche Parameter.

Parameter

Modell

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

Modell-Typ

eKmppType legt fest, ob K-Means++ zum Clustering (TCVN_PC_CLUSTERER) oder zur Anomalie-Detektion (TCVN_PC_NOVELTY_DETECTOR) genutzt wird.

Anzahl von Clustern

Die Anzahl der Cluster im K-Means++ Modell wird durch nK angegeben und kann nach der Erstellung nicht mehr geändert werden. Beim Training muss die Anzahl der Samples größer-gleich der Anzahl von Clustern sein.

Höhere Genauigkeit

Wenn bDoublePrecision TRUE ist, wird LREAL als Datentyp für die internen Berechnungen des Modells genutzt; wenn es FALSE ist, wird REAL 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.

Anwendung

Ein K-Means++ Modell für Clustering mit 5 Clustern kann z.B. so erstellt werden:

hr := F_VN_CreateKmppModelExp(
    ipMlModel           := ipMlModel,
    eKmppType           := TCVN_PC_CLUSTERER,
    nK                  := 5,
    bDoublePrecision    := FALSE,
    nMaxIterations      := 0,
    fEpsilon            := 0,
    hrPrev              := hr);

Required License

TC3 Machine Learning Realtime Inference

System Requirements

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