Permalink
Browse files

Update KNN classifier documentation to make the input pattern require…

…ments clear in both learn and infer
  • Loading branch information...
scottpurdy committed Jan 10, 2018
1 parent 5ecae91 commit ffd1457037a52cb63a7be0cf004e886f3909f505
Showing with 5 additions and 4 deletions.
  1. +5 −4 src/nupic/algorithms/knn_classifier.py
@@ -422,9 +422,9 @@ def learn(self, inputPattern, inputCategory, partitionId=None, isSparse=0,
within distThreshold, only the first partitionId will be stored). This
is an optional parameter.
:param isSparse: (int) If 0, the input pattern is a dense representation. If
isSparse > 0, the input pattern is a list of non-zero indices and
isSparse is the length of the dense representation
:param isSparse: (int) If 0, the input pattern is a dense representation.
If isSparse > 0, the input pattern is a list of non-zero indices of
the active bits and isSparse is the number of total bits (n).
:param rowID: (int) UNKNOWN
@@ -659,7 +659,8 @@ def infer(self, inputPattern, computeScores=True, overCategories=True,
"""Finds the category that best matches the input pattern. Returns the
winning category index as well as a distribution over all categories.
:param inputPattern: (list) A pattern to be classified
:param inputPattern: (list or array) The pattern to be classified. This
must be a dense array.
:param computeScores: NO EFFECT

0 comments on commit ffd1457

Please sign in to comment.