aboutsummaryrefslogtreecommitdiff
path: root/python
diff options
context:
space:
mode:
authorXiangrui Meng <meng@databricks.com>2015-08-13 10:16:40 -0700
committerXiangrui Meng <meng@databricks.com>2015-08-13 10:16:40 -0700
commit65fec798ce52ca6b8b0fe14b78a16712778ad04c (patch)
tree1612ad4d54c0c3224247a3bdd2e367fa49434f57 /python
parent4b70798c96b0a784b85fda461426ec60f609be12 (diff)
downloadspark-65fec798ce52ca6b8b0fe14b78a16712778ad04c.tar.gz
spark-65fec798ce52ca6b8b0fe14b78a16712778ad04c.tar.bz2
spark-65fec798ce52ca6b8b0fe14b78a16712778ad04c.zip
[MINOR] [DOC] fix mllib pydoc warnings
Switch to correct Sphinx syntax. MechCoder Author: Xiangrui Meng <meng@databricks.com> Closes #8169 from mengxr/mllib-pydoc-fix.
Diffstat (limited to 'python')
-rw-r--r--python/pyspark/mllib/regression.py14
-rw-r--r--python/pyspark/mllib/util.py1
2 files changed, 11 insertions, 4 deletions
diff --git a/python/pyspark/mllib/regression.py b/python/pyspark/mllib/regression.py
index 5b7afc15dd..41946e3674 100644
--- a/python/pyspark/mllib/regression.py
+++ b/python/pyspark/mllib/regression.py
@@ -207,8 +207,10 @@ class LinearRegressionWithSGD(object):
Train a linear regression model using Stochastic Gradient
Descent (SGD).
This solves the least squares regression formulation
- f(weights) = 1/n ||A weights-y||^2^
- (which is the mean squared error).
+
+ f(weights) = 1/(2n) ||A weights - y||^2,
+
+ which is the mean squared error.
Here the data matrix has n rows, and the input RDD holds the
set of rows of A, each with its corresponding right hand side
label y. See also the documentation for the precise formulation.
@@ -334,7 +336,9 @@ class LassoWithSGD(object):
Stochastic Gradient Descent.
This solves the l1-regularized least squares regression
formulation
- f(weights) = 1/2n ||A weights-y||^2^ + regParam ||weights||_1
+
+ f(weights) = 1/(2n) ||A weights - y||^2 + regParam ||weights||_1.
+
Here the data matrix has n rows, and the input RDD holds the
set of rows of A, each with its corresponding right hand side
label y. See also the documentation for the precise formulation.
@@ -451,7 +455,9 @@ class RidgeRegressionWithSGD(object):
Stochastic Gradient Descent.
This solves the l2-regularized least squares regression
formulation
- f(weights) = 1/2n ||A weights-y||^2^ + regParam/2 ||weights||^2^
+
+ f(weights) = 1/(2n) ||A weights - y||^2 + regParam/2 ||weights||^2.
+
Here the data matrix has n rows, and the input RDD holds the
set of rows of A, each with its corresponding right hand side
label y. See also the documentation for the precise formulation.
diff --git a/python/pyspark/mllib/util.py b/python/pyspark/mllib/util.py
index 916de2d6fc..10a1e4b3eb 100644
--- a/python/pyspark/mllib/util.py
+++ b/python/pyspark/mllib/util.py
@@ -300,6 +300,7 @@ class LinearDataGenerator(object):
:param: seed Random Seed
:param: eps Used to scale the noise. If eps is set high,
the amount of gaussian noise added is more.
+
Returns a list of LabeledPoints of length nPoints
"""
weights = [float(weight) for weight in weights]