Skip to content

Commit babdde7

Browse files
committed
fix doc
1 parent cb51e6a commit babdde7

File tree

3 files changed

+23
-4
lines changed

3 files changed

+23
-4
lines changed

python/docs/pyspark.ml.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,19 @@ pyspark.ml.classification module
2424
:members:
2525
:undoc-members:
2626
:inherited-members:
27+
28+
pyspark.ml.tuning module
29+
--------------------------------
30+
31+
.. automodule:: pyspark.ml.tuning
32+
:members:
33+
:undoc-members:
34+
:inherited-members:
35+
36+
pyspark.ml.evaluation module
37+
--------------------------------
38+
39+
.. automodule:: pyspark.ml.evaluation
40+
:members:
41+
:undoc-members:
42+
:inherited-members:

python/pyspark/ml/evaluation.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,12 @@
1919
from pyspark.ml.param import Param, Params
2020
from pyspark.ml.param.shared import HasLabelCol, HasRawPredictionCol
2121
from pyspark.ml.util import keyword_only
22+
from pyspark.mllib.common import inherit_doc
2223

2324
__all__ = ['BinaryClassificationEvaluator']
2425

2526

27+
@inherit_doc
2628
class BinaryClassificationEvaluator(JavaEvaluator, HasLabelCol, HasRawPredictionCol):
2729
"""
2830
Evaluator for binary classification, which expects two input
@@ -51,7 +53,7 @@ class BinaryClassificationEvaluator(JavaEvaluator, HasLabelCol, HasRawPrediction
5153
def __init__(self, rawPredictionCol="rawPrediction", labelCol="label",
5254
metricName="areaUnderROC"):
5355
"""
54-
__init__(self, rawPredictionCol="rawPrediction", labelCol="label",
56+
__init__(self, rawPredictionCol="rawPrediction", labelCol="label", \
5557
metricName="areaUnderROC")
5658
"""
5759
super(BinaryClassificationEvaluator, self).__init__()
@@ -80,7 +82,7 @@ def getMetricName(self):
8082
def setParams(self, rawPredictionCol="rawPrediction", labelCol="label",
8183
metricName="areaUnderROC"):
8284
"""
83-
setParams(self, rawPredictionCol="rawPrediction", labelCol="label",
85+
setParams(self, rawPredictionCol="rawPrediction", labelCol="label", \
8486
metricName="areaUnderROC")
8587
Sets params for binary classification evaluator.
8688
"""

python/pyspark/ml/pipeline.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,9 @@ class Evaluator(object):
181181
def evaluate(self, dataset, params={}):
182182
"""
183183
Evaluates the output.
184-
:param dataset: a dataset that contains labels/observations
185-
and predictions
184+
185+
:param dataset: a dataset that contains labels/observations and
186+
predictions
186187
:param params: an optional param map that overrides embedded
187188
params
188189
:return: metric

0 commit comments

Comments
 (0)