SDRClassifier docs, default config docs

numenta · Apr 12, 2017 · 3680b55 · 3680b55
1 parent 6eae371
commit 3680b55
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 10 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -24,8 +24,8 @@ nupic
 │   ├── anomaly_likelihood.py [OK]
 │   ├── cla_classifier_diff.py [TODO]
 │   ├── cla_classifier_factory.py [TODO]
-│   ├── sdr_classifier.py [TODO]
-│   └── sdr_classifier_factory.py [TODO]
+│   ├── sdr_classifier.py [OK]
+│   └── sdr_classifier_factory.py [OK]
 ├── data
 │   ├── CategoryFilter.py [TODO]
 │   ├── aggregator.py [TODO]

diff --git a/docs/source/api/algorithms/classifiers.rst b/docs/source/api/algorithms/classifiers.rst
@@ -4,13 +4,11 @@ Classifiers
 SDR Classifier
 ++++++++++++++
 
+.. automodule:: nupic.algorithms.sdr_classifier
+
 .. autoclass:: nupic.algorithms.sdr_classifier.SDRClassifier
    :members:
 
-CLA Classifier
-++++++++++++++
-
-Outdated. Use SDR Classifier.
+.. autoclass:: nupic.algorithms.sdr_classifier_factory.SDRClassifierFactory
+   :members: create
 
-.. autoclass:: nupic.algorithms.CLAClassifier.CLAClassifier
-   :members:
diff --git a/docs/source/api/algorithms/default-config.rst b/docs/source/api/algorithms/default-config.rst
@@ -0,0 +1,8 @@
+Default NuPIC Configuration
+===========================
+
+Default values for some NuPIC components are stored in
+``src/nupic/support/nupic-default.xml``.
+
+.. literalinclude:: ../../../../src/nupic/support/nupic-default.xml
+   :language: xml
diff --git a/src/nupic/algorithms/sdr_classifier_factory.py b/src/nupic/algorithms/sdr_classifier_factory.py
@@ -39,7 +39,7 @@ def create(*args, **kwargs):
     the "implementation" keyword argument.
 
     The SDRClassifierFactory uses the implementation as specified in
-     src/nupic/support/nupic-default.xml
+     `Default NuPIC Configuration <default-config.html>`_.
     """
     impl = kwargs.pop('implementation', None)
     if impl is None:
@@ -56,7 +56,7 @@ def create(*args, **kwargs):
   @staticmethod
   def read(proto):
     """
-    proto: SDRClassifierRegionProto capnproto object
+    :param proto: SDRClassifierRegionProto capnproto object
     """
     impl = proto.implementation
     if impl == 'py':