Github user tillrohrmann commented on a diff in the pull request:
https://github.com/apache/flink/pull/1220#discussion_r63698264
--- Diff: docs/libs/ml/knn.md ---
@@ -0,0 +1,145 @@
+---
+mathjax: include
+htmlTitle: FlinkML - k-nearest neighbors
+title: <a href="../ml">FlinkML</a> - knn
+---
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+* This will be replaced by the TOC
+{:toc}
+
+## Description
+Implements an exact k-nearest neighbors algorithm. Given a training set
$A$ and a testing set $B$, the algorithm returns
+
+$$
+KNN(A,B, k) = \{ \left( b, KNN(b,A) \right) where b \in B and KNN(b, A, k)
are the k-nearest points to b in A \}
+$$
+
+The brute-force approach is to compute the distance between every training
and testing point. To ease the brute-force computation of computing the
distance between every traning point a quadtree is used. The quadtree scales
well in the number of training points, though poorly in the spatial dimension.
The algorithm will automatically choose whether or not to use the quadtree,
though the user can override that decision by setting a parameter to force use
or not use a quadtree.
+
+##Operations
+
+`KNN` is a `Predictor`.
+As such, it supports the `fit` and `predict` operation.
+
+### Fit
+
+KNN is trained given a set of `LabeledVector`:
+
+* `fit: DataSet[LabeledVector] => Unit`
+
+### Predict
+
+KNN predicts for all subtypes of FlinkML's `Vector` the corresponding
class label:
+
+* `predict[T <: Vector]: DataSet[T] => DataSet[(T, Array[Vector])]`, where
the `(T, Array[Vector])` tuple
+ corresponds to (testPoint, K-nearest training points)
+
+## Paremeters
+The KNN implementation can be controlled by the following parameters:
+
+ <table class="table table-bordered">
+ <thead>
+ <tr>
+ <th class="text-left" style="width: 20%">Parameters</th>
+ <th class="text-center">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+ <tr>
+ <td><strong>K</strong></td>
+ <td>
+ <p>
+ Defines the number of nearest-neighbors to search for. That
is, for each test point, the algorithm finds the K-nearest neighbors in the
training set
+ (Default value: <strong>5</strong>)
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><strong>DistanceMetric</strong></td>
+ <td>
+ <p>
+ Sets the distance metric we use to calculate the distance
between two points. If no metric is specified, then
[[org.apache.flink.ml.metrics.distances.EuclideanDistanceMetric]] is used.
+ (Default value: <strong>EuclideanDistanceMetric</strong>)
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><strong>Blocks</strong></td>
+ <td>
+ <p>
+ Sets the number of blocks into which the input data will be
split. This number should be set
+ at least to the degree of parallelism. If no value is
specified, then the parallelism of the
+ input [[DataSet]] is used as the number of blocks.
+ (Default value: <strong>None</strong>)
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><strong>UseQuadTreeParam</strong></td>
+ <td>
+ <p>
+ A boolean variable that whether or not to use a Quadtree to
partition the training set to potentially simplify the KNN search. If no value
is specified, the code will automatically decide whether or not to use a
Quadtree. Use of a Quadtree scales well with the number of training and
testing points, though poorly with the dimension.
+ (Default value: <strong>None</strong>)
--- End diff --
A boolean value should be either true or false
---
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.
---
