org.apache.ignite.ml.clustering.kmeans

Class KMeansTrainer

java.lang.Object

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

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

org.apache.ignite.ml.clustering.kmeans.KMeansTrainer

public class KMeansTrainer
extends SingleLabelDatasetTrainer<KMeansModel>

The trainer for KMeans algorithm.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KMeansTrainer.TotalCostAndCounts Service class used for statistics.

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
KMeansTrainer()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkState(KMeansModel mdl)
<K,V> KMeansModel	fit(DatasetBuilder<K,V> datasetBuilder, IgniteBiFunction<K,V,Vector> featureExtractor, IgniteBiFunction<K,V,Double> lbExtractor) Trains model based on the specified data.
int	getAmountOfClusters() Gets the amount of clusters.
DistanceMeasure	getDistance() Gets the distance.
double	getEpsilon() Gets the epsilon.
int	getMaxIterations() Gets the max number of iterations before convergence.
long	getSeed() Gets the seed number.
protected <K,V> KMeansModel	updateModel(KMeansModel 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.
KMeansTrainer	withAmountOfClusters(int k) Set up the amount of clusters.
KMeansTrainer	withDistance(DistanceMeasure distance) Set up the distance.
KMeansTrainer	withEpsilon(double epsilon) Set up the epsilon.
KMeansTrainer	withMaxIterations(int maxIterations) Set up the max number of iterations before convergence.
KMeansTrainer	withSeed(long seed) Set up the seed.

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

KMeansTrainer

public KMeansTrainer()

Method Detail

fit

public <K,V> KMeansModel 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<KMeansModel,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

protected <K,V> KMeansModel updateModel(KMeansModel 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<KMeansModel,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(KMeansModel mdl)

Specified by:

checkState in class DatasetTrainer<KMeansModel,Double>

Parameters:

mdl - Model.

Returns:

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

getAmountOfClusters

public int getAmountOfClusters()

Gets the amount of clusters.

Returns:

The parameter value.

withAmountOfClusters

public KMeansTrainer withAmountOfClusters(int k)

Set up the amount of clusters.

Parameters:

k - The parameter value.

Returns:

Model with new amount of clusters parameter value.

getMaxIterations

public int getMaxIterations()

Gets the max number of iterations before convergence.

Returns:

The parameter value.

withMaxIterations

public KMeansTrainer withMaxIterations(int maxIterations)

Set up the max number of iterations before convergence.

Parameters:

maxIterations - The parameter value.

Returns:

Model with new max number of iterations before convergence parameter value.

getEpsilon

public double getEpsilon()

Gets the epsilon.

Returns:

The parameter value.

withEpsilon

public KMeansTrainer withEpsilon(double epsilon)

Set up the epsilon.

Parameters:

epsilon - The parameter value.

Returns:

Model with new epsilon parameter value.

getDistance

public DistanceMeasure getDistance()

Gets the distance.

Returns:

The parameter value.

withDistance

public KMeansTrainer withDistance(DistanceMeasure distance)

Set up the distance.

Parameters:

distance - The parameter value.

Returns:

Model with new distance parameter value.

getSeed

public long getSeed()

Gets the seed number.

Returns:

The parameter value.

withSeed

public KMeansTrainer withSeed(long seed)

Set up the seed.

Parameters:

seed - The parameter value.

Returns:

Model with new seed parameter value.