Skip to content

[SPARK-14618][ML][DOC] Updated RegressionEvaluator.metricName param doc #12377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[SPARK-14618][ML][DOC] Updated RegressionEvaluator.metricName param doc #12377

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions mllib/src/main/scala/org/apache/spark/ml/evaluation/RegressionEvaluator.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down