Github user sethah commented on a diff in the pull request:
https://github.com/apache/spark/pull/15555#discussion_r84798339
--- Diff: mllib/src/main/scala/org/apache/spark/ml/clustering/KMeans.scala
---
@@ -354,21 +354,41 @@ object KMeans extends DefaultParamsReadable[KMeans] {
@Since("2.0.0")
@Experimental
class KMeansSummary private[clustering] (
- @Since("2.0.0") @transient val predictions: DataFrame,
- @Since("2.0.0") val predictionCol: String,
- @Since("2.0.0") val featuresCol: String,
- @Since("2.0.0") val k: Int) extends Serializable {
+ predictions: DataFrame,
+ predictionCol: String,
+ featuresCol: String,
+ k: Int)
+ extends ClusteringSummary (
+ predictions,
+ predictionCol,
+ featuresCol,
+ k
+ )
+
+/**
+ * :: Experimental ::
+ * Summary of clustering.
+ *
+ * @param predictions [[DataFrame]] produced by model.transform()
+ * @param predictionCol Name for column of predicted clusters in
`predictions`
+ * @param featuresCol Name for column of features in `predictions`
+ * @param k Number of clusters
+ */
+@Experimental
--- End diff --
I'm not entirely certain on the official policy for the `@Since` tags, but
it seems better to me to put `@Since("2.1.0")` here for the class and the
methods. It will be correct for some and will at least not be incorrect for
others. I'm not positive though.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
