Repository: spark
Updated Branches:
  refs/heads/branch-1.0 235cfd0f6 -> d7db2e63a


MLlib documentation fix

Synchronized mllib-optimization.md with Spark Scaladoc: removed reference to 
GradientDescent.runMiniBatchSGD method

This is a temporary fix to remove  a link from 
http://spark.apache.org/docs/latest/mllib-optimization.html to 
GradientDescent.runMiniBatchSGD which is not in the current online 
GradientDescent Scaladoc.
FIXME: revert this commit after GradientDescent Scaladoc is updated.
See images for details.

![mllib-docs-fix-1](https://cloud.githubusercontent.com/assets/1375501/3294410/ccf19bb8-f5a8-11e3-93f1-f593016209eb.png)
![mllib-docs-fix-2](https://cloud.githubusercontent.com/assets/1375501/3294411/d0b59a7e-f5a8-11e3-8fc8-329c177ef8c8.png)

Author: Anatoli Fomenko <f...@apache.org>

Closes #1098 from afomenko/master and squashes the following commits:

5cb0758 [Anatoli Fomenko] MLlib documentation fix

(cherry picked from commit 7afa912e747c77ebfd10bddf7bda2e3190fdeb9c)
Signed-off-by: Xiangrui Meng <m...@databricks.com>


Project: http://git-wip-us.apache.org/repos/asf/spark/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/d7db2e63
Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/d7db2e63
Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/d7db2e63

Branch: refs/heads/branch-1.0
Commit: d7db2e63a474d1fae3864872269f248df64e6510
Parents: 235cfd0
Author: Anatoli Fomenko <f...@apache.org>
Authored: Mon Jun 16 23:10:36 2014 -0700
Committer: Xiangrui Meng <m...@databricks.com>
Committed: Mon Jun 16 23:10:51 2014 -0700

----------------------------------------------------------------------
 docs/mllib-optimization.md | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/spark/blob/d7db2e63/docs/mllib-optimization.md
----------------------------------------------------------------------
diff --git a/docs/mllib-optimization.md b/docs/mllib-optimization.md
index 97e8f4e..ae9ede5 100644
--- a/docs/mllib-optimization.md
+++ b/docs/mllib-optimization.md
@@ -147,9 +147,9 @@ are developed, see the
 <a href="mllib-linear-methods.html">linear methods</a> 
 section for example.
 
-The SGD method
-[GradientDescent.runMiniBatchSGD](api/scala/index.html#org.apache.spark.mllib.optimization.GradientDescent)
-has the following parameters:
+The SGD class
+[GradientDescent](api/scala/index.html#org.apache.spark.mllib.optimization.GradientDescent)
+sets the following parameters:
 
 * `Gradient` is a class that computes the stochastic gradient of the function
 being optimized, i.e., with respect to a single training example, at the
@@ -171,7 +171,7 @@ each iteration, to compute the gradient direction.
 
 Available algorithms for gradient descent:
 
-* 
[GradientDescent.runMiniBatchSGD](api/scala/index.html#org.apache.spark.mllib.optimization.GradientDescent)
+* 
[GradientDescent](api/scala/index.html#org.apache.spark.mllib.optimization.GradientDescent)
 
 ### L-BFGS
 L-BFGS is currently only a low-level optimization primitive in `MLlib`. If you 
want to use L-BFGS in various 

Reply via email to