Skip to main content

A powerful Python package for simulating spiking neural networks (SNNs) using PyTorch with GPU acceleration.

Project description

SynapticFlow

Light Logo

Spiking Neural Networks (SNNs) are a type of artificial neural network that attempts to mimic the behavior of neurons in the brain. Unlike traditional neural networks that use continuous-valued signals, SNNs operate using discrete spikes of activity that are similar to the action potentials in biological neurons. SynapticFlow is a powerful Python package for prototyping and simulating SNNs. It is based on PyTorch and supports both CPU and GPU computation. SynapticFlow extends the capabilities of PyTorch and enables us to take advantage of using spiking neurons. Additionally, it offers different variations of synaptic plasticity as well as delay learning for SNNs.

Please consider supporting the SynapticFlow project by giving it a star ⭐️ on Github, as it is a simple and effective way to show your appreciation and help the project gain more visibility.

If you encounter any problems, want to share your thoughts or have any questions related to training spiking neural networks, we welcome you to open an issue, start a discussion, or join our Discord channel where we can chat and offer advice.

Installation

To install synapticflow, run the following command in your terminal:

$ pip install synapticflow

We recommend using this method to install synapticflow since it will ensure that you have the latest stable version installed.

If you prefer to install synapticflow from source instead, follow these instructions:

$ git clone https://github.com/arsham-khoee/synapticflow
$ cd synapticflow
$ python setup.py install

Requirements

The requirements for SynapticFlow are as follows:
  • torch
  • matplotlib

Usage

After package installation has been finished, you can use it by following command:

import synapticflow as sf

In following code, a simple LIF neuron has been instantiated:

model = sf.LIFPopulation(n=1)
print(model.v) # Membrane Potential
print(model.s) # Spike Trace

SynapticFlow Structure

The following are the components included in SynapticFlow:

Component Description
synapticflow.network A spiking network components like neurons and connections
synapticflow.encoding Several encoders implementation
synapticflow.learning Learning rules and surrogate gradients
synapticflow.evaluation Several evaluation functions for networks
synapticflow.datasets Include MNIST, Fashion-MNIST, CIFAR-10 benchmark datasets
synapticflow.vision Include vision components for neuroscience
synapticflow.plot Plot tools for neural networks visualization

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

synapticflow-0.0.2.tar.gz (45.9 kB view details)

Uploaded Source

Built Distribution

synapticflow-0.0.2-py2.py3-none-any.whl (29.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file synapticflow-0.0.2.tar.gz.

File metadata

  • Download URL: synapticflow-0.0.2.tar.gz
  • Upload date:
  • Size: 45.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for synapticflow-0.0.2.tar.gz
Algorithm Hash digest
SHA256 2e6e97e7770b8fbc7bffaf031a3a2c7196982db2952eb98aa47c6730c676db7b
MD5 104b2d5718cd9fbf70c8a0912214fea3
BLAKE2b-256 7be1db8853b277e9445c47d53b614c98a80c48fde10447ba9f88f601c8cd8aee

See more details on using hashes here.

File details

Details for the file synapticflow-0.0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for synapticflow-0.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9586341b681a0ea08485bf83a3e6b9a7a02eb56cb999af6c17f592bc1c0a6038
MD5 c40aaf0e06651227eaf20cf93cf0ee55
BLAKE2b-256 71fe71d32993eb600a87c281d6eae8a2f7e4f290e4e378be01714204741534b8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page