aboutsummaryrefslogtreecommitdiff
path: root/mllib/src
diff options
context:
space:
mode:
authorFeynman Liang <fliang@databricks.com>2015-08-25 13:23:15 -0700
committerJoseph K. Bradley <joseph@databricks.com>2015-08-25 13:23:15 -0700
commit9205907876cf65695e56c2a94bedd83df3675c03 (patch)
tree963b36a11bb85789ad89551ed4a2d548f94ea47a /mllib/src
parentc619c7552f22d28cfa321ce671fc9ca854dd655f (diff)
downloadspark-9205907876cf65695e56c2a94bedd83df3675c03.tar.gz
spark-9205907876cf65695e56c2a94bedd83df3675c03.tar.bz2
spark-9205907876cf65695e56c2a94bedd83df3675c03.zip
[SPARK-9797] [MLLIB] [DOC] StreamingLinearRegressionWithSGD.setConvergenceTol default value
Adds default convergence tolerance (0.001, set in `GradientDescent.convergenceTol`) to `setConvergenceTol`'s scaladoc Author: Feynman Liang <fliang@databricks.com> Closes #8424 from feynmanliang/SPARK-9797.
Diffstat (limited to 'mllib/src')
-rw-r--r--mllib/src/main/scala/org/apache/spark/mllib/regression/StreamingLinearRegressionWithSGD.scala2
1 files changed, 1 insertions, 1 deletions
diff --git a/mllib/src/main/scala/org/apache/spark/mllib/regression/StreamingLinearRegressionWithSGD.scala b/mllib/src/main/scala/org/apache/spark/mllib/regression/StreamingLinearRegressionWithSGD.scala
index 537a05274e..26654e4a06 100644
--- a/mllib/src/main/scala/org/apache/spark/mllib/regression/StreamingLinearRegressionWithSGD.scala
+++ b/mllib/src/main/scala/org/apache/spark/mllib/regression/StreamingLinearRegressionWithSGD.scala
@@ -93,7 +93,7 @@ class StreamingLinearRegressionWithSGD private[mllib] (
}
/**
- * Set the convergence tolerance.
+ * Set the convergence tolerance. Default: 0.001.
*/
def setConvergenceTol(tolerance: Double): this.type = {
this.algorithm.optimizer.setConvergenceTol(tolerance)