fix doc

apache · May 4, 2015 · babdde7 · babdde7
1 parent cb51e6a
commit babdde7
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 4 deletions.
diff --git a/python/docs/pyspark.ml.rst b/python/docs/pyspark.ml.rst
@@ -24,3 +24,19 @@ pyspark.ml.classification module
     :members:
     :undoc-members:
     :inherited-members:
+
+pyspark.ml.tuning module
+--------------------------------
+
+.. automodule:: pyspark.ml.tuning
+    :members:
+    :undoc-members:
+    :inherited-members:
+
+pyspark.ml.evaluation module
+--------------------------------
+
+.. automodule:: pyspark.ml.evaluation
+    :members:
+    :undoc-members:
+    :inherited-members:
diff --git a/python/pyspark/ml/evaluation.py b/python/pyspark/ml/evaluation.py
@@ -19,10 +19,12 @@
 from pyspark.ml.param import Param, Params
 from pyspark.ml.param.shared import HasLabelCol, HasRawPredictionCol
 from pyspark.ml.util import keyword_only
+from pyspark.mllib.common import inherit_doc
 
 __all__ = ['BinaryClassificationEvaluator']
 
 
+@inherit_doc
 class BinaryClassificationEvaluator(JavaEvaluator, HasLabelCol, HasRawPredictionCol):
     """
     Evaluator for binary classification, which expects two input
@@ -51,7 +53,7 @@ class BinaryClassificationEvaluator(JavaEvaluator, HasLabelCol, HasRawPrediction
     def __init__(self, rawPredictionCol="rawPrediction", labelCol="label",
                  metricName="areaUnderROC"):
         """
-        __init__(self, rawPredictionCol="rawPrediction", labelCol="label",
+        __init__(self, rawPredictionCol="rawPrediction", labelCol="label", \
                  metricName="areaUnderROC")
         """
         super(BinaryClassificationEvaluator, self).__init__()
@@ -80,7 +82,7 @@ def getMetricName(self):
     def setParams(self, rawPredictionCol="rawPrediction", labelCol="label",
                   metricName="areaUnderROC"):
         """
-        setParams(self, rawPredictionCol="rawPrediction", labelCol="label",
+        setParams(self, rawPredictionCol="rawPrediction", labelCol="label", \
                   metricName="areaUnderROC")
         Sets params for binary classification evaluator.
         """

diff --git a/python/pyspark/ml/pipeline.py b/python/pyspark/ml/pipeline.py
@@ -181,8 +181,9 @@ class Evaluator(object):
     def evaluate(self, dataset, params={}):
         """
         Evaluates the output.
-        :param dataset: a dataset that contains labels/observations
-                        and predictions
+
+        :param dataset: a dataset that contains labels/observations and
+                        predictions
         :param params: an optional param map that overrides embedded
                        params
         :return: metric