From babdde75a3f040ae86a9af37aa47cf128febf5f7 Mon Sep 17 00:00:00 2001 From: Xiangrui Meng Date: Mon, 4 May 2015 01:11:28 -0700 Subject: [PATCH] fix doc --- python/docs/pyspark.ml.rst | 16 ++++++++++++++++ python/pyspark/ml/evaluation.py | 6 ++++-- python/pyspark/ml/pipeline.py | 5 +++-- 3 files changed, 23 insertions(+), 4 deletions(-) diff --git a/python/docs/pyspark.ml.rst b/python/docs/pyspark.ml.rst index 4da6d4a74a299..220ea595df903 100644 --- 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 index 35aea39d5cb18..ef8a1b65d72ba 100644 --- 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 index 69a5f21f53996..7b875e4b71254 100644 --- 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