You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by jk...@apache.org on 2016/04/14 21:45:03 UTC
spark git commit: [SPARK-14618][ML][DOC] Updated
RegressionEvaluator.metricName param doc
Repository: spark
Updated Branches:
refs/heads/master c5172f820 -> bf65c87f7
[SPARK-14618][ML][DOC] Updated RegressionEvaluator.metricName param doc
## What changes were proposed in this pull request?
In Spark 1.4, we negated some metrics from RegressionEvaluator since CrossValidator always maximized metrics. This was fixed in 1.5, but the docs were not updated. This PR updates the docs.
## How was this patch tested?
no tests
Author: Joseph K. Bradley <jo...@databricks.com>
Closes #12377 from jkbradley/regeval-doc.
Project: http://git-wip-us.apache.org/repos/asf/spark/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/bf65c87f
Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/bf65c87f
Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/bf65c87f
Branch: refs/heads/master
Commit: bf65c87f706019d235d7093637341668a13b1be1
Parents: c5172f8
Author: Joseph K. Bradley <jo...@databricks.com>
Authored: Thu Apr 14 12:44:59 2016 -0700
Committer: Joseph K. Bradley <jo...@databricks.com>
Committed: Thu Apr 14 12:44:59 2016 -0700
----------------------------------------------------------------------
.../apache/spark/ml/evaluation/RegressionEvaluator.scala | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/spark/blob/bf65c87f/mllib/src/main/scala/org/apache/spark/ml/evaluation/RegressionEvaluator.scala
----------------------------------------------------------------------
diff --git a/mllib/src/main/scala/org/apache/spark/ml/evaluation/RegressionEvaluator.scala b/mllib/src/main/scala/org/apache/spark/ml/evaluation/RegressionEvaluator.scala
index 4134e2d..ed04b67 100644
--- a/mllib/src/main/scala/org/apache/spark/ml/evaluation/RegressionEvaluator.scala
+++ b/mllib/src/main/scala/org/apache/spark/ml/evaluation/RegressionEvaluator.scala
@@ -39,11 +39,12 @@ final class RegressionEvaluator @Since("1.4.0") (@Since("1.4.0") override val ui
def this() = this(Identifiable.randomUID("regEval"))
/**
- * param for metric name in evaluation (supports `"rmse"` (default), `"mse"`, `"r2"`, and `"mae"`)
+ * Param for metric name in evaluation. Supports:
+ * - `"rmse"` (default): root mean squared error
+ * - `"mse"`: mean squared error
+ * - `"r2"`: R^2^ metric
+ * - `"mae"`: mean absolute error
*
- * Because we will maximize evaluation value (ref: `CrossValidator`),
- * when we evaluate a metric that is needed to minimize (e.g., `"rmse"`, `"mse"`, `"mae"`),
- * we take and output the negative of this metric.
* @group param
*/
@Since("1.4.0")
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org