Github user sethah commented on a diff in the pull request:
https://github.com/apache/spark/pull/11844#discussion_r62518857
--- Diff: docs/ml-clustering.md ---
@@ -104,4 +104,48 @@ Refer to the [Java API
docs](api/java/org/apache/spark/ml/clustering/LDA.html) f
{% include_example java/org/apache/spark/examples/ml/JavaLDAExample.java %}
</div>
-</div>
\ No newline at end of file
+</div>
+
+## Bisecting k-means
+
+
+Bisecting k-means is a kind of [hierarchical
clustering](https://en.wikipedia.org/wiki/Hierarchical_clustering) using a
+divisive (or "top-down") approach: all observations start in one cluster,
and splits are performed recursively as one
+moves down the hierarchy.
+
+Bisecting K-means can often be much faster than regular K-means, but it
will generally produce a different clustering.
+
+`BisectingKMeans` is implemented as an `Estimator` and generates a
`BisectingKMeansModel` as the base model.
+
+The implementation in ML has the following parameters:
+
+* *k*: the desired number of leaf clusters (default: 4). The actual number
could be smaller if there are no divisible leaf clusters.
--- End diff --
We don't seem to be listing the params in the ML user guides like was
previously done in mllib. I also think this is hard to maintain: what if the
default values change or new params are added?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
