Skip to content

Commit eab1c4f

Browse files
committed
[doc] update docs
1 parent e610c84 commit eab1c4f

File tree

4 files changed

+35
-16
lines changed

4 files changed

+35
-16
lines changed

docs/apis/brainpy.dyn.synapses.rst

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ Synaptic Dynamics
55
.. automodule:: brainpy.dyn
66

77

8+
9+
10+
Phenomenological synapse models
11+
-------------------------------
12+
13+
814
.. autosummary::
915
:toctree: generated/
1016
:nosignatures:
@@ -18,8 +24,33 @@ Synaptic Dynamics
1824
NMDA
1925
STD
2026
STP
27+
28+
29+
30+
Biological synapse models
31+
-------------------------
32+
33+
.. autosummary::
34+
:toctree: generated/
35+
:nosignatures:
36+
:template: classtemplate.rst
37+
2138
AMPA
2239
GABAa
2340
BioNMDA
41+
42+
43+
44+
Gap junction models
45+
-------------------
46+
47+
48+
.. autosummary::
49+
:toctree: generated/
50+
:nosignatures:
51+
:template: classtemplate.rst
52+
2453
DiffusiveCoupling
25-
AdditiveCoupling
54+
AdditiveCoupling
55+
56+

docs/tutorial_building/customize_neuron_models.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@
114114
"id": "3095ec6f",
115115
"metadata": {},
116116
"source": [
117-
"## [Hodgkin–Huxley Model](https://brainmodels.readthedocs.io/en/latest/apis/generated/brainmodels.neurons.HH.html)"
117+
"## [Hodgkin–Huxley Model](https://brainpy.readthedocs.io/en/latest/apis/generated/brainpy.dyn.HH.html)"
118118
]
119119
},
120120
{
@@ -268,7 +268,7 @@
268268
"id": "04d7d580",
269269
"metadata": {},
270270
"source": [
271-
"## [Leaky Integrate-and-Fire Model](https://brainmodels.readthedocs.io/en/latest/apis/generated/brainmodels.neurons.LIF.html)"
271+
"## [Leaky Integrate-and-Fire Model](https://brainpy.readthedocs.io/en/latest/apis/generated/brainpy.dyn.Lif.html)"
272272
]
273273
},
274274
{

docs/tutorial_building/kinetic_synapse_models.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"id": "4d9f49ab",
66
"metadata": {},
77
"source": [
8-
"# kinetic Synaptic Models"
8+
"# Kinetic Synaptic Models"
99
]
1010
},
1111
{

docs/tutorial_building/phenon_synapse_models.ipynb

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -306,8 +306,6 @@
306306
}
307307
],
308308
"source": [
309-
"# TODO: how to model excitatory synapse using Exponential + COBA synapse model?\n",
310-
"\n",
311309
"run_a_net(SimpleNet(E=0.))"
312310
]
313311
},
@@ -347,8 +345,6 @@
347345
}
348346
],
349347
"source": [
350-
"# TODO: how to model excitatory synapse using Exponential + COBA synapse model?\n",
351-
"\n",
352348
"run_a_net(SimpleNet(E=-80.))"
353349
],
354350
"metadata": {
@@ -480,8 +476,6 @@
480476
}
481477
],
482478
"source": [
483-
"# TODO: how to model excitatory synapse using Exponential + CUBA synapse model?\n",
484-
"\n",
485479
"run_a_net(SimpleNet2(g_max=5.))"
486480
],
487481
"metadata": {
@@ -529,8 +523,6 @@
529523
}
530524
],
531525
"source": [
532-
"# TODO: how to model inhibitory synapse using Exponential + CUBA synapse model?\n",
533-
"\n",
534526
"run_a_net(SimpleNet2(g_max=-5.))"
535527
],
536528
"metadata": {
@@ -822,8 +814,6 @@
822814
}
823815
],
824816
"source": [
825-
"# TODO: how to model excitatory synapse using Dual Exponential + COBA synapse model?\n",
826-
"\n",
827817
"run_a_net(SimpleNet4(E=0.))"
828818
],
829819
"metadata": {
@@ -871,8 +861,6 @@
871861
}
872862
],
873863
"source": [
874-
"# TODO: how to model excitatory synapse using Dual Exponential + COBA synapse model?\n",
875-
"\n",
876864
"run_a_net(SimpleNet4(E=-80.))"
877865
],
878866
"metadata": {

0 commit comments

Comments
 (0)