Merge pull request #549 from htm-community/sp_rm_numActiveColumnsPerInhArea

SP: remove numActiveColumnsPerInhArea

Author: ctrl-z-9000-times

API_CHANGELOG.md

@@ -105,6 +105,9 @@ This is obsolete. Use getRegion('name') instead.
 
     We also renamed the namespaces from `namespace nupic` to `namespace htm`.
 
+* SpatialPooler: removed param `numActiveColumnsPerInhArea`, as replaced by `localAreaDensity` which has better properties
+  (constant sparsity). PR #TODO
+
 
 ## Python API Changes
 

CommonCompilerConfig.cmake

@@ -239,13 +239,22 @@ else()
 
 	#
 	# Set linker (ld)
-	# use ld.gold if available
+	# These linkers are tried for faster linking performance
+	# use ld.gold, or lld if available
 	#
-	execute_process(COMMAND ld.gold --version RESULT_VARIABLE EXIT_CODE)
-	if(EXIT_CODE EQUAL 0)
+	execute_process(COMMAND ld.gold --version RESULT_VARIABLE EXIT_CODE_GOLD)
+	if(EXIT_CODE_GOLD EQUAL 0)
 	  message("Using ld.gold as LINKER.")
 	  set(CMAKE_LINKER "ld.gold")
+	  set(optimization_flags_cc ${optimization_flags_cc} -fuse-ld=gold)
 	endif()
+	execute_process(COMMAND ld.lld --version RESULT_VARIABLE EXIT_CODE_LLD)
+	execute_process(COMMAND ld.lld-9 --version RESULT_VARIABLE EXIT_CODE_LLD9)
+        if(EXIT_CODE_LLD EQUAL 0 OR EXIT_CODE_LLD9 EQUAL 0)
+          message("Using ld.lld as LINKER.")
+          set(CMAKE_LINKER "ld.lld")
+          set(optimization_flags_cc ${optimization_flags_cc} -fuse-ld=lld)
+        endif()
 
 
 	#
@@ -344,11 +353,10 @@ else()
                 set(optimization_flags_cc ${optimization_flags_cc} -mtune=generic)
         endif()
         if(${CMAKE_CXX_COMPILER_ID} STREQUAL "GNU" AND NOT MINGW)
-                set(optimization_flags_cc ${optimization_flags_cc} -fuse-ld=gold)
                 # NOTE -flto must go together in both cc and ld flags; also, it's presently incompatible
                 # with the -g option in at least some GNU compilers (saw in `man gcc` on Ubuntu)
-                set(optimization_flags_cc ${optimization_flags_cc} -fuse-linker-plugin -flto-report -flto) #TODO fix LTO for clang
-                set(optimization_flags_lt ${optimization_flags_lt} -flto) #TODO LTO for clang too
+                set(optimization_flags_cc ${optimization_flags_cc} -fuse-linker-plugin -flto-report -flto -fno-fat-lto-objects) #TODO fix LTO for clang
+                set(optimization_flags_lt ${optimization_flags_lt} -flto -fno-fat-lto-objects) #TODO LTO for clang too
         endif()
 
 

bindings/py/cpp_src/bindings/algorithms/py_SpatialPooler.cpp

@@ -50,7 +50,6 @@ using namespace htm;
             , Real
             , bool
             , Real
-            , Int
             , UInt
             , Real
             , Real
@@ -112,22 +111,6 @@ Argument localAreaDensity The desired density of active columns within
         most N columns remain ON within a local inhibition area, where
         N = localAreaDensity * (total number of columns in inhibition
         area). 
-    If localAreaDensity is set to any value less than  0, 
-    output sparsity will be determined by the numActivePerInhArea.
-
-Argument numActiveColumnsPerInhArea An alternate way to control the sparsity of
-        active columns. When numActivePerInhArea > 0, the inhibition logic will insure that
-        at most 'numActivePerInhArea' columns remain ON within a local
-        inhibition area (the size of which is set by the internally
-        calculated inhibitionRadius). When using this method, as columns
-        learn and grow their effective receptive fields, the
-        inhibitionRadius will grow, and hence the net density of the
-        active columns will *decrease*. This is in contrast to the
-        localAreaDensity method, which keeps the density of active
-        columns the same regardless of the size of their receptive
-        fields.
-    If numActivePerInhArea is specified then 
-    localAreaDensity must be < 0, and vice versa.
 
 Argument stimulusThreshold This is a number specifying the minimum
         number of synapses that must be active in order for a column to
@@ -188,7 +171,6 @@ Argument wrapAround boolean value that determines whether or not inputs
             , py::arg("potentialPct") = 0.5
             , py::arg("globalInhibition") = false
             , py::arg("localAreaDensity") = 0.02f
-            , py::arg("numActiveColumnsPerInhArea") = -1
             , py::arg("stimulusThreshold") = 0
             , py::arg("synPermInactiveDec") = 0.01
             , py::arg("synPermActiveInc") = 0.1
@@ -212,8 +194,6 @@ Argument wrapAround boolean value that determines whether or not inputs
         py_SpatialPooler.def("getGlobalInhibition", &SpatialPooler::getGlobalInhibition);
         py_SpatialPooler.def("setGlobalInhibition", &SpatialPooler::setGlobalInhibition);
 
-        py_SpatialPooler.def("getNumActiveColumnsPerInhArea", &SpatialPooler::getNumActiveColumnsPerInhArea);
-        py_SpatialPooler.def("setNumActiveColumnsPerInhArea", &SpatialPooler::setNumActiveColumnsPerInhArea);
         py_SpatialPooler.def("getLocalAreaDensity", &SpatialPooler::getLocalAreaDensity);
         py_SpatialPooler.def("setLocalAreaDensity", &SpatialPooler::setLocalAreaDensity);
         py_SpatialPooler.def("getStimulusThreshold", &SpatialPooler::getStimulusThreshold);

src/examples/hotgym/HelloSPTP.cpp

@@ -172,23 +172,24 @@ Real64 BenchmarkHotgym::run(UInt EPOCHS, bool useSPlocal, bool useSPglobal, bool
 
       SDR goldSP({COLS});
       const SDR_sparse_t deterministicSP{
-        72, 308, 337, 1512, 1518, 1956, 1965, 1975, 1994, 2008
+        62, 72, 73, 82, 85, 102, 263, 277, 287, 303, 306, 308, 309, 322, 337, 339, 340, 352, 370, 493, 1094, 1095, 1114, 1115, 1120, 1463, 1512, 1518, 1647, 1651, 1691, 1694, 1729, 1745, 1746, 1760, 1770, 1774, 1775, 1781, 1797, 1798, 1803, 1804, 1805, 1812, 1827, 1828, 1831, 1832, 1858, 1859, 1860, 1861, 1862, 1875, 1878, 1880, 1881, 1898, 1918, 1923, 1929, 1931,1936, 1950, 1953, 1956, 1958, 1961, 1964, 1965, 1967, 1971, 1973, 1975, 1976, 1979, 1980, 1981, 1982, 1984, 1985, 1986, 1988, 1991, 1994, 1996, 1997, 1998, 1999, 2002, 2006, 2008, 2011, 2012, 2013, 2017, 2019, 2022, 2027, 2030
       };
       goldSP.setSparse(deterministicSP);
 
       SDR goldSPlocal({COLS});
       const SDR_sparse_t deterministicSPlocal{
-        12, 17, 36, 39, 62, 71, 72, 74, 75, 82, 83, 85, 93, 102, 131, 147, 171, 179, 186, 188, 189, 192, 194, 201, 260, 263, 277, 287, 298, 308, 319, 322, 323, 326, 334, 337, 340, 355, 365, 407, 422, 423, 425, 427, 429, 432, 434, 443, 445, 493, 494, 498, 502, 508, 513, 523, 534, 540, 542, 554, 559, 580, 585, 586, 610, 611, 612, 629, 631, 637, 644, 645, 646, 647, 691, 697, 698, 702, 703, 707, 709, 746, 749, 767, 806, 809, 810, 811, 825, 832, 833, 838, 839, 847, 889, 906, 920, 923, 928, 929, 931, 934, 935, 936, 952, 989, 1003, 1005, 1018, 1073, 1076, 1078, 1089, 1094, 1095, 1100, 1102, 1114, 1115, 1133, 1134, 1147, 1168, 1169, 1184, 1193, 1196, 1203, 1204, 1209, 1232, 1233, 1236, 1244, 1253, 1254, 1268, 1278, 1284, 1294, 1297, 1298, 1303, 1306, 1310, 1331, 1342, 1402, 1410, 1415, 1423, 1427, 1428, 1430, 1434, 1463, 1487, 1488, 1494, 1507, 1508, 1512, 1515, 1518, 1532, 1547, 1550, 1561, 1563, 1564, 1612, 1622, 1623, 1624, 1626, 1627, 1630, 1640, 1647, 1651, 1689, 1691, 1694, 1703, 1711, 1714, 1729, 1745, 1746, 1760, 1771, 1797, 1803, 1804, 1805, 1812, 1827, 1828, 1831, 1858, 1859, 1860, 1861, 1862, 1880, 1918, 1929, 1937, 1956, 1961, 1965, 1967, 1971, 1980, 1985, 1994, 2008, 2011, 2013
+        12, 13, 71, 72, 75, 78, 82, 85, 131, 171, 182, 186, 189, 194, 201, 263, 277, 287, 308, 319, 323, 337, 339, 365, 407, 423, 429, 432, 434, 445, 493, 494, 502, 508, 523, 542, 554, 559, 585, 586, 610, 611, 612, 644, 645, 647, 691, 698, 699, 701, 702, 707, 777, 809, 810, 811, 833, 839, 841, 920, 923, 928, 929, 935, 955, 1003, 1005, 1073, 1076, 1094, 1095, 1114,1115, 1133, 1134, 1184, 1203, 1214, 1232, 1233, 1244, 1253, 1268, 1278, 1291, 1294, 1306, 1309, 1331, 1402, 1410, 1427, 1434, 1442, 1463, 1508, 1512, 1514, 1515, 1518, 1561, 1564, 1590, 1623, 1626, 1630, 1647, 1651, 1691, 1694, 1729, 1745, 1746, 1760, 1797, 1804, 1805, 1812, 1827, 1858, 1860, 1861, 1862, 1918, 1956, 1961, 1965, 1971, 1975, 1994, 2012
       };
       goldSPlocal.setSparse(deterministicSPlocal);
 
       SDR goldTM({COLS});
       const SDR_sparse_t deterministicTM{
-        1965 //FIXME this is a really bad representation -> improve the params
+        51, 62, 72, 77, 102, 155, 287, 306, 337, 340, 370, 493, 542, 952, 1089, 1110, 1115, 1193, 1463, 1488, 1507, 1518, 1547, 1626, 1668, 1694, 1781, 1803, 1805, 1827, 1841, 1858,1859, 1860, 1861, 1862, 1878, 1881, 1915, 1918, 1923, 1929, 1933, 1939, 1941, 1953, 1955, 1956, 1958, 1961, 1965, 1968, 1975, 1976, 1980, 1981, 1985, 1986, 1987, 1991, 1992, 1994, 1997, 2002, 2006, 2008, 2012, 2013, 2040, 2042
       };
       goldTM.setSparse(deterministicTM);
 
-      const float goldAn = 1.0f;
+      const float goldAn = 0.745098f;
+      const float goldAnAvg = 0.408286f;
 
       if(EPOCHS == 5000) { //these hand-written values are only valid for EPOCHS = 5000 (default), but not for debug and custom runs. 
         NTA_CHECK(input == goldEnc) << "Deterministic output of Encoder failed!\n" << input << "should be:\n" << goldEnc;
@@ -197,7 +198,8 @@ Real64 BenchmarkHotgym::run(UInt EPOCHS, bool useSPlocal, bool useSPglobal, bool
         if(useTM) {       NTA_CHECK(outTM == goldTM) << "Deterministic output of TM failed!\n" << outTM << "should be:\n" << goldTM; }
         NTA_CHECK(static_cast<UInt>(an *10000.0f) == static_cast<UInt>(goldAn *10000.0f)) //compare to 4 decimal places
 		               << "Deterministic output of Anomaly failed! " << an << "should be: " << goldAn;
-	      NTA_CHECK(avgAnom10.getCurrentAvg() <= 0.8f) << "Deterministic average anom score failed:" << avgAnom10.getCurrentAvg();
+	NTA_CHECK(static_cast<UInt>(avgAnom10.getCurrentAvg() * 10000.0f) == static_cast<UInt>(goldAnAvg * 10000.0f)) 
+		<< "Deterministic average anom score failed:" << avgAnom10.getCurrentAvg() << " should be: " << goldAnAvg;
       }
 
       // check runtime speed

src/examples/mnist/MNIST_SP.cpp

@@ -84,7 +84,6 @@ void setup() {
     /* potentialPct */                0.1f, //we have only 10 classes, and << #columns. So we want to force each col to specialize. Cca 0.3 w "7" above, or very small (0.1) for "no topology". Cannot be too small due to internal checks. Speed++
     /* globalInhibition */            true, //Speed+++++++; SDR quality-- (global does have active nearby cols, which we want to avoid (local)); Results+-0
     /* localAreaDensity */            0.1f,  // % active bits
-    /* numActiveColumnsPerInhArea */  -1,
     /* stimulusThreshold */           6u,
     /* synPermInactiveDec */          0.002f, //FIXME inactive decay permanence plays NO role, investigate! (slightly better w/o it)
     /* synPermActiveInc */            0.14f, //takes upto 5x steps to get dis/connected

src/htm/algorithms/SpatialPooler.cpp

@@ -73,7 +73,7 @@ SpatialPooler::SpatialPooler() {
 SpatialPooler::SpatialPooler(
     const vector<UInt> inputDimensions, const vector<UInt> columnDimensions,
     UInt potentialRadius, Real potentialPct, bool globalInhibition,
-    Real localAreaDensity, Int numActiveColumnsPerInhArea,
+    Real localAreaDensity,
     UInt stimulusThreshold, Real synPermInactiveDec, Real synPermActiveInc,
     Real synPermConnected, Real minPctOverlapDutyCycles, UInt dutyCyclePeriod,
     Real boostStrength, Int seed, UInt spVerbosity, bool wrapAround)
@@ -88,7 +88,6 @@ SpatialPooler::SpatialPooler(
              potentialPct,
              globalInhibition,
              localAreaDensity,
-             numActiveColumnsPerInhArea,
              stimulusThreshold,
              synPermInactiveDec,
              synPermActiveInc,
@@ -133,22 +132,14 @@ void SpatialPooler::setGlobalInhibition(bool globalInhibition) {
   globalInhibition_ = globalInhibition;
 }
 
-Int SpatialPooler::getNumActiveColumnsPerInhArea() const {
-  return numActiveColumnsPerInhArea_;
-}
-
-void SpatialPooler::setNumActiveColumnsPerInhArea(UInt numActiveColumnsPerInhArea) {
-  NTA_CHECK(numActiveColumnsPerInhArea > 0u && numActiveColumnsPerInhArea <= numColumns_); //TODO this boundary could be smarter
-  numActiveColumnsPerInhArea_ = numActiveColumnsPerInhArea;
-  localAreaDensity_ = DISABLED;  //MUTEX with localAreaDensity
-}
 
 Real SpatialPooler::getLocalAreaDensity() const { return localAreaDensity_; }
 
-void SpatialPooler::setLocalAreaDensity(Real localAreaDensity) {
+void SpatialPooler::setLocalAreaDensity(const Real localAreaDensity) {
   NTA_CHECK(localAreaDensity > 0.0f && localAreaDensity <= 1.0f);
+  NTA_CHECK(static_cast<UInt>(localAreaDensity * getNumColumns()) > 0) 
+	  << "Too small density or sp.getNumColumns() -> would have zero active output columns.";
   localAreaDensity_ = localAreaDensity;
-  numActiveColumnsPerInhArea_ = DISABLED; //MUTEX with numActiveColumnsPerInhArea
 }
 
 UInt SpatialPooler::getStimulusThreshold() const { return stimulusThreshold_; }
@@ -374,12 +365,22 @@ const vector<Real> &SpatialPooler::getBoostedOverlaps() const {
 }
 
 void SpatialPooler::initialize(
-    const vector<UInt> inputDimensions, const vector<UInt> columnDimensions,
-    UInt potentialRadius, Real potentialPct, bool globalInhibition,
-    Real localAreaDensity, Int numActiveColumnsPerInhArea,
-    UInt stimulusThreshold, Real synPermInactiveDec, Real synPermActiveInc,
-    Real synPermConnected, Real minPctOverlapDutyCycles, UInt dutyCyclePeriod,
-    Real boostStrength, Int seed, UInt spVerbosity, bool wrapAround) {
+    const vector<UInt>& inputDimensions, 
+    const vector<UInt>& columnDimensions,
+    UInt potentialRadius, 
+    Real potentialPct, 
+    bool globalInhibition,
+    Real localAreaDensity,
+    UInt stimulusThreshold, 
+    Real synPermInactiveDec, 
+    Real synPermActiveInc,
+    Real synPermConnected, 
+    Real minPctOverlapDutyCycles, 
+    UInt dutyCyclePeriod,
+    Real boostStrength, 
+    Int seed, 
+    UInt spVerbosity, 
+    bool wrapAround) {
 
   numInputs_ = 1u;
   inputDimensions_.clear();
@@ -401,12 +402,8 @@ void SpatialPooler::initialize(
   // 1D input produces 1D output; 2D => 2D, etc. //TODO allow nD -> mD conversion
   NTA_CHECK(inputDimensions_.size() == columnDimensions_.size()); 
 
-  NTA_CHECK((numActiveColumnsPerInhArea > 0 && localAreaDensity < 0) ||
-            (localAreaDensity > 0 && localAreaDensity <= MAX_LOCALAREADENSITY
-	     && numActiveColumnsPerInhArea < 0)
-	   ) << numActiveColumnsPerInhArea << " vs " << localAreaDensity;
-  numActiveColumnsPerInhArea_ = numActiveColumnsPerInhArea;
-  localAreaDensity_ = localAreaDensity;
+  NTA_CHECK(localAreaDensity > 0 && localAreaDensity <= MAX_LOCALAREADENSITY);
+  setLocalAreaDensity(localAreaDensity); 
 
   rng_ = Random(seed);
 
@@ -596,7 +593,7 @@ void SpatialPooler::updateInhibitionRadius_() {
 
 void SpatialPooler::updateMinDutyCycles_() {
   if (globalInhibition_ ||
-      inhibitionRadius_ >
+      inhibitionRadius_ >=
           *max_element(columnDimensions_.begin(), columnDimensions_.end())) {
     updateMinDutyCyclesGlobal_();
   } else {
@@ -763,17 +760,7 @@ void applyBoosting_(const UInt i,
 
 
 void SpatialPooler::updateBoostFactorsGlobal_() {
-  Real targetDensity;
-  if (numActiveColumnsPerInhArea_ > 0) {
-    UInt inhibitionArea =
-        (UInt)(pow((Real)(2 * inhibitionRadius_ + 1), (Real)columnDimensions_.size()));
-    inhibitionArea = min(inhibitionArea, numColumns_);
-    NTA_ASSERT(inhibitionArea > 0);
-    targetDensity = ((Real)numActiveColumnsPerInhArea_) / inhibitionArea;
-    targetDensity = min(targetDensity, (Real)MAX_LOCALAREADENSITY);
-  } else {
-    targetDensity = localAreaDensity_;
-  }
+  const Real targetDensity = localAreaDensity_;
 
   for (UInt i = 0; i < numColumns_; ++i) { 
     applyBoosting_(i, targetDensity, activeDutyCycles_, boostStrength_, boostFactors_);
@@ -821,14 +808,7 @@ void SpatialPooler::calculateOverlap_(const SDR &input,
 
 void SpatialPooler::inhibitColumns_(const vector<Real> &overlaps,
                                     vector<CellIdx> &activeColumns) const {
-  Real density = localAreaDensity_;
-  if (numActiveColumnsPerInhArea_ > 0) {
-    UInt inhibitionArea =
-      (UInt)(pow((Real)(2 * inhibitionRadius_ + 1), (Real)columnDimensions_.size()));
-    inhibitionArea = min(inhibitionArea, numColumns_);
-    density = ((Real)numActiveColumnsPerInhArea_) / inhibitionArea;
-    density = min(density, (Real)MAX_LOCALAREADENSITY);
-  }
+  const Real density = localAreaDensity_;
 
   if (globalInhibition_ ||
       inhibitionRadius_ >
@@ -899,7 +879,8 @@ void SpatialPooler::inhibitColumnsLocal_(const vector<Real> &overlaps,
 
 
       if (wrapAround_) {
-        for(auto neighbor: WrappingNeighborhood(column, inhibitionRadius_,columnDimensions_)) {
+        for(auto neighbor: WrappingNeighborhood(column, inhibitionRadius_,columnDimensions_)) { //TODO if we don't change inh radius (changes only every isUpdateRound()),
+		// then these values can be cached -> faster local inh
           if (neighbor == column) {
             continue;
           }
@@ -957,7 +938,6 @@ void SpatialPooler::printParameters(std::ostream& out) const {
       << "iterationLearnNum           = " << getIterationLearnNum() << std::endl
       << "numInputs                   = " << getNumInputs() << std::endl
       << "numColumns                  = " << getNumColumns() << std::endl
-      << "numActiveColumnsPerInhArea  = " << getNumActiveColumnsPerInhArea()
       << std::endl
       << "potentialPct                = " << getPotentialPct() << std::endl
       << "globalInhibition            = " << getGlobalInhibition() << std::endl
@@ -1008,7 +988,6 @@ bool SpatialPooler::operator==(const SpatialPooler& o) const{
   if (potentialPct_ != o.potentialPct_) return false;
   if (initConnectedPct_ != o.initConnectedPct_) return false;
   if (globalInhibition_ != o.globalInhibition_) return false;
-  if (numActiveColumnsPerInhArea_ != o.numActiveColumnsPerInhArea_) return false;
   if (localAreaDensity_ != o.localAreaDensity_) return false;
   if (stimulusThreshold_ != o.stimulusThreshold_) return false;
   if (inhibitionRadius_ != o.inhibitionRadius_) return false;