diff options
author | Yu ISHIKAWA <yuu.ishikawa@gmail.com> | 2015-11-09 16:25:29 -0800 |
---|---|---|
committer | Joseph K. Bradley <joseph@databricks.com> | 2015-11-09 16:25:29 -0800 |
commit | 7dc9d8dba6c4bc655896b137062d896dec4ef64a (patch) | |
tree | b7b73aa6253112429762b8daf09902291c4088cc /python/pyspark/mllib | |
parent | 675c7e723cadff588405c23826a00686587728b8 (diff) | |
download | spark-7dc9d8dba6c4bc655896b137062d896dec4ef64a.tar.gz spark-7dc9d8dba6c4bc655896b137062d896dec4ef64a.tar.bz2 spark-7dc9d8dba6c4bc655896b137062d896dec4ef64a.zip |
[SPARK-11610][MLLIB][PYTHON][DOCS] Make the docs of LDAModel.describeTopics in Python more specific
cc jkbradley
Author: Yu ISHIKAWA <yuu.ishikawa@gmail.com>
Closes #9577 from yu-iskw/SPARK-11610.
Diffstat (limited to 'python/pyspark/mllib')
-rw-r--r-- | python/pyspark/mllib/clustering.py | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/python/pyspark/mllib/clustering.py b/python/pyspark/mllib/clustering.py index 12081f8c69..1fa061dc2d 100644 --- a/python/pyspark/mllib/clustering.py +++ b/python/pyspark/mllib/clustering.py @@ -734,6 +734,12 @@ class LDAModel(JavaModelWrapper, JavaSaveable, Loader): """Return the topics described by weighted terms. WARNING: If vocabSize and k are large, this can return a large object! + + :param maxTermsPerTopic: Maximum number of terms to collect for each topic. + (default: vocabulary size) + :return: Array over topics. Each topic is represented as a pair of matching arrays: + (term indices, term weights in topic). + Each topic's terms are sorted in order of decreasing weight. """ if maxTermsPerTopic is None: topics = self.call("describeTopics") |