F_VN_TrainSampleScalar

F_VN_TrainSampleScalar 1:

Train a regressor with a single sample and scalar output.

Syntax

Definition:

FUNCTION F_VN_TrainSampleScalar : HRESULT
VAR_INPUT
    ipRegressor : ITcVnMlModel;
    ipSample    : ITcUnknown;
    fOutput     : REAL;
    hrPrev      : HRESULT;
END_VAR

F_VN_TrainSampleScalar 2: Inputs

Name

Type

Description

ipRegressor

ITcVnMlModel

Regressor to be used

ipSample

ITcUnknown

Container holding a single input sample (ContainerType_Vector_REAL or ContainerType_Vector_LREAL)

fOutput

REAL

Scalar output to be learnt

hrPrev

HRESULT

HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.)

F_VN_TrainSampleScalar 3: Return value

HRESULT

Further information

The function F_VN_TrainSampleScalar trains a scalar regressor model with a sample.

Parameter

Regressor model

The previously created regressor model must be transferred to ipRegressor.

Sample

The sample container is transferred as ipSample. The type of container must be ContainerType_Vector_REAL or ContainerType_Vector_LREAL.

Training value

The result value of the sample is transferred to fOutput.

Application

For example, a scalar regressor model can be trained with a single sample as follows:

hr := F_VN_TrainSampleScalar(
    ipRegressor     := ipRegressorModel,
    ipSample        := ipSample,
    fOutput         := fOutput,
    hrPrev          := hr);

Related functions

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