More documentation

msjgriffiths · Oct 25, 2014 · ea9877c · ea9877c
1 parent 9facbe3
commit ea9877c
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/mllib/src/main/scala/org/apache/spark/mllib/clustering/StreamingKMeans.scala b/mllib/src/main/scala/org/apache/spark/mllib/clustering/StreamingKMeans.scala
@@ -62,6 +62,16 @@ import org.apache.spark.streaming.StreamingContext._
  * This decay fraction can be specified in units of 'points' or 'batches'.
  * if 'batches', behavior will be independent of the number of points per batch;
  * if 'points', the expected number of points per batch must be specified.
+ *
+ * Use a builder pattern to construct a streaming KMeans analysis
+ * in an application, like:
+ *
+ *  val model = new StreamingKMeans()
+ *    .setDecayFactor(0.5)
+ *    .setK(3)
+ *    .setRandomCenters(5)
+ *    .trainOn(DStream)
+ *
  */
 @DeveloperApi
 class StreamingKMeansModel(