org.apache.ignite.ml.knn.classification

Class KNNClassificationTrainer

java.lang.Object

org.apache.ignite.ml.trainers.DatasetTrainer<M,Double>

org.apache.ignite.ml.trainers.SingleLabelDatasetTrainer<KNNClassificationModel>

org.apache.ignite.ml.knn.classification.KNNClassificationTrainer

public class KNNClassificationTrainer
extends SingleLabelDatasetTrainer<KNNClassificationModel>

kNN algorithm trainer to solve multi-class classification task.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.ignite.ml.trainers.DatasetTrainer

DatasetTrainer.EmptyDatasetException

Field Summary

Fields inherited from class org.apache.ignite.ml.trainers.DatasetTrainer

environment

Constructor Summary

Constructors

Constructor and Description
KNNClassificationTrainer()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkState(KNNClassificationModel mdl)
<K,V> KNNClassificationModel	fit(DatasetBuilder<K,V> datasetBuilder, IgniteBiFunction<K,V,Vector> featureExtractor, IgniteBiFunction<K,V,Double> lbExtractor) Trains model based on the specified data.
<K,V> KNNClassificationModel	updateModel(KNNClassificationModel mdl, DatasetBuilder<K,V> datasetBuilder, IgniteBiFunction<K,V,Vector> featureExtractor, IgniteBiFunction<K,V,Double> lbExtractor) Gets state of model in arguments, update in according to new data and return new model.

Methods inherited from class org.apache.ignite.ml.trainers.DatasetTrainer

fit, fit, fit, fit, getLastTrainedModelOrThrowEmptyDatasetException, setEnvironment, update, update, update, update, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KNNClassificationTrainer

public KNNClassificationTrainer()

Method Detail

fit

public <K,V> KNNClassificationModel fit(DatasetBuilder<K,V> datasetBuilder,
                                        IgniteBiFunction<K,V,Vector> featureExtractor,
                                        IgniteBiFunction<K,V,Double> lbExtractor)

Trains model based on the specified data.

Specified by:

fit in class DatasetTrainer<KNNClassificationModel,Double>

Type Parameters:

K - Type of a key in upstream data.

V - Type of a value in upstream data.

Parameters:

datasetBuilder - Dataset builder.

featureExtractor - Feature extractor.

lbExtractor - Label extractor.

Returns:

Model.

updateModel

public <K,V> KNNClassificationModel updateModel(KNNClassificationModel mdl,
                                                DatasetBuilder<K,V> datasetBuilder,
                                                IgniteBiFunction<K,V,Vector> featureExtractor,
                                                IgniteBiFunction<K,V,Double> lbExtractor)

Gets state of model in arguments, update in according to new data and return new model.

Specified by:

updateModel in class DatasetTrainer<KNNClassificationModel,Double>

Type Parameters:

K - Type of a key in upstream data.

V - Type of a value in upstream data.

Parameters:

mdl - Learned model.

datasetBuilder - Dataset builder.

featureExtractor - Feature extractor.

lbExtractor - Label extractor.

Returns:

Updated model.

checkState

protected boolean checkState(KNNClassificationModel mdl)

Specified by:

checkState in class DatasetTrainer<KNNClassificationModel,Double>

Parameters:

mdl - Model.

Returns:

true if current critical for training parameters correspond to parameters from last training.