diff options
author | lewuathe <lewuathe@me.com> | 2014-12-17 17:31:24 -0800 |
---|---|---|
committer | Xiangrui Meng <meng@databricks.com> | 2014-12-17 17:31:24 -0800 |
commit | 3cd516191baadf8496ccdae499771020e89acd7e (patch) | |
tree | 879897b87f1874368f317b6586ff5651ec8e89a0 /python/pyspark/mllib/feature.py | |
parent | ca1260891adb87f4985d3cfc515b4756644630d0 (diff) | |
download | spark-3cd516191baadf8496ccdae499771020e89acd7e.tar.gz spark-3cd516191baadf8496ccdae499771020e89acd7e.tar.bz2 spark-3cd516191baadf8496ccdae499771020e89acd7e.zip |
[SPARK-4822] Use sphinx tags for Python doc annotations
Modify python annotations for sphinx. There is no change to build process from.
https://github.com/apache/spark/blob/master/docs/README.md
Author: lewuathe <lewuathe@me.com>
Closes #3685 from Lewuathe/sphinx-tag-for-pydoc and squashes the following commits:
88a0fd9 [lewuathe] [SPARK-4822] Fix DevelopApi and WARN tags
3d7a398 [lewuathe] [SPARK-4822] Use sphinx tags for Python doc annotations
Diffstat (limited to 'python/pyspark/mllib/feature.py')
-rw-r--r-- | python/pyspark/mllib/feature.py | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/python/pyspark/mllib/feature.py b/python/pyspark/mllib/feature.py index e46af20886..10df628806 100644 --- a/python/pyspark/mllib/feature.py +++ b/python/pyspark/mllib/feature.py @@ -36,7 +36,7 @@ __all__ = ['Normalizer', 'StandardScalerModel', 'StandardScaler', class VectorTransformer(object): """ - :: DeveloperApi :: + .. note:: DeveloperApi Base class for transformation of a vector or RDD of vector """ @@ -51,7 +51,7 @@ class VectorTransformer(object): class Normalizer(VectorTransformer): """ - :: Experimental :: + .. note:: Experimental Normalizes samples individually to unit L\ :sup:`p`\ norm @@ -112,7 +112,7 @@ class JavaVectorTransformer(JavaModelWrapper, VectorTransformer): class StandardScalerModel(JavaVectorTransformer): """ - :: Experimental :: + .. note:: Experimental Represents a StandardScaler model that can transform vectors. """ @@ -129,7 +129,7 @@ class StandardScalerModel(JavaVectorTransformer): class StandardScaler(object): """ - :: Experimental :: + .. note:: Experimental Standardizes features by removing the mean and scaling to unit variance using column summary statistics on the samples in the @@ -172,7 +172,7 @@ class StandardScaler(object): class HashingTF(object): """ - :: Experimental :: + .. note:: Experimental Maps a sequence of terms to their term frequencies using the hashing trick. @@ -232,7 +232,7 @@ class IDFModel(JavaVectorTransformer): class IDF(object): """ - :: Experimental :: + .. note:: Experimental Inverse document frequency (IDF). |