F_VN_TrainBatchClusters

Train a clusterer with a batch of samples and return the IDs of the clusters the samples have been assigned to, if requested. On-line trainable clusterers are trained once with each sample. Depending on the application and the number of available training samples, repeated training of such models with the same data may improve the results.
Can use available TwinCAT Job Tasks for executing parallel code regions.

Syntax

Definition:

FUNCTION F_VN_TrainBatchClusters : HRESULT
VAR_INPUT
    ipClusterer : ITcVnMlModel;
    ipSamples   : ITcUnknown;
    ipClusters  : Reference To  ITcVnContainer;
    hrPrev      : HRESULT;
END_VAR

Inputs

Name	Type	Description
ipClusterer	ITcVnMlModel	Clusterer to be used
ipSamples	ITcUnknown	Container holding a batch of input samples (ContainerType_Vector_Vector_REAL or ContainerType_Vector_Vector_LREAL)
ipClusters	Reference To ITcVnContainer	Returns the IDs of the clusters the samples have been assigned to (ContainerType_Vector_DINT; optional, set to 0 if not required)
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_TrainBatchClusters trainiert ein Clusterer-Modell mit mehreren Samples. Im Vergleich zu F_VN_TrainBatch können zusätzlich die zugewiesenen Cluster für jedes Sample zurückgegeben werden.

Parameter

Clusterer-Modell

Das zuvor erstelle Clusterer-Modell muss an ipClusterer übergeben werden.

Samples

Die Samples werden in einem Container an ipSamples übergeben. Der Typ des Containers muss ContainerType_Vector_Vector_REAL oder ContainerType_Vector_Vector_LREAL sein.

Clusters

Die IDs der zugewiesenen Cluster werden in einem Container vom Typ ContainerType_Vector_DINT über die Referenz ipClusters zurückgegeben.

Anwendung

Ein Clusterer-Modell kann z.B. so trainiert werden:

hr := F_VN_TrainBatchClusters(
    ipClusterer := ipClusterModel,
    ipSamples   := ipSamples,
    ipClusters  := ipClusters,
    hrPrev      := hr);

hr := F_VN_GetAt_DINT(ipClusters, nClusterOfThirdSample, 2, hr);

Der Aufruf der F_VN_GetAt_DINT zeigt, wie direkt nach dem Training die Cluster-Zuordnung des 3. Samples abgefragt werden kann.

Required License

TC3 Vision Machine Learning

System Requirements

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