Github user jingyimei commented on a diff in the pull request:
https://github.com/apache/madlib/pull/191#discussion_r146700815
--- Diff: src/ports/postgres/modules/knn/knn.sql_in ---
@@ -96,19 +95,19 @@ in a column of type <tt>DOUBLE PRECISION[]</tt>.
<dt>point_id</dt>
<dd>TEXT. Name of the column in 'point_sourceâ containing source data
ids.
-The ids are of type INTEGER with no duplicates. They do not need to be
contiguous.
-This parameter must be used if the list of nearest neighbors are to be
output, i.e.,
+The ids are of type INTEGER with no duplicates. They do not need to be
contiguous.
+This parameter must be used if the list of nearest neighbors are to be
output, i.e.,
if the parameter 'output_neighbors' below is TRUE or if
'label_column_name' is NULL.
<dt>label_column_name</dt>
<dd>TEXT. Name of the column with labels/values of training data points.
-If Boolean, integer or text types will run knn classification, else if
-double precision values will run knn regression.
-If you set this to NULL will return neighbors only without doing
classification or regression.</dd>
+If Boolean, integer or text types will run KNN classification, else if
+double precision values will run KNN regression.
+If you set this to NULL, will return the set of neighbors only without
+actually doing classification or regression.</dd>
--- End diff --
When I read this, I had some problem understanding the sentence. Can we
modify this sentence like "If you set this to NULL, it will only return the set
of neighbors without actually doing classification or regression"?
---
