Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs_classic/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,11 +113,10 @@ Learn more
:class-card: sd-text-black sd-bg-light
:link: https://brainmodeling.readthedocs.io


.. grid-item::
:columns: 6 6 6 4

.. card:: :material-regular:`settings;2em` ``brainpy.state`` module
.. card:: :material-regular:`data_exploration;2em` ``brainpy.state`` APIs
:class-card: sd-text-black sd-bg-light
:link: https://brainpy-state.readthedocs.io/

Expand Down
26 changes: 13 additions & 13 deletions docs_state/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,44 +54,44 @@ Neurons

.. code-block:: python

import brainpy.state_based as brainpy
import brainpy

# Leaky Integrate-and-Fire
brainpy.LIF(size, V_rest, V_th, V_reset, tau, R, ...)
brainpy.state.LIF(size, V_rest, V_th, V_reset, tau, R, ...)

# Adaptive LIF
brainpy.ALIF(size, V_rest, V_th, V_reset, tau, tau_w, a, b, ...)
brainpy.state.ALIF(size, V_rest, V_th, V_reset, tau, tau_w, a, b, ...)

# Izhikevich
brainpy.Izhikevich(size, a, b, c, d, ...)
brainpy.state.Izhikevich(size, a, b, c, d, ...)

Synapses
~~~~~~~~

.. code-block:: python

# Exponential
brainpy.Expon.desc(size, tau)
brainpy.state.Expon.desc(size, tau)

# Alpha
brainpy.Alpha.desc(size, tau)
brainpy.state.Alpha.desc(size, tau)

# AMPA receptor
brainpy.AMPA.desc(size, tau)
brainpy.state.AMPA.desc(size, tau)

# GABA_a receptor
brainpy.GABAa.desc(size, tau)
brainpy.state.GABAa.desc(size, tau)

Projections
~~~~~~~~~~~

.. code-block:: python

# Standard projection
brainpy.AlignPostProj(
brainpy.state.AlignPostProj(
comm=brainstate.nn.EventFixedProb(n_pre, n_post, prob, weight),
syn=brainpy.Expon.desc(n_post, tau),
out=brainpy.COBA.desc(E),
syn=brainpy.state.Expon.desc(n_post, tau),
out=brainpy.state.COBA.desc(E),
post=post_neurons
)

Expand Down Expand Up @@ -152,8 +152,8 @@ BrainPy uses a clear import hierarchy:
import braintools # Training utilities

# Neurons and synapses
neuron = brainpy.LIF(100, ...)
synapse = brainpy.Expon.desc(100, tau=5*u.ms)
neuron = brainpy.state.LIF(100, ...)
synapse = brainpy.state.Expon.desc(100, tau=5*u.ms)

# State management
state = brainstate.ShortTermState(...)
Expand Down
Loading
Loading