hex.kmeans

Class KMeans

java.lang.Object

water.Iced<T>

water.Keyed

water.Job<M>

hex.ModelBuilder<M,P,O>

hex.ClusteringModelBuilder<KMeansModel,KMeansModel.KMeansParameters,KMeansModel.KMeansOutput>

hex.kmeans.KMeans

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.Freezable

Direct Known Subclasses:

EmbeddedKMeans

public class KMeans
extends hex.ClusteringModelBuilder<KMeansModel,KMeansModel.KMeansParameters,KMeansModel.KMeansOutput>

Scalable K-Means++ (KMeans||)
http://theory.stanford.edu/~sergei/papers/vldb12-kmpar.pdf
http://www.youtube.com/watch?v=cigXAxV3XcY

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KMeans.Initialization

Nested classes/interfaces inherited from class hex.ModelBuilder

hex.ModelBuilder.BuilderVisibility

Nested classes/interfaces inherited from class water.Job

water.Job.JobCancelledException, water.Job.JobState, water.Job.Progress, water.Job.ProgressUpdate, water.Job.ValidationMessage

Nested classes/interfaces inherited from class water.Keyed

water.Keyed.BinarySerializer<X extends water.Keyed>

Field Summary

Fields inherited from class hex.ModelBuilder

_fold, _nclass, _offset, _parms, _response, _train, _valid, _vresponse, _weights

Fields inherited from class water.Job

_description, _dest, _end_time, _exception, _messages, _progressKey, _start_time, _state, LIST

Fields inherited from class water.Keyed

_key, EMPTY_KEY_LIST

Constructor Summary

Constructors

Constructor and Description
KMeans(water.Key dest, java.lang.String desc, KMeansModel.KMeansParameters parms)
KMeans(KMeansModel.KMeansParameters parms)

Method Summary

Methods

Modifier and Type	Method and Description
hex.ModelBuilder.BuilderVisibility	builderVisibility()
hex.ModelCategory[]	can_build()
protected void	checkMemoryFootPrint()
static water.util.TwoDimTable	createCenterTable(KMeansModel.KMeansOutput output, boolean standardized)
void	init(boolean expensive) Initialize the ModelBuilder, validating all arguments and preparing the training frame.
long	progressUnits()
hex.schemas.ModelBuilderSchema	schema()
water.Job<KMeansModel>	trainModelImpl(long work, boolean restartTimer) Start the KMeans training Job on an F/J thread.

Methods inherited from class hex.ClusteringModelBuilder

isSupervised

Methods inherited from class hex.ModelBuilder

canBeDone, cancel, checkDistributions, clearInitState, computeCrossValidation, computePriorClassDistribution, createModelBuilder, deleteProgressKey, error_count, getAlgo, getAlgo, getAlgo, getAlgoFullName, getModelBuilder, getModelBuilders, getModelClass, hasFoldCol, hasOffsetCol, hasWeightCol, ignoreBadColumns, ignoreStringColumns, isClassifier, modifyParmsForCrossValidationMainModel, modifyParmsForCrossValidationSplits, nclasses, nFoldCV, numSpecialCols, registerModelBuilder, response, responseMean, separateFeatureVecs, train, trainModel, updateModelOutput, valid, vresponse

Methods inherited from class water.Job

block, cancel, checksum_impl, clearValidationErrors, createProgressKey, dest, done, done, error_count_or_uninitialized, error, failed, get, hide, info, isCancelledOrCrashed, isDone, isRunning, isRunning, isStopped, jobKey, jobs, message, msec, progress_msg, progress, remove_impl, start, update, update, update, update, updateValidationMessages, validationErrors, warn

Methods inherited from class water.Keyed

checksum, getBinarySerializer, getPublishedKeys, remove, remove, remove, remove

Methods inherited from class water.Iced

clone, frozenType, read_impl, read, readExternal, readJSON_impl, readJSON, toJsonString, write_impl, write, writeExternal, writeJSON_impl, writeJSON

Methods inherited from class java.lang.Object

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

Constructor Detail

KMeans

public KMeans(water.Key dest,
      java.lang.String desc,
      KMeansModel.KMeansParameters parms)

KMeans

public KMeans(KMeansModel.KMeansParameters parms)

Method Detail

can_build

public hex.ModelCategory[] can_build()

Specified by:

can_build in class hex.ModelBuilder<KMeansModel,KMeansModel.KMeansParameters,KMeansModel.KMeansOutput>

builderVisibility

public hex.ModelBuilder.BuilderVisibility builderVisibility()

Specified by:

builderVisibility in class hex.ModelBuilder<KMeansModel,KMeansModel.KMeansParameters,KMeansModel.KMeansOutput>

schema

public hex.schemas.ModelBuilderSchema schema()

Specified by:

schema in class hex.ModelBuilder<KMeansModel,KMeansModel.KMeansParameters,KMeansModel.KMeansOutput>

checkMemoryFootPrint

protected void checkMemoryFootPrint()

Overrides:

checkMemoryFootPrint in class hex.ModelBuilder<KMeansModel,KMeansModel.KMeansParameters,KMeansModel.KMeansOutput>

trainModelImpl

public water.Job<KMeansModel> trainModelImpl(long work,
                                    boolean restartTimer)

Start the KMeans training Job on an F/J thread.

Specified by:

trainModelImpl in class hex.ModelBuilder<KMeansModel,KMeansModel.KMeansParameters,KMeansModel.KMeansOutput>

Parameters:

work -

restartTimer -

progressUnits

public long progressUnits()

Specified by:

progressUnits in class hex.ModelBuilder<KMeansModel,KMeansModel.KMeansParameters,KMeansModel.KMeansOutput>

init

public void init(boolean expensive)

Initialize the ModelBuilder, validating all arguments and preparing the training frame. This call is expected to be overridden in the subclasses and each subclass will start with "super.init();". Validate K, max_iterations and the number of rows.

Overrides:

init in class hex.ClusteringModelBuilder<KMeansModel,KMeansModel.KMeansParameters,KMeansModel.KMeansOutput>

createCenterTable

public static water.util.TwoDimTable createCenterTable(KMeansModel.KMeansOutput output,
                                       boolean standardized)