org.apache.spark.mllib.clustering

Class BisectingKMeansModel

java.lang.Object

org.apache.spark.mllib.clustering.BisectingKMeansModel

All Implemented Interfaces:

java.io.Serializable, Saveable

public class BisectingKMeansModel
extends java.lang.Object
implements scala.Serializable, Saveable

Clustering model produced by BisectingKMeans. The prediction is done level-by-level from the root node to a leaf node, and at each node among its children the closest to the input point is selected.

param: root the root node of the clustering tree

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BisectingKMeansModel.SaveLoadV1_0$

Method Summary

Methods

Modifier and Type	Method and Description
Vector[]	clusterCenters() Leaf cluster centers.
double	computeCost(JavaRDD<Vector> data) Java-friendly version of computeCost().
double	computeCost(RDD<Vector> data) Computes the sum of squared distances between the input points and their corresponding cluster centers.
double	computeCost(Vector point) Computes the squared distance between the input point and the cluster center it belongs to.
protected java.lang.String	formatVersion() Current version of model save/load format.
protected static void	initializeLogIfNecessary(boolean isInterpreter)
protected static boolean	isTraceEnabled()
int	k() Number of leaf clusters.
static BisectingKMeansModel	load(SparkContext sc, 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)
JavaRDD<java.lang.Integer>	predict(JavaRDD<Vector> points) Java-friendly version of predict().
RDD<java.lang.Object>	predict(RDD<Vector> points) Predicts the indices of the clusters that the input points belong to.
int	predict(Vector point) Predicts the index of the cluster that the input point belongs to.
void	save(SparkContext sc, java.lang.String path) Save this model to the given path.

Methods inherited from class java.lang.Object

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

Method Detail

load

public static BisectingKMeansModel load(SparkContext sc,
                        java.lang.String path)

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)

clusterCenters

public Vector[] clusterCenters()

Leaf cluster centers.

Returns:

(undocumented)

k

public int k()

Number of leaf clusters.

Returns:

(undocumented)

predict

public int predict(Vector point)

Predicts the index of the cluster that the input point belongs to.

Parameters:

point - (undocumented)

Returns:

(undocumented)

predict

public RDD<java.lang.Object> predict(RDD<Vector> points)

Predicts the indices of the clusters that the input points belong to.

Parameters:

points - (undocumented)

Returns:

(undocumented)

predict

public JavaRDD<java.lang.Integer> predict(JavaRDD<Vector> points)

Java-friendly version of predict().

Parameters:

points - (undocumented)

Returns:

(undocumented)

computeCost

public double computeCost(Vector point)

Computes the squared distance between the input point and the cluster center it belongs to.

Parameters:

point - (undocumented)

Returns:

(undocumented)

computeCost

public double computeCost(RDD<Vector> data)

Computes the sum of squared distances between the input points and their corresponding cluster centers.

Parameters:

data - (undocumented)

Returns:

(undocumented)

computeCost

public double computeCost(JavaRDD<Vector> data)

Java-friendly version of computeCost().

Parameters:

data - (undocumented)

Returns:

(undocumented)

save

public void save(SparkContext sc,
        java.lang.String path)

Description copied from interface: Saveable

Save this model to the given path.

This saves: - human-readable (JSON) model metadata to path/metadata/ - Parquet formatted data to path/data/

The model may be loaded using Loader.load.

Specified by:

save in interface Saveable

Parameters:

sc - Spark context used to save model data.

path - Path specifying the directory in which to save this model. If the directory already exists, this method throws an exception.

formatVersion

protected java.lang.String formatVersion()

Description copied from interface: Saveable

Current version of model save/load format.

Specified by:

formatVersion in interface Saveable