Speeding up snips by communicating less often

.gitignore

@@ -30,11 +30,11 @@ nengo_loihi/snips/nengo_io.c
 
 # For .ipynb examples
 *.pdf
-examples/communication_channel.py
-examples/integrator.py
-examples/integrator_multi_d.py
-examples/keyword_spotting.py
-examples/learn_communication_channel.py
-examples/oscillator.py
-examples/oscillator_nonlinear.py
-examples/*.pkl
+*.pkl
+docs/examples/communication_channel.py
+docs/examples/integrator.py
+docs/examples/integrator_multi_d.py
+docs/examples/keyword_spotting.py
+docs/examples/learn_communication_channel.py
+docs/examples/oscillator.py
+docs/examples/oscillator_nonlinear.py

docs/_static/custom.css

@@ -0,0 +1,20 @@
+.MathJax .mi, .MathJax .mo {
+    color: inherit;
+}
+
+pre, kdb, samp, code, .rst-content tt, .rst-content code {
+    word-break: inherit;
+}
+
+code, .rst-content tt, .rst-content code {
+    white-space: pre-wrap;
+}
+
+#notebook .container {
+    padding-left: 0;
+    width: inherit;
+}
+
+.body img {
+    max-width: 100%;
+}

docs/_templates/globaltoc.html

@@ -0,0 +1,13 @@
+<div class="sidebar-block">
+  <div class="sidebar-wrapper">
+    <h2>{{ _('Table Of Contents') }}</h2>
+  </div>
+  <div class="sidebar-toc">
+    {% set toctree = toctree(maxdepth=3, collapse=True) %}
+    {% if toctree %}
+      {{ toctree }}
+    {% else %}
+      {{ toc }}
+    {% endif %}
+  </div>
+</div>

docs/_templates/layout.html

@@ -0,0 +1,8 @@
+{# Import the theme's layout. #}
+{% extends "!layout.html" %}
+
+{%- block extrahead %}
+<link rel="stylesheet" type="text/css" href="{{ pathto("_static/custom.css", 1) }}">
+{# Call the parent block #}
+{{ super() }}
+{%- endblock %}

docs/api.rst

@@ -0,0 +1,29 @@
+*************
+API reference
+*************
+
+.. default-role:: obj
+
+.. autosummary::
+
+   nengo_loihi.add_params
+   nengo_loihi.set_defaults
+   nengo_loihi.Simulator
+   nengo_loihi.builder.Model
+   nengo_loihi.builder.Builder
+   nengo_loihi.loihi_cx.CxSimulator
+   nengo_loihi.loihi_interface.LoihiSimulator
+
+.. autofunction:: nengo_loihi.add_params
+
+.. autofunction:: nengo_loihi.set_defaults
+
+.. autoclass:: nengo_loihi.Simulator
+
+.. autoclass:: nengo_loihi.builder.Model
+
+.. autoclass:: nengo_loihi.builder.Builder
+
+.. autoclass:: nengo_loihi.loihi_cx.CxSimulator
+
+.. autoclass:: nengo_loihi.loihi_interface.LoihiSimulator

docs/conf.py

@@ -0,0 +1,117 @@
+# -*- coding: utf-8 -*-
+#
+# This file is execfile()d with the current directory set
+# to its containing dir.
+
+import sys
+
+try:
+    import nengo_loihi
+    import guzzle_sphinx_theme
+except ImportError:
+    print("To build the documentation, nengo_loihi and guzzle_sphinx_theme "
+          "must be installed in the current environment. Please install these "
+          "and their requirements first. A virtualenv is recommended!")
+    sys.exit(1)
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.githubpages',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.todo',
+    'sphinx.ext.viewcode',
+    'guzzle_sphinx_theme',
+    'numpydoc',
+    'nbsphinx',
+]
+
+default_role = 'py:obj'
+
+# -- sphinx.ext.autodoc
+autoclass_content = 'both'  # class and __init__ docstrings are concatenated
+autodoc_default_flags = ['members']
+autodoc_member_order = 'bysource'  # default is alphabetical
+
+# -- sphinx.ext.intersphinx
+intersphinx_mapping = {
+    'nengo': ('https://www.nengo.ai/nengo/', None),
+    'numpy': ('https://docs.scipy.org/doc/numpy', None),
+    'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
+}
+
+# -- sphinx.ext.todo
+todo_include_todos = True
+
+# -- numpydoc
+numpydoc_show_class_members = False
+
+# -- nbsphinx
+nbsphinx_timeout = -1
+
+# -- sphinx
+nitpicky = True
+exclude_patterns = ['_build']
+source_suffix = '.rst'
+source_encoding = 'utf-8'
+master_doc = 'index'
+
+# Need to include https Mathjax path for sphinx < v1.3
+mathjax_path = ("https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.3/"
+                "config/TeX-AMS-MML_HTMLorMML.js")
+
+project = u'Nengo Loihi'
+authors = u'Applied Brain Research'
+copyright = nengo_loihi.__copyright__
+version = '.'.join(nengo_loihi.__version__.split('.')[:2])
+release = nengo_loihi.__version__  # Full version, with tags
+pygments_style = 'default'
+
+# -- Options for HTML output --------------------------------------------------
+
+pygments_style = "sphinx"
+templates_path = ["_templates"]
+html_static_path = ["_static"]
+
+html_theme_path = guzzle_sphinx_theme.html_theme_path()
+html_theme = "guzzle_sphinx_theme"
+
+html_theme_options = {
+    "project_nav_name": "Nengo Loihi %s" % (version,),
+    "base_url": "https://www.nengo.ai/nengo-loihi",
+}
+
+html_title = "Nengo Loihi {0} docs".format(release)
+htmlhelp_basename = 'Nengo Loihi'
+html_last_updated_fmt = ''  # Suppress 'Last updated on:' timestamp
+html_show_sphinx = False
+
+# -- Options for LaTeX output -------------------------------------------------
+
+latex_elements = {
+    'papersize': 'letterpaper',
+    'pointsize': '11pt',
+    # 'preamble': '',
+}
+
+latex_documents = [
+    # (source start file, target, title, author, documentclass [howto/manual])
+    ('index', 'nengo_loihi.tex', html_title, authors, 'manual'),
+]
+
+# -- Options for manual page output -------------------------------------------
+
+man_pages = [
+    # (source start file, name, description, authors, manual section).
+    ('index', 'nengo_loihi', html_title, [authors], 1)
+]
+
+# -- Options for Texinfo output -----------------------------------------------
+
+texinfo_documents = [
+    # (source start file, target, title, author, dir menu entry,
+    #  description, category)
+    ('index', 'nengo_loihi', html_title, authors, 'Nengo',
+     'Loihi backend for Nengo', 'Miscellaneous'),
+]

docs/examples.rst

@@ -0,0 +1,19 @@
+**************
+Example models
+**************
+
+The following examples are similar
+to the `Nengo core examples <https://www.nengo.ai/nengo/examples.html>`_,
+but run using Nengo Loihi.
+We compare performance with Nengo core where appropriate.
+
+.. toctree::
+   :maxdepth: 1
+
+   examples/communication_channel
+   examples/integrator
+   examples/integrator_multi_d
+   examples/oscillator
+   examples/oscillator_nonlinear
+   examples/learn_communication_channel
+   examples/keyword_spotting

examples/integrator_multi_d.ipynb → docs/examples/integrator_multi_d.ipynb

@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Integrator\n",
+    "# Multidimensional integrator\n",
     "\n",
     "This demo implements an N-dimensional neural integrator.\n",
     "\n",

examples/keyword_spotting.ipynb → docs/examples/keyword_spotting.ipynb

@@ -18,9 +18,9 @@
     "This example uses optimized parameters\n",
     "generated by Nengo DL:\n",
     "\n",
-    "- [`reference_params.pkl`](\n",
+    "* [reference_params.pkl](\n",
     "https://drive.google.com/open?id=149rLqXnJqZPBiqvWpOAysGyq4fvunlnM)\n",
-    "- [`test_stream.pkl`](\n",
+    "* [test_stream.pkl](\n",
     "https://drive.google.com/open?id=1AQavHjQKNu1sso0jqYhWj6zUBLKuGNvV)\n",
     "\n",
     "If you have `requests` installed,\n",
@@ -272,7 +272,7 @@
     "        return stream[ti % len(stream)]\n",
     "\n",
     "    model.inp.output = play_stream\n",
-    "    n_steps = stream.shape[1]\n",
+    "    n_steps = stream.shape[0]\n",
     "\n",
     "    sim = nengo_loihi.Simulator(model, dt=dt, precompute=True)\n",
     "    with sim:\n",

docs/index.rst

@@ -0,0 +1,23 @@
+***********
+Nengo Loihi
+***********
+
+A backend for running Nengo models on Intel's Loihi architecture.
+
+To use the backend, simply replace::
+
+  nengo.Simulator(model)
+
+with::
+
+  nengo_loihi.Simulator(model)
+
+.. toctree::
+   :maxdepth: 2
+
+   overview
+   installation
+   examples
+   api
+   tips
+   setup/index