API Reference

Complete API reference for brainpy.state. The library exposes two distinct model families with different maturity levels — see the landing page for the full maturity table.

Stable API

The Stable API is the recommended entry point for production work and surrogate-gradient training. Public interfaces are stable for the 0.0.x series.

Base classes

Base Classes

Abstract base classes shared by all models: Dynamics, Neuron, Synapse.

base.html

BrainPy-style models

Neurons

Spiking neuron models (LIF, ALIF, AdEx, HH, Izhikevich, …).

brainpy-neurons.html

Synapses

Synaptic dynamics (Expon, Alpha, AMPA, GABA, NMDA).

brainpy-synapses.html

Projections

Connect neural populations (AlignPostProj, DeltaProj, …).

brainpy-projections.html

Synaptic Outputs

Convert conductances to currents (COBA, CUBA, MgBlock).

brainpy-synouts.html

Short-Term Plasticity

Short-term synaptic plasticity (STP, STD).

brainpy-plasticity.html

Readouts

Readout layers (LeakyRateReadout).

brainpy-readouts.html

Input Generators

Spike and current generators (PoissonSpike, SpikeTime).

brainpy-inputs.html

Experimental API (NEST-Compatible)

Warning

The NEST-compatible model family is under active development. Parameter names, defaults, numerical behavior, and the set of available models may change without notice across 0.0.x releases. Start with the NEST-Compatible Models — Status & Limitations for current scope and limitations.

NEST-style Status

Scope, limitations, ongoing migration, and what users should not yet rely on.

../nest-status/index.html

NEST Base Classes

NESTNeuron, NESTSynapse, NESTPlasticity, NESTDevice.

nest-base.html

NEST Neurons

IAF, AdEx, GIF, GLIF, HH, Izhikevich, rate, and binary neurons.

nest-neurons.html

NEST Synapses

Static synapses, gap junctions, and special connections.

nest-synapses.html

NEST Plasticity

STDP, STP, and voltage-based learning rules.

nest-plasticity.html

NEST Devices

Generators, recorders, and detectors.

nest-devices.html