Skip to content

Commit e4448fd

Browse files
author
Alexander Ororbia
committed
update to API modeling docs to reflect RAF neuronal cell
1 parent 35eae76 commit e4448fd

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/modeling/neurons.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,23 @@ cell supports either Euler or midpoint method / RK-2 integration.)
191191
:noindex:
192192
```
193193

194+
### The Resonate-and-Fire (RAF) Cell
195+
196+
This cell models dynamics over voltage `v` and a angular driver state/variable `w`; these
197+
two variables result in a dampened oscillatory spiking neuronal cell). In effect, the
198+
resonatoe-and-fire (RAF) model (or "resonator") evolves as a result of two coupled
199+
differential equations. (Note that this cell supports either Euler or RK-2 integration.)
200+
201+
```{eval-rst}
202+
.. autoclass:: ngclearn.components.RAFCell
203+
:noindex:
204+
205+
.. automethod:: advance_state
206+
:noindex:
207+
.. automethod:: reset
208+
:noindex:
209+
```
210+
194211
### The Izhikevich Cell
195212

196213
This cell models dynamics over voltage `v` and a recover variable `w` (where `w`

0 commit comments

Comments
 (0)