MNIST example

external/CMakeLists.txt

@@ -102,4 +102,6 @@ if(match)
 endif()
 
 
-
+#################
+# mnist data
+include(mnist_data.cmake)

external/bootstrap.cmake

@@ -97,6 +97,7 @@ set(EXTERNAL_INCLUDES
 	${yaml-cpp_INCLUDE_DIRS}
 	${Boost_INCLUDE_DIRS}
 	${eigen_INCLUDE_DIRS}
+	${mnist_INCLUDE_DIRS}
 	${REPOSITORY_DIR}/external/common/include
 )
 

external/mnist_data.cmake

@@ -0,0 +1,49 @@
+# -----------------------------------------------------------------------------
+# Numenta Platform for Intelligent Computing (NuPIC)
+# Copyright (C) 2016, Numenta, Inc.  Unless you have purchased from
+# Numenta, Inc. a separate commercial license for this software code, the
+# following terms and conditions apply:
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+# See the GNU Affero Public License for more details.
+#
+# You should have received a copy of the GNU Affero Public License
+# along with this program.  If not, see http://www.gnu.org/licenses.
+#
+# http://numenta.org/licenses/
+# -----------------------------------------------------------------------------
+
+# Fetch MNIST dataset from online archive
+#
+if(EXISTS ${REPOSITORY_DIR}/build/ThirdParty/share/mnist.zip)
+    set(URL ${REPOSITORY_DIR}/build/ThirdParty/share/mnist.zip)
+else()
+    set(URL "https://github.com/wichtounet/mnist/archive/master.zip")
+    set(HASH "855cb8c60f84e2fc6bea08c4a9df9a3cbd6230bddc55def635a938665c512ffc")
+endif()
+
+message(STATUS "obtaining MNIST data")
+include(DownloadProject/DownloadProject.cmake)
+download_project(PROJ mnist
+	PREFIX ${EP_BASE}/mnist_data
+	URL    ${URL}
+	URL_HASH SHA256=${HASH}
+    UPDATE_DISCONNECTED 1
+#    QUIET
+   )	
+
+# No build. This is a data only package
+# But we do need to run its CMakeLists.txt to unpack the files.
+
+add_subdirectory(${mnist_SOURCE_DIR}/example/ ${mnist_BINARY_DIR})
+FILE(APPEND "${EXPORT_FILE_NAME}" "mnist_INCLUDE_DIRS@@@${mnist_SOURCE_DIR}/include\n")
+FILE(APPEND "${EXPORT_FILE_NAME}" "mnist_SOURCE_DIR@@@${mnist_SOURCE_DIR}\n")
+
+# includes will be found with  #include <mnist/mnist_reader_less.hpp>
+# data will be found in folder ${mnist_SOURCE_DIR}

src/CMakeLists.txt

@@ -232,9 +232,10 @@ set(utils_files
 )
 
 set(examples_files
-    examples/hotgym/Hotgym.cpp
+	#    examples/hotgym/Hotgym.cpp # contains conflicting main()
     examples/hotgym/HelloSPTP.cpp
     examples/hotgym/HelloSPTP.hpp
+    #    examples/mnist/MNIST_SP.cpp
 )
 
 #set up file tabs in Visual Studio
@@ -270,7 +271,7 @@ add_library(${src_objlib} OBJECT
     ${regions_files} 
     ${types_files} 
     ${utils_files}
-    ${examples_files} 
+    ${examples_files}
 )
 # shared libraries need PIC
 target_compile_options( ${src_objlib} PUBLIC ${INTERNAL_CXX_FLAGS})
@@ -312,7 +313,7 @@ merge_static_libraries(${core_library} "${src_combined_nupiccore_source_archives
 #
 # For Linux, OSx; the .so file will contain all symbols.
 #
-if(MSVC)
+if(true)
 	# NOTE: this disables shared lib for Windows.
 else()
     # First extract static libraries into an Object Library
@@ -357,14 +358,9 @@ add_subdirectory(test)
 #
 ## Setup benchmark_hotgym
 #
-source_group("examples" FILES 
-    examples/hotgym/Hotgym.cpp 
-    examples/hotgym/HelloSPTP.hpp
-    )
-
 set(src_executable_hotgym benchmark_hotgym)
-add_executable(${src_executable_hotgym} examples/hotgym/Hotgym.cpp examples/hotgym/HelloSPTP.hpp)
-if(MSVC)
+add_executable(${src_executable_hotgym} examples/hotgym/Hotgym.cpp examples/hotgym/HelloSPTP.hpp examples/hotgym/HelloSPTP.cpp)
+if(true)
   # for Windows, link with the static library
   target_link_libraries(${src_executable_hotgym} 
     ${core_library}
@@ -390,21 +386,46 @@ add_custom_target(hotgym
           VERBATIM)
 
 
+#########################################################
+## MNIST Spatial Pooler Example
+#
+set(src_executable_mnistsp mnist_sp)
+add_executable(${src_executable_mnistsp} examples/mnist/MNIST_SP.cpp)
+target_link_libraries(${src_executable_mnistsp} 
+        ${core_library}
+        ${COMMON_OS_LIBS}
+	    )
+  target_compile_options(${src_executable_mnistsp} PUBLIC ${INTERNAL_CXX_FLAGS})
+  target_compile_definitions(${src_executable_mnistsp} PRIVATE ${COMMON_COMPILER_DEFINITIONS})
+  # Pass MNIST data directory to main.cpp
+  target_compile_definitions(${src_executable_mnistsp} PRIVATE MNIST_DATA_LOCATION=${mnist_SOURCE_DIR})
+  target_include_directories(${src_executable_mnistsp} PRIVATE 
+        ${CORE_LIB_INCLUDES} 
+        ${EXTERNAL_INCLUDES}
+        )
+add_custom_target(mnist
+                  COMMAND ${src_executable_mnistsp}
+                  DEPENDS ${src_executable_mnistsp}
+                  COMMENT "Executing ${src_executable_mnistsp}"
+                  VERBATIM)
+
+
 ############ INSTALL ######################################
 #
 # Install targets into CMAKE_INSTALL_PREFIX
 #
 install(TARGETS
         ${core_library}
         ${src_executable_hotgym}
-        RUNTIME DESTINATION bin
+        ${src_executable_mnistsp}
+	RUNTIME DESTINATION bin
         LIBRARY DESTINATION lib
         ARCHIVE DESTINATION lib)
 
-if(MSVC)
+if(true)
 else()	
   install(TARGETS
-	    ${src_lib_shared}
+        ${src_lib_shared}
         RUNTIME DESTINATION bin
         LIBRARY DESTINATION lib
         ARCHIVE DESTINATION lib)
@@ -424,7 +445,6 @@ install(DIRECTORY "${REPOSITORY_DIR}/external/common/include/"
 	  MESSAGE_NEVER
 	  DESTINATION include)
 
-
 
 #
 # `make package` results in

src/examples/hotgym/HelloSPTP.cpp

@@ -56,6 +56,7 @@ using TM =     nupic::algorithms::temporal_memory::TemporalMemory;
 using nupic::algorithms::anomaly::Anomaly;
 using nupic::algorithms::anomaly::AnomalyMode;
 
+
 // work-load
 Real64 BenchmarkHotgym::run(UInt EPOCHS, bool useSPlocal, bool useSPglobal, bool useTP, bool useBackTM, bool useTM, const UInt COLS, const UInt DIM_INPUT, const UInt CELLS) {
 #ifndef NDEBUG

src/examples/mnist/MNIST_SP.cpp

@@ -0,0 +1,187 @@
+/* ---------------------------------------------------------------------
+ * Copyright (C) 2018, David McDougall.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Affero Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero Public License
+ * along with this program.  If not, see http://www.gnu.org/licenses.
+ * ----------------------------------------------------------------------
+ */
+
+/**
+ * Solving the MNIST dataset with Spatial Pooler.
+ *
+ * This consists of a simple black & white image encoder, a spatial pool, and an
+ * SDR classifier.  The task is to recognise images of hand written numbers 0-9.
+ * This should score at least 95%.
+ */
+
+#include <algorithm>
+#include <cstdint> //uint8_t
+#include <iostream>
+#include <vector>
+
+#include <nupic/algorithms/SpatialPooler.hpp>
+#include <nupic/algorithms/SDRClassifier.hpp>
+#include <nupic/algorithms/ClassifierResult.hpp>
+#include <nupic/utils/SdrMetrics.hpp>
+
+#include <mnist/mnist_reader.hpp> // MNIST data itself + read methods, namespace mnist::
+
+namespace examples {
+
+using namespace std;
+using namespace nupic;
+
+using nupic::algorithms::spatial_pooler::SpatialPooler;
+using nupic::algorithms::sdr_classifier::SDRClassifier;
+using nupic::algorithms::cla_classifier::ClassifierResult;
+
+class MNIST {
+
+  private:
+    SpatialPooler sp;
+    SDR input;
+    SDR columns;
+    SDRClassifier clsr;
+    mnist::MNIST_dataset<std::vector, std::vector<uint8_t>, uint8_t> dataset;
+
+  public:
+    UInt verbosity = 1;
+    const UInt train_dataset_iterations = 1u;
+
+
+void setup() {
+
+  input.initialize({28 * 28});
+  sp.initialize(
+    /* inputDimensions */             input.dimensions,
+    /* columnDimensions */            {20 * 1000},
+    /* potentialRadius */             999999u,
+    /* potentialPct */                0.5f,
+    /* globalInhibition */            true,
+    /* localAreaDensity */            0.015f,
+    /* numActiveColumnsPerInhArea */  -1,
+    /* stimulusThreshold */           14u,
+    /* synPermInactiveDec */          0.01f,
+    /* synPermActiveInc */            0.05f,
+    /* synPermConnected */            0.4f,
+    /* minPctOverlapDutyCycles */     0.001f,
+    /* dutyCyclePeriod */             1402,
+    /* boostStrength */               1.0f,
+    /* seed */                        93u,
+    /* spVerbosity */                 1u,
+    /* wrapAround */                  true);
+
+  columns.initialize({sp.getNumColumns()});
+
+  clsr.initialize(
+    /* steps */         {0},
+    /* alpha */         .001,
+    /* actValueAlpha */ .3,
+                        verbosity);
+
+  dataset = mnist::read_dataset<std::vector, std::vector, uint8_t, uint8_t>(string("../ThirdParty/mnist_data/mnist-src/")); //from CMake
+}
+
+void train() {
+  // Train
+
+  if(verbosity)
+    cout << "Training for " << (train_dataset_iterations * dataset.training_labels.size())
+         << " cycles ..." << endl;
+  size_t i = 0;
+
+  SDR_Metrics inputStats(input,    1402);
+  SDR_Metrics columnStats(columns, 1402);
+
+  for(auto epoch = 0u; epoch < train_dataset_iterations; epoch++) {
+    NTA_INFO << "epoch " << epoch;
+    // Shuffle the training data.
+    vector<UInt> index( dataset.training_labels.size() );
+    index.assign(dataset.training_labels.cbegin(), dataset.training_labels.cend());
+    Random().shuffle( index.begin(), index.end() );
+
+    for(const auto idx : index) { // index = order of label (shuffeled)
+      // Get the input & label
+      const auto image = dataset.training_images.at(idx);
+      const UInt label  = dataset.training_labels.at(idx);
+
+      // Compute & Train
+      input.setDense( image );
+      sp.compute(input, true, columns);
+      ClassifierResult result;
+      clsr.compute(sp.getIterationNum(), columns.getFlatSparse(),
+        /* bucketIdxList */   {label},
+        /* actValueList */    {(Real)label},
+        /* category */        true,
+        /* learn */           true,
+        /* infer */           false,
+                              &result);
+      if( verbosity && (++i % 1000 == 0) ) cout << "." << flush;
+    }
+    if( verbosity ) cout << endl;
+  }
+  cout << "epoch ended" << endl;
+  cout << inputStats << endl;
+  cout << columnStats << endl;
+}
+
+void test() {
+  // Test
+  Real score = 0;
+  UInt n_samples = 0;
+  if(verbosity)
+    cout << "Testing for " << dataset.test_labels.size() << " cycles ..." << endl;
+  for(UInt i = 0; i < dataset.test_labels.size(); i++) {
+    // Get the input & label
+    const auto image  = dataset.test_images.at(i);
+    const UInt label  = dataset.test_labels.at(i);
+
+    // Compute
+    input.setDense( image );
+    sp.compute(input, false, columns);
+    ClassifierResult result;
+    clsr.compute(sp.getIterationNum(), columns.getFlatSparse(),
+      /* bucketIdxList */   {},
+      /* actValueList */    {},
+      /* category */        true,
+      /* learn */           false,
+      /* infer */           true,
+                            &result);
+    // Check results
+    for(auto iter : result) {
+      if( iter.first == 0 ) {
+          const auto *pdf = iter.second;
+          const auto max  = std::max_element(pdf->cbegin(), pdf->cend());
+          const UInt cls  = max - pdf->cbegin();
+          if(cls == label)
+            score += 1;
+          n_samples += 1;
+      }
+    }
+    if( verbosity && i % 1000 == 0 ) cout << "." << flush;
+  }
+  if( verbosity ) cout << endl;
+  cout << "Score: " << 100.0 * score / n_samples << "%% " << endl;
+}
+
+};  // End class MNIST
+}   // End namespace examples
+
+int main(int argc, char **argv) {
+  examples::MNIST m;
+  m.setup();
+  m.train();
+  m.test();
+
+  return 0;
+}
+