diff options
| author | Rerngvit Yanggratoke <rerngvit@kth.se> | 2015-10-02 10:15:02 -0700 |
|---|---|---|
| committer | Joseph K. Bradley <joseph@databricks.com> | 2015-10-02 10:15:02 -0700 |
| commit | 2a717821bbb026d4d8c43d31b3300721357951c6 (patch) | |
| tree | ee08599a0c54494d694cb65b4ee0c29fc36f5f60 | |
| parent | 2272962eb087ffedaee12c761506e33e45bd0239 (diff) | |
| download | spark-2a717821bbb026d4d8c43d31b3300721357951c6.tar.gz spark-2a717821bbb026d4d8c43d31b3300721357951c6.tar.bz2 spark-2a717821bbb026d4d8c43d31b3300721357951c6.zip | |
[SPARK-9798] [ML] CrossValidatorModel Documentation Improvements
Document CrossValidatorModel members: bestModel and avgMetrics
Author: Rerngvit Yanggratoke <rerngvit@kth.se>
Closes #8882 from rerngvit/Spark-9798.
| -rw-r--r-- | mllib/src/main/scala/org/apache/spark/ml/tuning/CrossValidator.scala | 4 |
1 files changed, 4 insertions, 0 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 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] ( |