Modify the docs of KMeans, according to mllib's KMeans

feynmanliang · Jul 16, 2015 · 978ee2c · 978ee2c
1 parent 2ec80bc
commit 978ee2c
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/mllib/src/main/scala/org/apache/spark/ml/clustering/KMeans.scala b/mllib/src/main/scala/org/apache/spark/ml/clustering/KMeans.scala
@@ -135,7 +135,9 @@ class KMeansModel private[ml] (
 
 /**
  * :: Experimental ::
- * KMeans API for spark.ml Pipeline.
+ * K-means clustering with support for multiple parallel runs and a k-means++ like initialization
+ * mode (the k-means|| algorithm by Bahmani et al). When multiple concurrent runs are requested,
+ * they are executed together with joint passes over the data for efficiency.
  */
 @Experimental
 class KMeans(override val uid: String) extends Estimator[KMeansModel] with KMeansParams {