Skip to content

Commit a6d6909

Browse files
authored
Update documentation (#791)
* fix(docs): update references to brainpy.state in documentation and examples * fix(docs): update card links and descriptions for brainpy.state APIs
1 parent 60f9e2e commit a6d6909

30 files changed

Lines changed: 444 additions & 1890 deletions

‎docs_classic/index.rst‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,11 +113,10 @@ Learn more
113113
:class-card: sd-text-black sd-bg-light
114114
:link: https://brainmodeling.readthedocs.io
115115

116-
117116
.. grid-item::
118117
:columns: 6 6 6 4
119118

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

‎docs_state/api/index.rst‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -54,44 +54,44 @@ Neurons
5454

5555
.. code-block:: python
5656
57-
import brainpy.state_based as brainpy
57+
import brainpy
5858
5959
# Leaky Integrate-and-Fire
60-
brainpy.LIF(size, V_rest, V_th, V_reset, tau, R, ...)
60+
brainpy.state.LIF(size, V_rest, V_th, V_reset, tau, R, ...)
6161
6262
# Adaptive LIF
63-
brainpy.ALIF(size, V_rest, V_th, V_reset, tau, tau_w, a, b, ...)
63+
brainpy.state.ALIF(size, V_rest, V_th, V_reset, tau, tau_w, a, b, ...)
6464
6565
# Izhikevich
66-
brainpy.Izhikevich(size, a, b, c, d, ...)
66+
brainpy.state.Izhikevich(size, a, b, c, d, ...)
6767
6868
Synapses
6969
~~~~~~~~
7070

7171
.. code-block:: python
7272
7373
# Exponential
74-
brainpy.Expon.desc(size, tau)
74+
brainpy.state.Expon.desc(size, tau)
7575
7676
# Alpha
77-
brainpy.Alpha.desc(size, tau)
77+
brainpy.state.Alpha.desc(size, tau)
7878
7979
# AMPA receptor
80-
brainpy.AMPA.desc(size, tau)
80+
brainpy.state.AMPA.desc(size, tau)
8181
8282
# GABA_a receptor
83-
brainpy.GABAa.desc(size, tau)
83+
brainpy.state.GABAa.desc(size, tau)
8484
8585
Projections
8686
~~~~~~~~~~~
8787

8888
.. code-block:: python
8989
9090
# Standard projection
91-
brainpy.AlignPostProj(
91+
brainpy.state.AlignPostProj(
9292
comm=brainstate.nn.EventFixedProb(n_pre, n_post, prob, weight),
93-
syn=brainpy.Expon.desc(n_post, tau),
94-
out=brainpy.COBA.desc(E),
93+
syn=brainpy.state.Expon.desc(n_post, tau),
94+
out=brainpy.state.COBA.desc(E),
9595
post=post_neurons
9696
)
9797
@@ -152,8 +152,8 @@ BrainPy uses a clear import hierarchy:
152152
import braintools # Training utilities
153153
154154
# Neurons and synapses
155-
neuron = brainpy.LIF(100, ...)
156-
synapse = brainpy.Expon.desc(100, tau=5*u.ms)
155+
neuron = brainpy.state.LIF(100, ...)
156+
synapse = brainpy.state.Expon.desc(100, tau=5*u.ms)
157157
158158
# State management
159159
state = brainstate.ShortTermState(...)

0 commit comments

Comments
 (0)