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.6.tar.gz (38.5 kB view details)

Uploaded Source

Built Distribution

synapticflow-0.0.6-py2.py3-none-any.whl (43.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: synapticflow-0.0.6.tar.gz
  • Upload date:
  • Size: 38.5 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.6.tar.gz
Algorithm Hash digest
SHA256 aad0aa93ec03e80f1a5a0ce65d5aba8e8d5cb4c16d14c1064356cecff1d25370
MD5 5ff855b658095ca9e463d4eea6d092ed
BLAKE2b-256 a95d8a6a8ef714c5cb181b0e901bc6ae027e805caaea887764bdcc29eea8add7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for synapticflow-0.0.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 03362fc76b4159925529ed09fbbda8014396171e6fb9ab33ed622e0d565244b6
MD5 456acf348dd123069f5a938e1b7bf007
BLAKE2b-256 1a7e93fc45161e045369ec645befaecf130e82b0f8e8b8cc3232c0bc778e5774

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