diff options
author | Yuhao Yang <hhbyyh@gmail.com> | 2015-11-30 14:56:51 -0800 |
---|---|---|
committer | Xiangrui Meng <meng@databricks.com> | 2015-11-30 14:56:51 -0800 |
commit | e232720a65dfb9ae6135cbb7674e35eddd88d625 (patch) | |
tree | 1ae892140c2fce646fff10a34cd64e9ac3d49955 /docs/ml-clustering.md | |
parent | a8ceec5e8c1572dd3d74783c06c78b7ca0b8a7ce (diff) | |
download | spark-e232720a65dfb9ae6135cbb7674e35eddd88d625.tar.gz spark-e232720a65dfb9ae6135cbb7674e35eddd88d625.tar.bz2 spark-e232720a65dfb9ae6135cbb7674e35eddd88d625.zip |
[SPARK-11689][ML] Add user guide and example code for LDA under spark.ml
jira: https://issues.apache.org/jira/browse/SPARK-11689
Add simple user guide for LDA under spark.ml and example code under examples/. Use include_example to include example code in the user guide markdown. Check SPARK-11606 for instructions.
Original PR is reverted due to document build error. https://github.com/apache/spark/pull/9722
mengxr feynmanliang yinxusen Sorry for the troubling.
Author: Yuhao Yang <hhbyyh@gmail.com>
Closes #9974 from hhbyyh/ldaMLExample.
Diffstat (limited to 'docs/ml-clustering.md')
-rw-r--r-- | docs/ml-clustering.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/ml-clustering.md b/docs/ml-clustering.md new file mode 100644 index 0000000000..cfefb5dfbd --- /dev/null +++ b/docs/ml-clustering.md @@ -0,0 +1,31 @@ +--- +layout: global +title: Clustering - ML +displayTitle: <a href="ml-guide.html">ML</a> - Clustering +--- + +In this section, we introduce the pipeline API for [clustering in mllib](mllib-clustering.html). + +## Latent Dirichlet allocation (LDA) + +`LDA` is implemented as an `Estimator` that supports both `EMLDAOptimizer` and `OnlineLDAOptimizer`, +and generates a `LDAModel` as the base models. Expert users may cast a `LDAModel` generated by +`EMLDAOptimizer` to a `DistributedLDAModel` if needed. + +<div class="codetabs"> + +<div data-lang="scala" markdown="1"> + +Refer to the [Scala API docs](api/scala/index.html#org.apache.spark.ml.clustering.LDA) for more details. + +{% include_example scala/org/apache/spark/examples/ml/LDAExample.scala %} +</div> + +<div data-lang="java" markdown="1"> + +Refer to the [Java API docs](api/java/org/apache/spark/ml/clustering/LDA.html) for more details. + +{% include_example java/org/apache/spark/examples/ml/JavaLDAExample.java %} +</div> + +</div>
\ No newline at end of file |