aboutsummaryrefslogtreecommitdiff
path: root/docs/ml-clustering.md
diff options
context:
space:
mode:
authorYuhao Yang <hhbyyh@gmail.com>2015-11-20 09:57:09 -0800
committerXiangrui Meng <meng@databricks.com>2015-11-20 09:57:09 -0800
commite359d5dcf5bd300213054ebeae9fe75c4f7eb9e7 (patch)
treef008aa43b00a40ecb4ebc20f47b9de6a57d47702 /docs/ml-clustering.md
parent9ace2e5c8d7fbd360a93bc5fc4eace64a697b44f (diff)
downloadspark-e359d5dcf5bd300213054ebeae9fe75c4f7eb9e7.tar.gz
spark-e359d5dcf5bd300213054ebeae9fe75c4f7eb9e7.tar.bz2
spark-e359d5dcf5bd300213054ebeae9fe75c4f7eb9e7.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. Author: Yuhao Yang <hhbyyh@gmail.com> Closes #9722 from hhbyyh/ldaMLExample.
Diffstat (limited to 'docs/ml-clustering.md')
-rw-r--r--docs/ml-clustering.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/ml-clustering.md b/docs/ml-clustering.md
new file mode 100644
index 0000000000..1743ef43a6
--- /dev/null
+++ b/docs/ml-clustering.md
@@ -0,0 +1,30 @@
+---
+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">
+
+Refer to the [Scala API docs](api/scala/index.html#org.apache.spark.ml.clustering.LDA) for more details.
+
+<div data-lang="scala" markdown="1">
+{% 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