Permalink
Browse files

Include example to make isSparse parameter easier to understand

  • Loading branch information...
scottpurdy committed Jan 11, 2018
1 parent ffd1457 commit 94e5f62e669dcbd55268c07b6aa30f391135ab4f
Showing with 7 additions and 3 deletions.
  1. +7 −3 src/nupic/algorithms/knn_classifier.py
@@ -422,9 +422,13 @@ 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 of
the active bits and isSparse is the number of total bits (n).
:param isSparse: (int) 0 if the input pattern is a dense representation.
When the input pattern is a list of non-zero indices, then isSparse
is the number of total bits (n). E.g. for the dense array
[0, 1, 1, 0, 0, 1], isSparse should be `0`. For the equivalent sparse
representation [1, 2, 5] (which specifies the indices of active bits),
isSparse should be `6`, which is the total number of bits in the input
space.
:param rowID: (int) UNKNOWN

0 comments on commit 94e5f62

Please sign in to comment.