update docs for leakyparallel

jeshraghian · Nov 19, 2023 · 38e1cdd · 38e1cdd
1 parent 21e9379
commit 38e1cdd
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/docs/snn.neurons_leakyparallel.rst b/docs/snn.neurons_leakyparallel.rst
@@ -0,0 +1,9 @@
+===========================
+snn.LeakyParallel
+===========================
+
+
+.. automodule:: snntorch._neurons.leakyparallel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/snntorch.rst b/docs/snntorch.rst
@@ -25,6 +25,9 @@ At present, the neurons available in :mod:`snntorch` are variants of the Leaky I
 * **Lapicque** - Lapicque's RC Neuron Model
 * **Alpha** - Alpha Membrane Model
 
+Neuron models that accelerate training require passing data in parallel. Available neurons include:
+* **LeakyParallel** - 1st Order Leaky Integrate-and-Fire Neuron
+
 Additional models include spiking-LSTMs and spiking-ConvLSTMs:
 
 * **SLSTM** - Spiking long short-term memory cell with state-thresholding 
@@ -35,7 +38,7 @@ Additional models include spiking-LSTMs and spiking-ConvLSTMs:
 How to use snnTorch's neuron models
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-The following arguments are common across all neuron models:
+The following arguments are common across most neuron models:
 
 * **threshold** - firing threshold of the neuron
 * **spike_grad** - surrogate gradient function (see :mod:`snntorch.surrogate`)