update doc

rxin · Jan 19, 2015 · d9ea77c · d9ea77c
1 parent c18dca1
commit d9ea77c
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 4 deletions.
diff --git a/python/docs/pyspark.ml.rst b/python/docs/pyspark.ml.rst
@@ -5,9 +5,33 @@ Submodules
 ----------
 
 pyspark.ml module
--------------------------
+-----------------
 
 .. automodule:: pyspark.ml
     :members:
     :undoc-members:
     :show-inheritance:
+
+pyspark.ml.param module
+-----------------------
+
+.. automodule:: pyspark.ml.param
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyspark.ml.feature module
+-------------------------
+
+.. automodule:: pyspark.ml.feature
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyspark.ml.classification module
+--------------------------------
+
+.. automodule:: pyspark.ml.classification
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/python/pyspark/ml/__init__.py b/python/pyspark/ml/__init__.py
@@ -22,7 +22,7 @@
 from pyspark.ml.param import Param, Params
 from pyspark.ml.util import Identifiable
 
-__all__ = ["Pipeline", "Transformer", "Estimator"]
+__all__ = ["Pipeline", "Transformer", "Estimator", "param", "feature", "classification"]
 
 
 def _jvm():

diff --git a/python/pyspark/ml/classification.py b/python/pyspark/ml/classification.py
@@ -15,11 +15,12 @@
 # limitations under the License.
 #
 
-from pyspark.sql import SchemaRDD
+from pyspark.sql import SchemaRDD, inherit_doc
 from pyspark.ml import Estimator, Transformer, _jvm
 from pyspark.ml.param import Param
 
 
+@inherit_doc
 class LogisticRegression(Estimator):
     """
     Logistic regression.

diff --git a/python/pyspark/ml/feature.py b/python/pyspark/ml/feature.py
@@ -15,10 +15,11 @@
 # limitations under the License.
 #
 
-from pyspark.sql import SchemaRDD, ArrayType, StringType
+from pyspark.sql import SchemaRDD, ArrayType, StringType, inherit_doc
 from pyspark.ml import Transformer, _jvm
 from pyspark.ml.param import Param
 
+@inherit_doc
 class Tokenizer(Transformer):
 
     def __init__(self):
@@ -61,6 +62,7 @@ def transform(self, dataset, params={}):
             raise ValueError("The input params must be either a dict or a list.")
 
 
+@inherit_doc
 class HashingTF(Transformer):
 
     def __init__(self):