diff options
| author | Xiangrui Meng <meng@databricks.com> | 2015-02-15 20:29:26 -0800 |
|---|---|---|
| committer | Xiangrui Meng <meng@databricks.com> | 2015-02-15 20:29:26 -0800 |
| commit | cd4a15366244657c4b7936abe5054754534366f2 (patch) | |
| tree | fbee98a5031440c879705f2c7f9717b5d815c66e /python/docs | |
| parent | 836577b382695558f5c97d94ee725d0156ebfad2 (diff) | |
| download | spark-cd4a15366244657c4b7936abe5054754534366f2.tar.gz spark-cd4a15366244657c4b7936abe5054754534366f2.tar.bz2 spark-cd4a15366244657c4b7936abe5054754534366f2.zip | |
[SPARK-5769] Set params in constructors and in setParams in Python ML pipelines
This PR allow Python users to set params in constructors and in setParams, where we use decorator `keyword_only` to force keyword arguments. The trade-off is discussed in the design doc of SPARK-4586.
Generated doc:
CC: davies rxin
Author: Xiangrui Meng <meng@databricks.com>
Closes #4564 from mengxr/py-pipeline-kw and squashes the following commits:
fedf720 [Xiangrui Meng] use toDF
d565f2c [Xiangrui Meng] Merge remote-tracking branch 'apache/master' into py-pipeline-kw
cbc15d3 [Xiangrui Meng] fix style
5032097 [Xiangrui Meng] update pipeline signature
950774e [Xiangrui Meng] simplify keyword_only and update constructor/setParams signatures
fdde5fc [Xiangrui Meng] fix style
c9384b8 [Xiangrui Meng] fix sphinx doc
8e59180 [Xiangrui Meng] add setParams and make constructors take params, where we force keyword args
Diffstat (limited to 'python/docs')
| -rw-r--r-- | python/docs/conf.py | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/python/docs/conf.py b/python/docs/conf.py index b00dce95d6..cbbf7ffb08 100644 --- a/python/docs/conf.py +++ b/python/docs/conf.py @@ -97,6 +97,10 @@ pygments_style = 'sphinx' # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False +# -- Options for autodoc -------------------------------------------------- + +# Look at the first line of the docstring for function and method signatures. +autodoc_docstring_signature = True # -- Options for HTML output ---------------------------------------------- |