From 77b406d92cbfc235e985a15f9d79d6f47901fd93 Mon Sep 17 00:00:00 2001 From: Rerngvit Yanggratoke Date: Wed, 23 Sep 2015 10:37:48 +0200 Subject: [PATCH 1/4] Add documentation for CrossValidatorModel members: bestModel and avgMetrics --- .../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 0679bfd0f3ff..2aeed8871fd5 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 @@ -140,7 +140,11 @@ class CrossValidator(override val uid: String) extends Estimator[CrossValidatorM @Experimental class CrossValidatorModel private[ml] ( override val uid: String, + + /** The best model selected from cross validation */ val bestModel: Model[_], + + /** Average cross-validation metrics */ val avgMetrics: Array[Double]) extends Model[CrossValidatorModel] with CrossValidatorParams { From 9b95c611eccf1d239a76021af21883eb786f89b0 Mon Sep 17 00:00:00 2001 From: Rerngvit Yanggratoke Date: Sat, 26 Sep 2015 00:42:53 +0200 Subject: [PATCH 2/4] Add @param documentation for CrossValidatorModel members: bestModel and avgMetrics --- .../scala/org/apache/spark/ml/tuning/CrossValidator.scala | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) 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 2aeed8871fd5..69511e154a64 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,15 +136,14 @@ 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. */ @Experimental class CrossValidatorModel private[ml] ( override val uid: String, - - /** The best model selected from cross validation */ val bestModel: Model[_], - - /** Average cross-validation metrics */ val avgMetrics: Array[Double]) extends Model[CrossValidatorModel] with CrossValidatorParams { From 902ca0bbfde5350839b771b6bb4e774ea6fa92e4 Mon Sep 17 00:00:00 2001 From: Rerngvit Yanggratoke Date: Fri, 2 Oct 2015 09:41:00 +0200 Subject: [PATCH 3/4] [Spark-9798] Revised @param documentation for avgMetrics in CrossValidatorModel according to comment. --- .../main/scala/org/apache/spark/ml/tuning/CrossValidator.scala | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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 69511e154a64..820c9965d09b 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 @@ -138,7 +138,8 @@ class CrossValidator(override val uid: String) extends Estimator[CrossValidatorM * Model from k-fold cross validation. * * @param bestModel The best model selected from k-fold cross validation. - * @param avgMetrics Average cross-validation metrics. + * @param avgMetrics Average cross-validation metrics for each paramMap in [[estimatorParamMaps]], in the + * corresponding order. */ @Experimental class CrossValidatorModel private[ml] ( From 7523104af3c7885b95f13c421a94e3058f689940 Mon Sep 17 00:00:00 2001 From: Rerngvit Yanggratoke Date: Fri, 2 Oct 2015 09:41:00 +0200 Subject: [PATCH 4/4] [Spark-9798] Revised @param documentation for avgMetrics in CrossValidatorModel according to comment. --- .../main/scala/org/apache/spark/ml/tuning/CrossValidator.scala | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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 69511e154a64..820c9965d09b 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 @@ -138,7 +138,8 @@ class CrossValidator(override val uid: String) extends Estimator[CrossValidatorM * Model from k-fold cross validation. * * @param bestModel The best model selected from k-fold cross validation. - * @param avgMetrics Average cross-validation metrics. + * @param avgMetrics Average cross-validation metrics for each paramMap in [[estimatorParamMaps]], in the + * corresponding order. */ @Experimental class CrossValidatorModel private[ml] (