Skip to main content

spikeforge

CI Status: pre-1.0 License: BSD-3-Clause Python 3.10–3.13 Ruff PRs Welcome Docs

A spiking-neural-network (SNN) toolkit built on snnTorch and PyTorch. Loads MNIST-style and neuromorphic event datasets, encodes them into rate, latency, delta, and random spikes, and trains, validates, exports, and deploys LIF networks — with a live browser dashboard served over WebSockets.

Pre-1.0 and unpublished. install.sh is the supported path today; PyPI ships once the distributions are published. Before trusting any number this produces, read Implications and boundaries.

Quickstart

git clone https://github.com/capsize-games/spikeforge.git
cd spikeforge
docker compose up --build

Open http://localhost:8877 — the dashboard connects to the WebSocket on the same host and port. No separate backend or proxy to run.

Prefer a local install, a headless example, or the CLI tools instead? See Usage and Quickstart for every path (./install.sh, local dev with Vite, examples/, and the eight spikeforge-* console scripts).

Features

  • Encoding — rate, latency, delta, and random spike coders.
  • Training — fully-connected and convolutional LIF networks with surrogate-gradient cross-entropy, checkpointing, and opt-in AMP / gradient checkpointing / truncated BPTT / multi-GPU.
  • Topologiesfc_legacy, fc_small, conv_net, recurrent_net, plus the sequence presets sequence_mlp and sequence_attn.
  • Datasets — MNIST, Fashion-MNIST, KMNIST, QMNIST, USPS, EMNIST, CIFAR-10, and (via the events extra) N-MNIST, DVS128 Gesture, CIFAR10-DVS, and Spiking Speech Commands.
  • Interpreter spine — NIR export, an independent NIR interpreter, and numerical drift validation.
  • Introspection — educational-mode U[t]/I[t]/S[t] traces, trajectory metrics, and surrogate-derivative curves.
  • Deployment — a capability matrix, weight quantization, energy accounting, and executable reference, norse, and lava_loihi2 backends.
  • Model hub — a curated, offline-first catalog plus optional live Hugging Face search.
  • Dashboard — a React + TypeScript UI with training, introspection, analysis, targets, energy, and hub panels, and seven guided walkthroughs.

Packages

This repository is a single workspace that publishes four distributions:

Distribution Import root Purpose
spikeforge spikeforge Core package: encoders, topologies, training, simulator, NIR bridge, tracking
spikeforge-targets spikeforge_targets Deployment targets, quantization, energy accounting, sparse event runtime
spikeforge-hub spikeforge_hub Curated model hub and optional Hugging Face access
spikeforge-server server FastAPI + WebSocket server and dashboard hosting

Documentation

This README stays short on purpose. documentation/ is the full reference — install paths, the CLI tools, architecture, module layout, and the dev workflow — written for contributors and coding agents alike. Also see COOKBOOK.md for copy-pasteable recipes, examples/ for runnable end-to-end scripts, and plans/ for design documents and the roadmap.

See CONTRIBUTING.md and rules.md before opening a pull request.

Citing

If spikeforge is useful in your research, please cite it — see CITATION.cff (GitHub renders a "Cite this repository" button from it automatically).

License

Released under the BSD 3-Clause License — see LICENSE and AUTHORS.

Download files

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

Source Distribution

spikeforge_io-0.1.0.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

spikeforge_io-0.1.0-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

Details for the file spikeforge_io-0.1.0.tar.gz.

File metadata

  • Download URL: spikeforge_io-0.1.0.tar.gz
  • Upload date:
  • Size: 16.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for spikeforge_io-0.1.0.tar.gz
Algorithm Hash digest
SHA256 193c18f7fdedf5a5cb98a477507590cf546e0a278b2e2a3bdf26ea708b5ce3c5
MD5 c58f89c035c12fbe82622f9bb6675cdd
BLAKE2b-256 5bb6a2852ace54a8c7fb6841412a347db8dd858e285eaeece89e1222362bb81f

See more details on using hashes here.

Provenance

The following attestation bundles were made for spikeforge_io-0.1.0.tar.gz:

Publisher: release.yml on Capsize-Games/spikeforge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file spikeforge_io-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: spikeforge_io-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for spikeforge_io-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f56d65d2b41d8315a25dc79700dd8c0400456d754769fd5eb69244403ccd736c
MD5 d5ab2f39060ae1ca81366f31b0229e69
BLAKE2b-256 6ce35143092739179fe519dbb91663d111e5ebbe4688e993375ea2472fdcfccc

See more details on using hashes here.

Provenance

The following attestation bundles were made for spikeforge_io-0.1.0-py3-none-any.whl:

Publisher: release.yml on Capsize-Games/spikeforge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.1.2

2 files

0.1.1

2 files

This release

0.1.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page