Github user sethah commented on a diff in the pull request:
https://github.com/apache/spark/pull/15874#discussion_r87871105
--- Diff: mllib/src/main/scala/org/apache/spark/ml/feature/LSH.scala ---
@@ -106,22 +106,24 @@ private[ml] abstract class LSHModel[T <: LSHModel[T]]
* transformed data when necessary.
*
* This method implements two ways of fetching k nearest neighbors:
- * - Single Probing: Fast, return at most k elements (Probing only one
buckets)
- * - Multiple Probing: Slow, return exact k elements (Probing multiple
buckets close to the key)
+ * - Single-probe: Fast, return at most k elements (Probing only one
buckets)
+ * - Multi-probe: Slow, return exact k elements (Probing multiple
buckets close to the key)
+ *
+ * Currently it is made private since more discussion is needed for
Multi-probe
--- End diff --
I don't understand the point here. Are you trying to make the
`approxNearestNeighbors` method completely private? There is still a public
overload of this method - which now shows up as the only method in the docs and
just says "overloaded method for approxNearestNeighbors". This doc above does
not show up.
As a general rule, we should always generate and closely inspect the docs
to make sure that they are what we intend and that they make sense from an end
user's perspective.
---
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 infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
