ODIn/spark-instrumented-optimizer
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

MLlib documentation fix

Browse source 
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 <fa@apache.org>

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

5cb0758 [Anatoli Fomenko] MLlib documentation fix
This commit is contained in:
Anatoli Fomenko 2014-06-16 23:10:36 -07:00 committed by Xiangrui Meng
parent 237b96bc59
commit 7afa912e74
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/mllib-optimization.md
View file

@ -147,9 +147,9 @@ are developed, see the
<a href="mllib-linear-methods.html">linear methods</a> <a href="mllib-linear-methods.html">linear methods</a>
section for example. section for example.
The SGD method The SGD class
[GradientDescent.runMiniBatchSGD](api/scala/index.html#org.apache.spark.mllib.optimization.GradientDescent) [GradientDescent](api/scala/index.html#org.apache.spark.mllib.optimization.GradientDescent)
has the following parameters: sets the following parameters:
* `Gradient` is a class that computes the stochastic gradient of the function * `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 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: 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
L-BFGS is currently only a low-level optimization primitive in `MLlib`. If you want to use L-BFGS in various L-BFGS is currently only a low-level optimization primitive in `MLlib`. If you want to use L-BFGS in various