From 2a717821bbb026d4d8c43d31b3300721357951c6 Mon Sep 17 00:00:00 2001
From: Rerngvit Yanggratoke <rerngvit@kth.se>
Date: Fri, 2 Oct 2015 10:15:02 -0700
Subject: [PATCH] [SPARK-9798] [ML] CrossValidatorModel Documentation
 Improvements

Document CrossValidatorModel members: bestModel and avgMetrics

Author: Rerngvit Yanggratoke <rerngvit@kth.se>

Closes #8882 from rerngvit/Spark-9798.
---
 .../scala/org/apache/spark/ml/tuning/CrossValidator.scala     | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/mllib/src/main/scala/org/apache/spark/ml/tuning/CrossValidator.scala b/mllib/src/main/scala/org/apache/spark/ml/tuning/CrossValidator.scala
index 0679bfd0f3..820c9965d0 100644
--- a/mllib/src/main/scala/org/apache/spark/ml/tuning/CrossValidator.scala
+++ b/mllib/src/main/scala/org/apache/spark/ml/tuning/CrossValidator.scala
@@ -136,6 +136,10 @@ class CrossValidator(override val uid: String) extends Estimator[CrossValidatorM
 /**
  * :: Experimental ::
  * Model from k-fold cross validation.
+ *
+ * @param bestModel The best model selected from k-fold cross validation.
+ * @param avgMetrics Average cross-validation metrics for each paramMap in [[estimatorParamMaps]], in the
+ *                   corresponding order.
  */
 @Experimental
 class CrossValidatorModel private[ml] (
-- 
GitLab