Packages

c

org.apache.spark.mllib.clustering

StreamingKMeansModel

class StreamingKMeansModel extends KMeansModel with Logging

StreamingKMeansModel extends MLlib's KMeansModel for streaming algorithms, so it can keep track of a continuously updated weight associated with each cluster, and also update the model by doing a single iteration of the standard k-means algorithm.

The update algorithm uses the "mini-batch" KMeans rule, generalized to incorporate forgetfulness (i.e. decay). The update rule (for each cluster) is:

$$ \begin{align} c_{t+1} &= [(c_t * n_t * a) + (x_t * m_t)] / [n_t + m_t] \\ n_{t+1} &= n_t * a + m_t \end{align} $$

Where c_t is the previously estimated centroid for that cluster, n_t is the number of points assigned to it thus far, x_t is the centroid estimated on the current batch, and m_t is the number of points assigned to that centroid in the current batch.

The decay factor 'a' scales the contribution of the clusters as estimated thus far, by applying a as a discount weighting on the current point when evaluating new incoming data. If a=1, all batches are weighted equally. If a=0, new centroids are determined entirely by recent data. Lower values correspond to more forgetting.

Decay can optionally be specified by a half life and associated time unit. The time unit can either be a batch of data or a single data point. Considering data arrived at time t, the half life h is defined such that at time t + h the discount applied to the data from t is 0.5. The definition remains the same whether the time unit is given as batches or points.

Annotations
@Since( "1.2.0" )
Source
StreamingKMeans.scala
Linear Supertypes
Logging, KMeansModel, PMMLExportable, Serializable, Serializable, Saveable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamingKMeansModel
  2. Logging
  3. KMeansModel
  4. PMMLExportable
  5. Serializable
  6. Serializable
  7. Saveable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StreamingKMeansModel(clusterCenters: Array[Vector], clusterWeights: Array[Double])
    Annotations
    @Since( "1.2.0" )

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. val clusterCenters: Array[Vector]
    Definition Classes
    StreamingKMeansModel → KMeansModel
    Annotations
    @Since( "1.2.0" )
  7. val clusterWeights: Array[Double]
    Annotations
    @Since( "1.2.0" )
  8. def computeCost(data: RDD[Vector]): Double

    Return the K-means cost (sum of squared distances of points to their nearest center) for this model on the given data.

    Return the K-means cost (sum of squared distances of points to their nearest center) for this model on the given data.

    Definition Classes
    KMeansModel
    Annotations
    @Since( "0.8.0" )
  9. val distanceMeasure: String
    Definition Classes
    KMeansModel
    Annotations
    @Since( "2.4.0" )
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  15. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  18. def k: Int

    Total number of clusters.

    Total number of clusters.

    Definition Classes
    KMeansModel
    Annotations
    @Since( "0.8.0" )
  19. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  20. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  21. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  22. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  23. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  24. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  25. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  26. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  27. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  28. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  29. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  30. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  34. def predict(points: JavaRDD[Vector]): JavaRDD[Integer]

    Maps given points to their cluster indices.

    Maps given points to their cluster indices.

    Definition Classes
    KMeansModel
    Annotations
    @Since( "1.0.0" )
  35. def predict(points: RDD[Vector]): RDD[Int]

    Maps given points to their cluster indices.

    Maps given points to their cluster indices.

    Definition Classes
    KMeansModel
    Annotations
    @Since( "1.0.0" )
  36. def predict(point: Vector): Int

    Returns the cluster index that a given point belongs to.

    Returns the cluster index that a given point belongs to.

    Definition Classes
    KMeansModel
    Annotations
    @Since( "0.8.0" )
  37. def save(sc: SparkContext, path: String): Unit

    Save this model to the given path.

    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.

    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.

    Definition Classes
    KMeansModel → Saveable
    Annotations
    @Since( "1.4.0" )
  38. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  39. def toPMML(): String

    Export the model to a String in PMML format

    Export the model to a String in PMML format

    Definition Classes
    PMMLExportable
    Annotations
    @Since( "1.4.0" )
  40. def toPMML(outputStream: OutputStream): Unit

    Export the model to the OutputStream in PMML format

    Export the model to the OutputStream in PMML format

    Definition Classes
    PMMLExportable
    Annotations
    @Since( "1.4.0" )
  41. def toPMML(sc: SparkContext, path: String): Unit

    Export the model to a directory on a distributed file system in PMML format

    Export the model to a directory on a distributed file system in PMML format

    Definition Classes
    PMMLExportable
    Annotations
    @Since( "1.4.0" )
  42. def toPMML(localPath: String): Unit

    Export the model to a local file in PMML format

    Export the model to a local file in PMML format

    Definition Classes
    PMMLExportable
    Annotations
    @Since( "1.4.0" )
  43. def toString(): String
    Definition Classes
    AnyRef → Any
  44. val trainingCost: Double
    Definition Classes
    KMeansModel
    Annotations
    @Since( "2.4.0" )
  45. def update(data: RDD[Vector], decayFactor: Double, timeUnit: String): StreamingKMeansModel

    Perform a k-means update on a batch of data.

    Perform a k-means update on a batch of data.

    Annotations
    @Since( "1.2.0" )
  46. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Logging

Inherited from KMeansModel

Inherited from PMMLExportable

Inherited from Serializable

Inherited from Serializable

Inherited from Saveable

Inherited from AnyRef

Inherited from Any

Ungrouped