Skip to content

docs: reframe getting-started as Use as a library; add Vision section#4

Merged
ammar-s847 merged 1 commit into
mainfrom
readme-vision
May 26, 2026
Merged

docs: reframe getting-started as Use as a library; add Vision section#4
ammar-s847 merged 1 commit into
mainfrom
readme-vision

Conversation

@ammar-s847
Copy link
Copy Markdown
Contributor

Summary

Two related README changes:

1. Reframe "Getting started" → "Use as a library". This repo is the library, so the framing matches. Folds the separate Rust / Python subsections into one section: install snippet, Python example first (most likely entry point), Rust example below. The on-disk disk feature is split out as its own snippet.

2. Add a Vision section that situates hebb in the existing computational-neuroscience and SNN ecosystem and lists concrete interop directions. Briefly:

  • PyTorch-based SNN ML frameworks: snnTorch, BindsNET, Norse, SpikingJelly, Rockpool (surrogate-gradient training).
  • Biophysical simulators: NEST, Brian2, NEURON, GeNN, Arbor.
  • Neuromorphic platforms: Intel Loihi / Lava, SpiNNaker, BrainChip Akida, SynSense.

Concrete roadmap items called out:

  • PyTorch interop (train in snnTorch / Norse / SpikingJelly, export to hebb)
  • NeuroML / SONATA / PyNN model-description importers
  • NWB experimental-data ingestion
  • Event-camera datasets (DVS / N-MNIST / N-Caltech101 / DVS-Gesture)
  • Neuromorphic targets (Loihi via Lava IR, SpiNNaker, Akida)
  • More neuron + plasticity models (multi-compartment, e-prop, equilibrium propagation, calcium-based plasticity)
  • Performance (SIMD, wgpu GPU backend, deterministic parallel ticking)
  • WASM (browser simulation)

Also adds a row in "Who is this for?" for PyTorch / SNN-ML researchers, pointing them at the Vision section.

Test plan

  • Render README preview on GitHub
  • Confirm all section anchor links resolve

- Folds the separate Rust/Python subsections into one "Use as a library"
  section — this repo IS the library, so the framing matches.
- Adds a Vision section that situates hebb in the existing ecosystem
  (PyTorch-based SNN ML: snnTorch / Norse / BindsNET / SpikingJelly;
  biophysical sims: NEST / Brian2 / NEURON / GeNN; neuromorphic
  platforms: Loihi / SpiNNaker / Akida) and lists concrete interop
  directions: PyTorch round-trip, NeuroML/SONATA import, NWB ingestion,
  event-camera datasets, neuromorphic targets, more neuron/plasticity
  models, SIMD/GPU/WASM.
@ammar-s847 ammar-s847 merged commit c5a898e into main May 26, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant