diff options
| author | BenFradet <benjamin.fradet@gmail.com> | 2016-01-06 12:01:05 -0800 |
|---|---|---|
| committer | Joseph K. Bradley <joseph@databricks.com> | 2016-01-06 12:01:05 -0800 |
| commit | f82ebb15224ec5375f25f67d598ec3ef1cb65210 (patch) | |
| tree | 3edc4fffa943a8298f71105ff15264317dfe9384 /mllib | |
| parent | fcd013cf70e7890aa25a8fe3cb6c8b36bf0e1f04 (diff) | |
| download | spark-f82ebb15224ec5375f25f67d598ec3ef1cb65210.tar.gz spark-f82ebb15224ec5375f25f67d598ec3ef1cb65210.tar.bz2 spark-f82ebb15224ec5375f25f67d598ec3ef1cb65210.zip | |
[SPARK-12368][ML][DOC] Better doc for the binary classification evaluator' metricName
For the BinaryClassificationEvaluator, the scaladoc doesn't mention that "areaUnderPR" is supported, only that the default is "areadUnderROC".
Also, in the documentation, it is said that:
"The default metric used to choose the best ParamMap can be overriden by the setMetric method in each of these evaluators."
However, the method is called setMetricName.
This PR aims to fix both issues.
Author: BenFradet <benjamin.fradet@gmail.com>
Closes #10328 from BenFradet/SPARK-12368.
Diffstat (limited to 'mllib')
| -rw-r--r-- | mllib/src/main/scala/org/apache/spark/ml/evaluation/BinaryClassificationEvaluator.scala | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/mllib/src/main/scala/org/apache/spark/ml/evaluation/BinaryClassificationEvaluator.scala b/mllib/src/main/scala/org/apache/spark/ml/evaluation/BinaryClassificationEvaluator.scala index bfb70963b1..f71726f110 100644 --- a/mllib/src/main/scala/org/apache/spark/ml/evaluation/BinaryClassificationEvaluator.scala +++ b/mllib/src/main/scala/org/apache/spark/ml/evaluation/BinaryClassificationEvaluator.scala @@ -39,8 +39,7 @@ class BinaryClassificationEvaluator @Since("1.4.0") (@Since("1.4.0") override va def this() = this(Identifiable.randomUID("binEval")) /** - * param for metric name in evaluation - * Default: areaUnderROC + * param for metric name in evaluation (supports `"areaUnderROC"` (default), `"areaUnderPR"`) * @group param */ @Since("1.2.0") |