aboutsummaryrefslogtreecommitdiff
path: root/mllib
diff options
context:
space:
mode:
Diffstat (limited to 'mllib')
-rw-r--r--mllib/src/main/scala/org/apache/spark/mllib/optimization/GradientDescent.scala12
1 files changed, 7 insertions, 5 deletions
diff --git a/mllib/src/main/scala/org/apache/spark/mllib/optimization/GradientDescent.scala b/mllib/src/main/scala/org/apache/spark/mllib/optimization/GradientDescent.scala
index 3b663b5def..37bb6f6097 100644
--- a/mllib/src/main/scala/org/apache/spark/mllib/optimization/GradientDescent.scala
+++ b/mllib/src/main/scala/org/apache/spark/mllib/optimization/GradientDescent.scala
@@ -81,11 +81,13 @@ class GradientDescent private[spark] (private var gradient: Gradient, private va
* Set the convergence tolerance. Default 0.001
* convergenceTol is a condition which decides iteration termination.
* The end of iteration is decided based on below logic.
- * - If the norm of the new solution vector is >1, the diff of solution vectors
- * is compared to relative tolerance which means normalizing by the norm of
- * the new solution vector.
- * - If the norm of the new solution vector is <=1, the diff of solution vectors
- * is compared to absolute tolerance which is not normalizing.
+ *
+ * - If the norm of the new solution vector is >1, the diff of solution vectors
+ * is compared to relative tolerance which means normalizing by the norm of
+ * the new solution vector.
+ * - If the norm of the new solution vector is <=1, the diff of solution vectors
+ * is compared to absolute tolerance which is not normalizing.
+ *
* Must be between 0.0 and 1.0 inclusively.
*/
def setConvergenceTol(tolerance: Double): this.type = {