diff options
| author | Cheng Lian <lian@databricks.com> | 2015-12-01 10:21:31 -0800 |
|---|---|---|
| committer | Michael Armbrust <michael@databricks.com> | 2015-12-01 10:21:31 -0800 |
| commit | 69dbe6b40df35d488d4ee343098ac70d00bbdafb (patch) | |
| tree | a9e966eeb648874ba5c09d4c5855828d928d8f15 /mllib | |
| parent | 1401166576c7018c5f9c31e0a6703d5fb16ea339 (diff) | |
| download | spark-69dbe6b40df35d488d4ee343098ac70d00bbdafb.tar.gz spark-69dbe6b40df35d488d4ee343098ac70d00bbdafb.tar.bz2 spark-69dbe6b40df35d488d4ee343098ac70d00bbdafb.zip | |
[SPARK-12046][DOC] Fixes various ScalaDoc/JavaDoc issues
This PR backports PR #10039 to master
Author: Cheng Lian <lian@databricks.com>
Closes #10063 from liancheng/spark-12046.doc-fix.master.
Diffstat (limited to 'mllib')
| -rw-r--r-- | mllib/src/main/scala/org/apache/spark/mllib/optimization/GradientDescent.scala | 12 |
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 = { |