Updated docs.

Author: rbodo

README.rst

@@ -1,9 +1,15 @@
 Spiking neural network conversion toolbox
 =========================================
 
-The SNN conversion toolbox contains functions to transform rate-based artificial
-neural networks into spiking neural networks, and to simulate them. Please
-refer to the `Documentation <http://snntoolbox.readthedocs.io>`_ for a complete
-user guide and API reference.
+The SNN conversion toolbox (SNN-TB) is a framework to transform rate-based
+artificial neural networks into spiking neural networks, and to run them using
+various spike encodings. A unique feature about SNN-TB is that it accepts input
+models from many different deep-learning libraries (Keras / TF, pytorch, ...)
+and provides an interface to several backends for simulation (pyNN, brian2,
+...) or deployment (SpiNNaker, Loihi).
 
-See also the accompanying `article <https://www.frontiersin.org/articles/10.3389/fnins.2017.00682/abstract>`_.
+Please
+refer to the `Documentation <http://snntoolbox.readthedocs.io>`_ for a complete
+user guide and API reference. See also the accompanying articles
+`[Rueckauer et al., 2017] <https://www.frontiersin.org/articles/10.3389/fnins.2017.00682/abstract>`_
+and `[Rueckauer and Liu, 2018] <https://ieeexplore.ieee.org/abstract/document/8351295/>`_.

changelog.rst

@@ -1,6 +1,13 @@
 SNN Toolbox: Release Notes
 ==========================
 
+Version 0.4.1
+-------------
+
+The toolbox now supports input models from the PyTorch library.
+
+Thanks to Pengfei Sun for contributing.
+
 Version 0.4
 -----------
 

docs/build/doctrees/environment.pickle

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: a306f404cf002e007091db9367ab68fa
+config: e89bb39b701bf96800cc7264d625ca5f
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/doctrees/index.doctree

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Overview: module code &mdash; SNN toolbox 0.3.0 documentation</title>
+  <title>Overview: module code &mdash; SNN toolbox 0.4.1 documentation</title>
 
 
 
@@ -21,11 +21,11 @@
 
 
       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
-        <script type="text/javascript" src="../_static/jquery.js"></script>
-        <script type="text/javascript" src="../_static/underscore.js"></script>
-        <script type="text/javascript" src="../_static/doctools.js"></script>
-        <script type="text/javascript" src="../_static/language_data.js"></script>
-        <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
+        <script src="../_static/jquery.js"></script>
+        <script src="../_static/underscore.js"></script>
+        <script src="../_static/doctools.js"></script>
+        <script src="../_static/language_data.js"></script>
+        <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
 
     <script type="text/javascript" src="../_static/js/theme.js"></script>
 
@@ -59,7 +59,7 @@
 
 
               <div class="version">
-                0.3
+                0.4
               </div>
 
 
@@ -167,6 +167,7 @@ <h1>All modules for which code is available</h1>
 <li><a href="snntoolbox/datasets/utils.html">snntoolbox.datasets.utils</a></li>
 <li><a href="snntoolbox/parsing/model_libs/caffe_input_lib.html">snntoolbox.parsing.model_libs.caffe_input_lib</a></li>
 <li><a href="snntoolbox/parsing/model_libs/keras_input_lib.html">snntoolbox.parsing.model_libs.keras_input_lib</a></li>
+<li><a href="snntoolbox/parsing/model_libs/pytorch_input_lib.html">snntoolbox.parsing.model_libs.pytorch_input_lib</a></li>
 <li><a href="snntoolbox/parsing/utils.html">snntoolbox.parsing.utils</a></li>
 <li><a href="snntoolbox/simulation/backends/inisim/temporal_mean_rate_tensorflow.html">snntoolbox.simulation.backends.inisim.temporal_mean_rate_tensorflow</a></li>
 <li><a href="snntoolbox/simulation/backends/inisim/temporal_mean_rate_theano.html">snntoolbox.simulation.backends.inisim.temporal_mean_rate_theano</a></li>
@@ -183,6 +184,7 @@ <h1>All modules for which code is available</h1>
 <li><a href="snntoolbox/simulation/target_simulators/MegaSim_target_sim.html">snntoolbox.simulation.target_simulators.MegaSim_target_sim</a></li>
 <li><a href="snntoolbox/simulation/target_simulators/brian2_target_sim.html">snntoolbox.simulation.target_simulators.brian2_target_sim</a></li>
 <li><a href="snntoolbox/simulation/target_simulators/pyNN_target_sim.html">snntoolbox.simulation.target_simulators.pyNN_target_sim</a></li>
+<li><a href="snntoolbox/simulation/target_simulators/spiNNaker_target_sim.html">snntoolbox.simulation.target_simulators.spiNNaker_target_sim</a></li>
 <li><a href="snntoolbox/simulation/utils.html">snntoolbox.simulation.utils</a></li>
 <li><a href="snntoolbox/utils/utils.html">snntoolbox.utils.utils</a></li>
 </ul>
@@ -197,9 +199,9 @@ <h1>All modules for which code is available</h1>
 
   <div role="contentinfo">
     <p>
-        &copy; Copyright 2019, Bodo Rueckauer
+        &copy; Copyright 2020, Bodo Rueckauer
       <span class="lastupdated">
-        Last updated on Oct 12, 2019.
+        Last updated on Mar 07, 2020.
       </span>
 
     </p>

docs/build/html/.buildinfo

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -672,6 +672,10 @@ div.code-block-caption + div > div.highlight > pre {
     margin-top: 0;
 }
 
+div.doctest > div.highlight span.gp {  /* gp: Generic.Prompt */
+    user-select: none;
+}
+
 div.code-block-caption span.caption-number {
     padding: 0.1em 0.3em;
     font-style: italic;

docs/build/html/_images/workflow.png

@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for all documentation.
  *
- * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -283,10 +283,11 @@ var Documentation = {
   },
 
   initOnKeyListeners: function() {
-    $(document).keyup(function(event) {
+    $(document).keydown(function(event) {
       var activeElementType = document.activeElement.tagName;
       // don't navigate when in search box or textarea
-      if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
+      if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
+          && !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
         switch (event.keyCode) {
           case 37: // left
             var prevHref = $('link[rel="prev"]').prop('href');

docs/build/html/_modules/index.html

@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for the full-text search.
  *
- * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -63,6 +63,11 @@ var Search = {
       htmlElement.innerHTML = htmlString;
       $(htmlElement).find('.headerlink').remove();
       docContent = $(htmlElement).find('[role=main]')[0];
+      if(docContent === undefined) {
+          console.warn("Content block not found. Sphinx search tries to obtain it " +
+                       "via '[role=main]'. Could you check your theme or template.");
+          return "";
+      }
       return docContent.textContent || docContent.innerText;
   },
 
@@ -245,31 +250,32 @@ var Search = {
       if (results.length) {
         var item = results.pop();
         var listItem = $('<li style="display:none"></li>');
-        if (DOCUMENTATION_OPTIONS.FILE_SUFFIX === '') {
+        var requestUrl = "";
+        if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
           // dirhtml builder
           var dirname = item[0] + '/';
           if (dirname.match(/\/index\/$/)) {
             dirname = dirname.substring(0, dirname.length-6);
           } else if (dirname == 'index/') {
             dirname = '';
           }
-          listItem.append($('<a/>').attr('href',
-            DOCUMENTATION_OPTIONS.URL_ROOT + dirname +
-            highlightstring + item[2]).html(item[1]));
+          requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
+
         } else {
           // normal html builders
-          listItem.append($('<a/>').attr('href',
-            item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
-            highlightstring + item[2]).html(item[1]));
+          requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
         }
+        listItem.append($('<a/>').attr('href',
+            requestUrl +
+            highlightstring + item[2]).html(item[1]));
         if (item[3]) {
           listItem.append($('<span> (' + item[3] + ')</span>'));
           Search.output.append(listItem);
           listItem.slideDown(5, function() {
             displayNextItem();
           });
         } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
-          $.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX,
+          $.ajax({url: requestUrl,
                   dataType: "text",
                   complete: function(jqxhr, textstatus) {
                     var data = jqxhr.responseText;
@@ -424,15 +430,15 @@ var Search = {
         for (j = 0; j < _files.length; j++) {
           file = _files[j];
           if (!(file in scoreMap))
-            scoreMap[file] = {}
+            scoreMap[file] = {};
           scoreMap[file][word] = o.score;
         }
       });
 
       // create the mapping
       for (j = 0; j < files.length; j++) {
         file = files[j];
-        if (file in fileMap)
+        if (file in fileMap && fileMap[file].indexOf(word) === -1)
           fileMap[file].push(word);
         else
           fileMap[file] = [word];