jaxsnn 0.3.0rc3

jaxsnn is an event-based approach to machine-learning-inspired training and simulation of SNNs, including support for neuromorphic backends (BrainScaleS-2).

jaxsnn

jaxsnn (pronounced like Jackson /ˈdʒæksən/) is an event-based approach to machine-learning-inspired training and simulation of SNNs, including support for neuromorphic backends (BrainScaleS-2). We build upon jax, a Python library providing autograd and XLA functionality for high-performance machine learning research.

Installation

We provide a pypi build of the software that lacks support for the BrainScaleS-2 neuromorphic hardware system. The usual pip install jaxsnn stuff should work, but YMMV.

Building the Software

The software builds upon existing libraries, such as jax, optax, and tree-math. When using the neuromorphic BrainScaleS-2 backend, the software stack of the platform is required.

We provide a container image (based on the Apptainer format) including all build-time and runtime dependencies. Feel free to download the most recent version from here.

For all following steps, we assume that the most recent Apptainer container is located at /containers/stable/latest.

Github-based Build

To build this project from public resources, adhere to the following guide:

# 1) Most of the following steps will be executed within a apptainer container
#    To keep the steps clutter-free, we start by defining an alias
shopt -s expand_aliases
alias c="apptainer exec --app dls /containers/stable/latest"

# 2) Prepare a fresh workspace and change directory into it
mkdir workspace && cd workspace

# 3) Fetch a current copy of the symwaf2ic build tool
git clone https://github.com/electronicvisions/waf -b symwaf2ic symwaf2ic

# 4) Build symwaf2ic
c make -C symwaf2ic
ln -s symwaf2ic/waf

# 5) Setup your workspace and clone all dependencies (--clone-depth=1 to skip history)
c ./waf setup --repo-db-url=https://github.com/electronicvisions/projects --project=jaxsnn

# 6) Load PPU cross-compiler toolchain (or build https://github.com/electronicvisions/oppulance)
module load ppu-toolchain

# 7) Build the project
#    Adjust -j1 to your own needs, beware that high parallelism will increase memory consumption!
c ./waf configure
c ./waf build -j1

# 8) Install the project to ./bin and ./lib
c ./waf install

# 9) If you run programs outside waf, you'll need to add ./lib and ./bin to your path specifications
export APPTAINERENV_PREPEND_PATH=`pwd`/bin:$APPTAINERENV_PREPEND_PATH
export APPTAINERENV_LD_LIBRARY_PATH=`pwd`/lib:$APPTAINERENV_LD_LIBRARY_PATH
export PYTHONPATH=`pwd`/lib:$PYTHONPATH
export PYTHONPATH=`pwd`/lib/python3.10/site-packages:$PYTHONPATH

# 10) To validate that your build was successful, execute the following example
python -m jaxsnn.examples.event.yinyang_analytical

Structure

jaxsnn is split into two parts. Training of SNNs is done in the init/apply style.

Time Discrete

jaxsnn.discrete simulates SNNs by treating time in a discrete way. It uses euler steps of a fixed size to advance the network forward in time which draws inspiration from norse.

Time Continuous

jaxsnn.event treats time continously and allows jumping from one event to the next one. Its core functionality consists of the step function, which does three things:

1. Find the next threshold crossing
2. Integrate the neuron to this point in time
3. Apply the discontinuity after the threshold crossing

jaxsnn.event.modules.lif provides the implementation of a CubaLIF neuron which can be used to build larger networks.

BSS-2 Connection

jaxsnn.event.modules.hx provides functionality to connect to the BSS-2 system and to conduct learning experiments on dedicated neuromorphic hardware.

First Steps

We provide multiple examples for usage of jaxsnn.

Time discrete learning using surrogate gradients on the Yin-Yang dataset:

python -m jaxsnn.examples.discrete.yinyang

Event-based two layer feed-forward network with analytical gradients:

python -m jaxsnn.examples.event.yinyang_analytical

Event-based two-layer feed-forward network with gradients computed using the EventProp algorithm:

python -m jaxsnn.examples.event.yinyang_layered_event_prop

Event-based recurrent network with gradients computed using the EventProp algorithm:

python -m jaxsnn.examples.event.yinyang_recurrent_event_prop

BSS-2

If you want to work with the BSS-2 system, a working example is provided:

python -m jaxsnn.examples.event.yinyang_bss2

Acknowledgements

The software in this repository has been developed by staff and students of Heidelberg University as part of the research carried out by the Electronic Visions group at the Kirchhoff-Institute for Physics.

This work has received funding from the EC Horizon 2020 Framework Programme under grant agreements 785907 (HBP SGA2) and 945539 (HBP SGA3), the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) under Germany's Excellence Strategy EXC 2181/1-390900948 (the Heidelberg STRUCTURES Excellence Cluster), the German Federal Ministry of Education and Research under grant number 16ES1127 as part of the Pilotinnovationswettbewerb Energieeffizientes KI-System, the Helmholtz Association Initiative and Networking Fund [Advanced Computing Architectures (ACA)] under Project SO-092, as well as from the Manfred Stärk Foundation, and the Lautenschläger-Forschungspreis 2018 for Karlheinz Meier.

Licensing

SPDX-License-Identifier: LGPL-2.1-or-later