Update KNNClassifier docstrings (#3535)

* KNNClassifier docstring updates for API docs * Clarifying getters for id list and keys
numenta · Apr 12, 2017 · b981848 · b981848
1 parent 3680b55
commit b981848
Show file tree

Hide file tree

Showing 4 changed files with 231 additions and 165 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -18,12 +18,9 @@ List of NuPIC packages and their documentation status:
 ```
 nupic
 ├── algorithms
-│   ├── CLAClassifier.py [TODO]
-│   ├── KNNClassifier.py [TODO]
+│   ├── KNNClassifier.py [OK]
 │   ├── anomaly.py [OK]
 │   ├── anomaly_likelihood.py [OK]
-│   ├── cla_classifier_diff.py [TODO]
-│   ├── cla_classifier_factory.py [TODO]
 │   ├── sdr_classifier.py [OK]
 │   └── sdr_classifier_factory.py [OK]
 ├── data

diff --git a/docs/source/api/algorithms/classifiers.rst b/docs/source/api/algorithms/classifiers.rst
@@ -12,3 +12,8 @@ SDR Classifier
 .. autoclass:: nupic.algorithms.sdr_classifier_factory.SDRClassifierFactory
    :members: create
 
+KNN Classifier
+++++++++++++++
+
+.. autoclass:: nupic.algorithms.KNNClassifier.KNNClassifier
+   :members: