org.apache.spark.ml.clustering

Class KMeans

java.lang.Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Estimator<KMeansModel>

org.apache.spark.ml.clustering.KMeans

All Implemented Interfaces:

java.io.Serializable, Params, Identifiable

public class KMeans
extends Estimator<KMeansModel>

:: Experimental :: K-means clustering with support for k-means|| initialization proposed by Bahmani et al.

See Also:

, Serialized Form

Constructor Summary

Constructors

Constructor and Description
KMeans()
KMeans(java.lang.String uid)

Method Summary

Methods

Modifier and Type	Method and Description
protected static <T> T	$(Param<T> param)
static Params	clear(Param<?> param)
KMeans	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
protected static <T extends Params> T	copyValues(T to, ParamMap extra)
protected static <T extends Params> ParamMap	copyValues$default$2()
protected static <T extends Params> T	defaultCopy(ParamMap extra)
static java.lang.String	explainParam(Param<?> param)
static java.lang.String	explainParams()
static ParamMap	extractParamMap()
static ParamMap	extractParamMap(ParamMap extra)
static Param<java.lang.String>	featuresCol()
KMeansModel	fit(Dataset<?> dataset) Fits a model to the input data.
static <T> scala.Option<T>	get(Param<T> param)
static <T> scala.Option<T>	getDefault(Param<T> param)
static java.lang.String	getFeaturesCol()
static java.lang.String	getInitMode()
java.lang.String	getInitMode()
static int	getInitSteps()
int	getInitSteps()
static int	getK()
int	getK()
static int	getMaxIter()
static <T> T	getOrDefault(Param<T> param)
static Param<java.lang.Object>	getParam(java.lang.String paramName)
static java.lang.String	getPredictionCol()
static long	getSeed()
static double	getTol()
static <T> boolean	hasDefault(Param<T> param)
static boolean	hasParam(java.lang.String paramName)
protected static void	initializeLogIfNecessary(boolean isInterpreter)
static Param<java.lang.String>	initMode()
Param<java.lang.String>	initMode() Param for the initialization algorithm.
static IntParam	initSteps()
IntParam	initSteps() Param for the number of steps for the k-means|| initialization mode.
static boolean	isDefined(Param<?> param)
static boolean	isSet(Param<?> param)
protected static boolean	isTraceEnabled()
static IntParam	k()
IntParam	k() Set the number of clusters to create (k).
static KMeans	load(java.lang.String path)
protected static org.slf4j.Logger	log()
protected static void	logDebug(scala.Function0<java.lang.String> msg)
protected static void	logDebug(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static void	logError(scala.Function0<java.lang.String> msg)
protected static void	logError(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static void	logInfo(scala.Function0<java.lang.String> msg)
protected static void	logInfo(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static java.lang.String	logName()
protected static void	logTrace(scala.Function0<java.lang.String> msg)
protected static void	logTrace(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static void	logWarning(scala.Function0<java.lang.String> msg)
protected static void	logWarning(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
static IntParam	maxIter()
static Param<?>[]	params()
static Param<java.lang.String>	predictionCol()
static void	save(java.lang.String path)
static LongParam	seed()
static <T> Params	set(Param<T> param, T value)
protected static Params	set(ParamPair<?> paramPair)
protected static Params	set(java.lang.String param, java.lang.Object value)
protected static <T> Params	setDefault(Param<T> param, T value)
protected static Params	setDefault(scala.collection.Seq<ParamPair<?>> paramPairs)
KMeans	setFeaturesCol(java.lang.String value)
KMeans	setInitMode(java.lang.String value)
KMeans	setInitSteps(int value)
KMeans	setK(int value)
KMeans	setMaxIter(int value)
KMeans	setPredictionCol(java.lang.String value)
KMeans	setSeed(long value)
KMeans	setTol(double value)
static DoubleParam	tol()
static java.lang.String	toString()
StructType	transformSchema(StructType schema) :: DeveloperApi ::
java.lang.String	uid() An immutable unique ID for the object and its derivatives.
protected static StructType	validateAndTransformSchema(StructType schema)
StructType	validateAndTransformSchema(StructType schema) Validates and transforms the input schema.
static void	validateParams()
static MLWriter	write()

Methods inherited from class org.apache.spark.ml.Estimator

fit, fit, fit, fit

Methods inherited from class org.apache.spark.ml.PipelineStage

transformSchema

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.spark.ml.param.Params

clear, copyValues, defaultCopy, defaultParamMap, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn, validateParams

Methods inherited from interface org.apache.spark.ml.util.Identifiable

toString

Constructor Detail

KMeans

public KMeans(java.lang.String uid)

KMeans

public KMeans()

Method Detail

load

public static KMeans load(java.lang.String path)

toString

public static java.lang.String toString()

params

public static Param<?>[] params()

validateParams

public static void validateParams()

explainParam

public static java.lang.String explainParam(Param<?> param)

explainParams

public static java.lang.String explainParams()

isSet

public static final boolean isSet(Param<?> param)

isDefined

public static final boolean isDefined(Param<?> param)

hasParam

public static boolean hasParam(java.lang.String paramName)

getParam

public static Param<java.lang.Object> getParam(java.lang.String paramName)

set

public static final <T> Params set(Param<T> param,
             T value)

set

protected static final Params set(java.lang.String param,
         java.lang.Object value)

set

protected static final Params set(ParamPair<?> paramPair)

get

public static final <T> scala.Option<T> get(Param<T> param)

clear

public static final Params clear(Param<?> param)

getOrDefault

public static final <T> T getOrDefault(Param<T> param)

$

protected static final <T> T $(Param<T> param)

setDefault

protected static final <T> Params setDefault(Param<T> param,
                    T value)

setDefault

protected static final Params setDefault(scala.collection.Seq<ParamPair<?>> paramPairs)

getDefault

public static final <T> scala.Option<T> getDefault(Param<T> param)

hasDefault

public static final <T> boolean hasDefault(Param<T> param)

defaultCopy

protected static final <T extends Params> T defaultCopy(ParamMap extra)

extractParamMap

public static final ParamMap extractParamMap(ParamMap extra)

extractParamMap

public static final ParamMap extractParamMap()

copyValues

protected static <T extends Params> T copyValues(T to,
                              ParamMap extra)

copyValues$default$2

protected static <T extends Params> ParamMap copyValues$default$2()

logName

protected static java.lang.String logName()

log

protected static org.slf4j.Logger log()

logInfo

protected static void logInfo(scala.Function0<java.lang.String> msg)

logDebug

protected static void logDebug(scala.Function0<java.lang.String> msg)

logTrace

protected static void logTrace(scala.Function0<java.lang.String> msg)

logWarning

protected static void logWarning(scala.Function0<java.lang.String> msg)

logError

protected static void logError(scala.Function0<java.lang.String> msg)

logInfo

protected static void logInfo(scala.Function0<java.lang.String> msg,
           java.lang.Throwable throwable)

logDebug

protected static void logDebug(scala.Function0<java.lang.String> msg,
            java.lang.Throwable throwable)

logTrace

protected static void logTrace(scala.Function0<java.lang.String> msg,
            java.lang.Throwable throwable)

logWarning

protected static void logWarning(scala.Function0<java.lang.String> msg,
              java.lang.Throwable throwable)

logError

protected static void logError(scala.Function0<java.lang.String> msg,
            java.lang.Throwable throwable)

isTraceEnabled

protected static boolean isTraceEnabled()

initializeLogIfNecessary

protected static void initializeLogIfNecessary(boolean isInterpreter)

maxIter

public static final IntParam maxIter()

getMaxIter

public static final int getMaxIter()

featuresCol

public static final Param<java.lang.String> featuresCol()

getFeaturesCol

public static final java.lang.String getFeaturesCol()

seed

public static final LongParam seed()

getSeed

public static final long getSeed()

predictionCol

public static final Param<java.lang.String> predictionCol()

getPredictionCol

public static final java.lang.String getPredictionCol()

tol

public static final DoubleParam tol()

getTol

public static final double getTol()

k

public static final IntParam k()

getK

public static int getK()

initMode

public static final Param<java.lang.String> initMode()

getInitMode

public static java.lang.String getInitMode()

initSteps

public static final IntParam initSteps()

getInitSteps

public static int getInitSteps()

validateAndTransformSchema

protected static StructType validateAndTransformSchema(StructType schema)

save

public static void save(java.lang.String path)
                 throws java.io.IOException

Throws:

java.io.IOException

write

public static MLWriter write()

uid

public java.lang.String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

Specified by:

uid in interface Identifiable

Returns:

(undocumented)

copy

public KMeans copy(ParamMap extra)

Description copied from interface: Params

Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly.

Specified by:

copy in interface Params

Specified by:

copy in class Estimator<KMeansModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

See Also:

defaultCopy()

setFeaturesCol

public KMeans setFeaturesCol(java.lang.String value)

setPredictionCol

public KMeans setPredictionCol(java.lang.String value)

setK

public KMeans setK(int value)

setInitMode

public KMeans setInitMode(java.lang.String value)

setInitSteps

public KMeans setInitSteps(int value)

setMaxIter

public KMeans setMaxIter(int value)

setTol

public KMeans setTol(double value)

setSeed

public KMeans setSeed(long value)

fit

public KMeansModel fit(Dataset<?> dataset)

Description copied from class: Estimator

Fits a model to the input data.

Specified by:

fit in class Estimator<KMeansModel>

Parameters:

dataset - (undocumented)

Returns:

(undocumented)

transformSchema

public StructType transformSchema(StructType schema)

Description copied from class: PipelineStage

:: DeveloperApi ::

Derives the output schema from the input schema.

Specified by:

transformSchema in class PipelineStage

Parameters:

schema - (undocumented)

Returns:

(undocumented)

k

public IntParam k()

Set the number of clusters to create (k). Must be > 1. Default: 2.

Returns:

(undocumented)

getK

public int getK()

initMode

public Param<java.lang.String> initMode()

Param for the initialization algorithm. This can be either "random" to choose random points as initial cluster centers, or "k-means||" to use a parallel variant of k-means++ (Bahmani et al., Scalable K-Means++, VLDB 2012). Default: k-means||.

Returns:

(undocumented)

getInitMode

public java.lang.String getInitMode()

initSteps

public IntParam initSteps()

Param for the number of steps for the k-means|| initialization mode. This is an advanced setting -- the default of 5 is almost always enough. Must be > 0. Default: 5.

Returns:

(undocumented)

getInitSteps

public int getInitSteps()

validateAndTransformSchema

public StructType validateAndTransformSchema(StructType schema)

Validates and transforms the input schema.

Parameters:

schema - input schema

Returns:

output schema