diff --git a/docs/README.md b/docs/README.md index 569d0b5f7c..2212dc6939 100644 --- a/docs/README.md +++ b/docs/README.md @@ -156,23 +156,23 @@ nupic │   ├── stats.py [TODO] │   └── topology.py [TODO] ├── regions -│   ├── AnomalyLikelihoodRegion.py [OK] -│   ├── AnomalyRegion.py [OK] -│   ├── CLAClassifierRegion.py [TODO] -│   ├── KNNAnomalyClassifierRegion.py [TODO] -│   ├── KNNClassifierRegion.py [TODO] -│   ├── PluggableEncoderSensor.py [TODO] -│   ├── RecordSensor.py [TODO] -│   ├── RecordSensorFilters +│   ├── anomaly_likelihood_region.py [OK] +│   ├── anomaly_region.py [OK] +│   ├── cla_classifier_region.py [TODO] +│   ├── knn_anomaly_classifier_region.py [TODO] +│   ├── knn_classifier_region.py [TODO] +│   ├── pluggable_encoder_sensor.py [TODO] +│   ├── record_sensor.py [TODO] +│   ├── record_sensor_filters │   │   ├── add_noise.py [TODO] │   │   └── modify_fields.py [TODO] -│   ├── SDRClassifierRegion.py [TODO] -│   ├── SPRegion.py [TODO] -│   ├── SVMClassifierNode.py [TODO] -│   ├── Spec.py [TODO] -│   ├── TMRegion.py [TODO] -│   ├── TestRegion.py [TODO] -│   └─── UnimportableNode.py [TODO] +│   ├── sdr_classifier_region.py [TODO] +│   ├── sp_region.py [TODO] +│   ├── svm_classifier_node.py [TODO] +│   ├── spec.py [TODO] +│   ├── tm_region.py [TODO] +│   ├── test_region.py [TODO] +│   └─── unimportable_node.py [TODO] ├── serializable.py [TODO] ├── simple_server.py [TODO] ├── support diff --git a/docs/source/api/network/regions.rst b/docs/source/api/network/regions.rst index 64876e3928..5772d5c4f7 100644 --- a/docs/source/api/network/regions.rst +++ b/docs/source/api/network/regions.rst @@ -12,42 +12,42 @@ PyRegion AnomalyRegion ^^^^^^^^^^^^^ -.. autoclass:: nupic.regions.AnomalyRegion.AnomalyRegion +.. autoclass:: nupic.regions.anomaly_region.AnomalyRegion :members: :show-inheritance: SPRegion ^^^^^^^^^^^^^ -.. autoclass:: nupic.regions.SPRegion.SPRegion +.. autoclass:: nupic.regions.sp_region.SPRegion :members: :show-inheritance: TMRegion ^^^^^^^^^^^^^ -.. autoclass:: nupic.regions.TMRegion.TMRegion +.. autoclass:: nupic.regions.tm_region.TMRegion :members: :show-inheritance: AnomalyLikelihoodRegion ^^^^^^^^^^^^^^^^^^^^^^^ -.. autoclass:: nupic.regions.AnomalyLikelihoodRegion.AnomalyLikelihoodRegion +.. autoclass:: nupic.regions.anomaly_likelihood_region.AnomalyLikelihoodRegion :members: :show-inheritance: CLAClassifierRegion ^^^^^^^^^^^^^^^^^^^ -.. autoclass:: nupic.regions.CLAClassifierRegion.CLAClassifierRegion +.. autoclass:: nupic.regions.cla_classifier_region.CLAClassifierRegion :members: :show-inheritance: KNNAnomalyClassifierRegion ^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. autoclass:: nupic.regions.KNNAnomalyClassifierRegion.KNNAnomalyClassifierRegion +.. autoclass:: nupic.regions.knn_anomaly_classifier_region.KNNAnomalyClassifierRegion :members: :show-inheritance: @@ -55,7 +55,7 @@ KNNAnomalyClassifierRegion KNNClassifierRegion ^^^^^^^^^^^^^^^^^^^ -.. autoclass:: nupic.regions.KNNClassifierRegion.KNNClassifierRegion +.. autoclass:: nupic.regions.knn_classifier_region.KNNClassifierRegion :members: :show-inheritance: @@ -63,6 +63,6 @@ KNNClassifierRegion SDRClassifierRegion ^^^^^^^^^^^^^^^^^^^ -.. autoclass:: nupic.regions.SDRClassifierRegion.SDRClassifierRegion +.. autoclass:: nupic.regions.sdr_classifier_region.SDRClassifierRegion :members: :show-inheritance: diff --git a/docs/source/api/network/sensors.rst b/docs/source/api/network/sensors.rst index 471dccab3c..7cd2f18217 100644 --- a/docs/source/api/network/sensors.rst +++ b/docs/source/api/network/sensors.rst @@ -4,7 +4,7 @@ Sensors PluggableEncoderSensor ^^^^^^^^^^^^^^^^^^^^^^ -.. autoclass:: nupic.regions.PluggableEncoderSensor.PluggableEncoderSensor +.. autoclass:: nupic.regions.pluggable_encoder_sensor.PluggableEncoderSensor :members: :show-inheritance: diff --git a/docs/source/quick-start/network.rst b/docs/source/quick-start/network.rst index b444cc2a12..953d22b79d 100644 --- a/docs/source/quick-start/network.rst +++ b/docs/source/quick-start/network.rst @@ -194,7 +194,7 @@ classifier region. In our case, we are interested in: probabilities = classifierRegion.getOutputData("probabilities") -Refer to the documentation of :class:`~nupic.regions.SDRClassifierRegion.SDRClassifierRegion` for +Refer to the documentation of :class:`~nupic.regions.sdr_classifier_region.SDRClassifierRegion` for more information about output values and their structure. We'll use the helper function below to extract predictions more easily from diff --git a/examples/network/network_api_demo.py b/examples/network/network_api_demo.py index 3972e9ac6e..313caf44f0 100755 --- a/examples/network/network_api_demo.py +++ b/examples/network/network_api_demo.py @@ -29,8 +29,8 @@ from nupic.data.file_record_stream import FileRecordStream from nupic.engine import Network from nupic.encoders import MultiEncoder, ScalarEncoder, DateEncoder -from nupic.regions.SPRegion import SPRegion -from nupic.regions.TMRegion import TMRegion +from nupic.regions.sp_region import SPRegion +from nupic.regions.tm_region import TMRegion _VERBOSITY = 0 # how chatty the demo should be _SEED = 1956 # the random seed used throughout diff --git a/examples/prediction/experiments/dutyCycle/base/description.py b/examples/prediction/experiments/dutyCycle/base/description.py index 6b7dc2dbe8..cd86bff031 100644 --- a/examples/prediction/experiments/dutyCycle/base/description.py +++ b/examples/prediction/experiments/dutyCycle/base/description.py @@ -35,7 +35,7 @@ displaySPCoincidences, setAttribute, sensorOpen) -from nupic.regions.RecordSensorFilters.modify_fields import ModifyFields +from nupic.regions.record_sensor_filters.modify_fields import ModifyFields diff --git a/src/nupic/data/stats.py b/src/nupic/data/stats.py index b1f42ae5ed..952c9dd598 100644 --- a/src/nupic/data/stats.py +++ b/src/nupic/data/stats.py @@ -24,7 +24,7 @@ from pkg_resources import resource_filename -from nupic.regions.RecordSensor import RecordSensor +from nupic.regions.record_sensor import RecordSensor from nupic.data.file_record_stream import FileRecordStream diff --git a/src/nupic/engine/__init__.py b/src/nupic/engine/__init__.py index ffe49e54c6..2020a9cbb4 100644 --- a/src/nupic/engine/__init__.py +++ b/src/nupic/engine/__init__.py @@ -43,19 +43,19 @@ pyRegions = ( ("nupic.bindings.regions.TestNode", "TestNode"), ("nupic.regions.AnomalyLikelihoodRegion", "AnomalyLikelihoodRegion"), - ("nupic.regions.AnomalyRegion", "AnomalyRegion"), - ("nupic.regions.CLAClassifierRegion", "CLAClassifierRegion"), - ("nupic.regions.KNNAnomalyClassifierRegion", "KNNAnomalyClassifierRegion"), - ("nupic.regions.KNNClassifierRegion", "KNNClassifierRegion"), - ("nupic.regions.PluggableEncoderSensor", "PluggableEncoderSensor"), + ("nupic.regions.anomaly_region", "AnomalyRegion"), + ("nupic.regions.cla_classifier_region", "CLAClassifierRegion"), + ("nupic.regions.knn_anomaly_classifier_region", "KNNAnomalyClassifierRegion"), + ("nupic.regions.knn_classifier_region", "KNNClassifierRegion"), + ("nupic.regions.pluggable_encoder_sensor", "PluggableEncoderSensor"), ("nupic.regions.PyRegion", "PyRegion"), - ("nupic.regions.RecordSensor", "RecordSensor"), - ("nupic.regions.SDRClassifierRegion", "SDRClassifierRegion"), - ("nupic.regions.SPRegion", "SPRegion"), - ("nupic.regions.SVMClassifierNode", "SVMClassifierNode"), - ("nupic.regions.TestRegion", "TestRegion"), - ("nupic.regions.TMRegion", "TMRegion"), - ("nupic.regions.UnimportableNode", "UnimportableNode"), + ("nupic.regions.record_sensor", "RecordSensor"), + ("nupic.regions.sdr_classifier_region", "SDRClassifierRegion"), + ("nupic.regions.sp_region", "SPRegion"), + ("nupic.regions.svm_classifier_node", "SVMClassifierNode"), + ("nupic.regions.test_region", "TestRegion"), + ("nupic.regions.tm_region", "TMRegion"), + ("nupic.regions.unimportable_node", "UnimportableNode"), ) registeredRegions = False @@ -727,7 +727,7 @@ def save(self, *args, **kwargs): def getRegionsByType(self, regionClass): """ Gets all region instances of a given class - (for example, nupic.regions.SPRegion.SPRegion). + (for example, nupic.regions.sp_region.SPRegion). """ regions = [] diff --git a/src/nupic/regions/AnomalyRegion.py b/src/nupic/regions/anomaly_region.py similarity index 100% rename from src/nupic/regions/AnomalyRegion.py rename to src/nupic/regions/anomaly_region.py diff --git a/src/nupic/regions/CLAClassifierRegion.py b/src/nupic/regions/cla_classifier_region.py similarity index 100% rename from src/nupic/regions/CLAClassifierRegion.py rename to src/nupic/regions/cla_classifier_region.py diff --git a/src/nupic/regions/KNNAnomalyClassifierRegion.py b/src/nupic/regions/knn_anomaly_classifier_region.py similarity index 99% rename from src/nupic/regions/KNNAnomalyClassifierRegion.py rename to src/nupic/regions/knn_anomaly_classifier_region.py index 9ce73618b7..a9c3e3c709 100644 --- a/src/nupic/regions/KNNAnomalyClassifierRegion.py +++ b/src/nupic/regions/knn_anomaly_classifier_region.py @@ -29,7 +29,7 @@ from nupic.algorithms import anomaly from nupic.bindings.regions.PyRegion import PyRegion -from KNNClassifierRegion import KNNClassifierRegion +from knn_classifier_region import KNNClassifierRegion from nupic.bindings.math import Random from nupic.frameworks.opf.exceptions import (HTMPredictionModelInvalidRangeError, HTMPredictionModelInvalidArgument) diff --git a/src/nupic/regions/KNNClassifierRegion.py b/src/nupic/regions/knn_classifier_region.py similarity index 100% rename from src/nupic/regions/KNNClassifierRegion.py rename to src/nupic/regions/knn_classifier_region.py diff --git a/src/nupic/regions/PluggableEncoderSensor.py b/src/nupic/regions/pluggable_encoder_sensor.py similarity index 100% rename from src/nupic/regions/PluggableEncoderSensor.py rename to src/nupic/regions/pluggable_encoder_sensor.py diff --git a/src/nupic/regions/RecordSensor.py b/src/nupic/regions/record_sensor.py similarity index 100% rename from src/nupic/regions/RecordSensor.py rename to src/nupic/regions/record_sensor.py diff --git a/src/nupic/regions/RecordSensorFilters/__init__.py b/src/nupic/regions/record_sensor_filters/__init__.py similarity index 100% rename from src/nupic/regions/RecordSensorFilters/__init__.py rename to src/nupic/regions/record_sensor_filters/__init__.py diff --git a/src/nupic/regions/RecordSensorFilters/add_noise.py b/src/nupic/regions/record_sensor_filters/add_noise.py similarity index 100% rename from src/nupic/regions/RecordSensorFilters/add_noise.py rename to src/nupic/regions/record_sensor_filters/add_noise.py diff --git a/src/nupic/regions/RecordSensorFilters/modify_fields.py b/src/nupic/regions/record_sensor_filters/modify_fields.py similarity index 100% rename from src/nupic/regions/RecordSensorFilters/modify_fields.py rename to src/nupic/regions/record_sensor_filters/modify_fields.py diff --git a/src/nupic/regions/SDRClassifierRegion.py b/src/nupic/regions/sdr_classifier_region.py similarity index 100% rename from src/nupic/regions/SDRClassifierRegion.py rename to src/nupic/regions/sdr_classifier_region.py diff --git a/src/nupic/regions/SPRegion.py b/src/nupic/regions/sp_region.py similarity index 100% rename from src/nupic/regions/SPRegion.py rename to src/nupic/regions/sp_region.py diff --git a/src/nupic/regions/Spec.py b/src/nupic/regions/spec.py similarity index 100% rename from src/nupic/regions/Spec.py rename to src/nupic/regions/spec.py diff --git a/src/nupic/regions/SVMClassifierNode.py b/src/nupic/regions/svm_classifier_node.py similarity index 100% rename from src/nupic/regions/SVMClassifierNode.py rename to src/nupic/regions/svm_classifier_node.py diff --git a/src/nupic/regions/TestRegion.py b/src/nupic/regions/test_region.py similarity index 100% rename from src/nupic/regions/TestRegion.py rename to src/nupic/regions/test_region.py diff --git a/src/nupic/regions/TMRegion.py b/src/nupic/regions/tm_region.py similarity index 100% rename from src/nupic/regions/TMRegion.py rename to src/nupic/regions/tm_region.py diff --git a/src/nupic/regions/UnimportableNode.py b/src/nupic/regions/unimportable_node.py similarity index 100% rename from src/nupic/regions/UnimportableNode.py rename to src/nupic/regions/unimportable_node.py diff --git a/tests/integration/nupic/engine/network_checkpoint_test.py b/tests/integration/nupic/engine/network_checkpoint_test.py index 86a342f84e..16602894d2 100755 --- a/tests/integration/nupic/engine/network_checkpoint_test.py +++ b/tests/integration/nupic/engine/network_checkpoint_test.py @@ -22,8 +22,8 @@ import unittest import numpy -from nupic.regions.SPRegion import SPRegion -from nupic.regions.RecordSensor import RecordSensor +from nupic.regions.sp_region import SPRegion +from nupic.regions.record_sensor import RecordSensor from network_creation_common import createAndRunNetwork diff --git a/tests/integration/nupic/engine/network_creation_common.py b/tests/integration/nupic/engine/network_creation_common.py index ee8d9cb20f..fa24b6d4fd 100755 --- a/tests/integration/nupic/engine/network_creation_common.py +++ b/tests/integration/nupic/engine/network_creation_common.py @@ -29,9 +29,9 @@ from nupic.data.file_record_stream import FileRecordStream from nupic.engine import Network from nupic.encoders import MultiEncoder, ScalarEncoder, DateEncoder -from nupic.regions.RecordSensor import RecordSensor -from nupic.regions.SPRegion import SPRegion -from nupic.regions.TMRegion import TMRegion +from nupic.regions.record_sensor import RecordSensor +from nupic.regions.sp_region import SPRegion +from nupic.regions.tm_region import TMRegion try: import capnp diff --git a/tests/integration/nupic/engine/temporal_memory_compatibility_test.py b/tests/integration/nupic/engine/temporal_memory_compatibility_test.py index 43f7cd3bf2..742d7ad2f4 100755 --- a/tests/integration/nupic/engine/temporal_memory_compatibility_test.py +++ b/tests/integration/nupic/engine/temporal_memory_compatibility_test.py @@ -23,7 +23,7 @@ import unittest import numpy -from nupic.regions.TMRegion import TMRegion +from nupic.regions.tm_region import TMRegion from network_creation_common import createAndRunNetwork diff --git a/tests/integration/nupic/opf/opf_region_test.py b/tests/integration/nupic/opf/opf_region_test.py index ffee694d80..653ae7d8b3 100755 --- a/tests/integration/nupic/opf/opf_region_test.py +++ b/tests/integration/nupic/opf/opf_region_test.py @@ -53,8 +53,8 @@ from nupic.data.file_record_stream import FileRecordStream from nupic.encoders import MultiEncoder from nupic.engine import Network -from nupic.regions.SPRegion import SPRegion -from nupic.regions.TMRegion import TMRegion +from nupic.regions.sp_region import SPRegion +from nupic.regions.tm_region import TMRegion from nupic.support.unittesthelpers.testcasebase import TestCaseBase _VERBOSITY = 0 # how chatty the unit tests should be diff --git a/tests/unit/nupic/data/filters_test.py b/tests/unit/nupic/data/filters_test.py index d0d40dd1ad..01ca956589 100755 --- a/tests/unit/nupic/data/filters_test.py +++ b/tests/unit/nupic/data/filters_test.py @@ -30,7 +30,7 @@ import unittest2 as unittest from pkg_resources import resource_filename -from nupic.regions.RecordSensor import RecordSensor +from nupic.regions.record_sensor import RecordSensor from nupic.data.file_record_stream import FileRecordStream from nupic.encoders import MultiEncoder from nupic.data.filters import DeltaFilter diff --git a/tests/unit/nupic/engine/network_test.py b/tests/unit/nupic/engine/network_test.py index b4b5b78ef4..6dde6575bd 100755 --- a/tests/unit/nupic/engine/network_test.py +++ b/tests/unit/nupic/engine/network_test.py @@ -25,7 +25,7 @@ from nupic import engine from nupic.bindings.regions.TestNode import TestNode -from nupic.regions.SPRegion import SPRegion +from nupic.regions.sp_region import SPRegion @@ -45,8 +45,8 @@ def testErrorHandling(self): orig_import = __import__ def import_mock(name, *args): - if name == "nupic.regions.UnimportableNode": - raise SyntaxError("invalid syntax (UnimportableNode.py, line 5)") + if name == "nupic.regions.unimportable_node": + raise SyntaxError("invalid syntax (unimportable_node.py, line 5)") return orig_import(name, *args) @@ -55,7 +55,7 @@ def import_mock(name, *args): with self.assertRaises(Exception) as cm: n.addRegion('r', 'py.UnimportableNode', '') - self.assertEqual(cm.exception.message, "invalid syntax (UnimportableNode.py, line 5)") + self.assertEqual(cm.exception.message, "invalid syntax (unimportable_node.py, line 5)") # Test failure in the __init__() method with self.assertRaises(Exception) as cm: diff --git a/tests/unit/nupic/regions/anomaly_region_test.py b/tests/unit/nupic/regions/anomaly_region_test.py index d6b51c10ad..eb1ff9fd43 100644 --- a/tests/unit/nupic/regions/anomaly_region_test.py +++ b/tests/unit/nupic/regions/anomaly_region_test.py @@ -24,7 +24,7 @@ import numpy -from nupic.regions.AnomalyRegion import AnomalyRegion +from nupic.regions.anomaly_region import AnomalyRegion try: import capnp diff --git a/tests/unit/nupic/regions/knn_anomaly_classifier_region_test.py b/tests/unit/nupic/regions/knn_anomaly_classifier_region_test.py index 8221b9298a..0c5574e4ac 100755 --- a/tests/unit/nupic/regions/knn_anomaly_classifier_region_test.py +++ b/tests/unit/nupic/regions/knn_anomaly_classifier_region_test.py @@ -32,7 +32,7 @@ TestOptionParser) from nupic.frameworks.opf.opf_utils import InferenceType -from nupic.regions.KNNAnomalyClassifierRegion import ( +from nupic.regions.knn_anomaly_classifier_region import ( KNNAnomalyClassifierRegion, _CLAClassificationRecord) diff --git a/tests/unit/nupic/regions/regions_spec_test.py b/tests/unit/nupic/regions/regions_spec_test.py index a76cdc4795..a839b9c6a8 100755 --- a/tests/unit/nupic/regions/regions_spec_test.py +++ b/tests/unit/nupic/regions/regions_spec_test.py @@ -21,7 +21,7 @@ import unittest2 as unittest -from nupic.regions.Spec import (Spec, +from nupic.regions.spec import (Spec, InputSpec, OutputSpec, ParameterSpec,