From 545a4d6e65d3efb96cc7e4ef938cd12f1cf93d3a Mon Sep 17 00:00:00 2001 From: "F.M. Quintana Velazquez" Date: Fri, 27 Feb 2026 18:04:04 +0100 Subject: [PATCH] Improv doc --- docs-site/docs/index.md | 2 +- docs-site/docs/neuron_models/fhn/README.md | 4 ---- docs-site/docs/neuron_models/fhn/index.md | 6 ++++++ docs-site/docs/neuron_models/lif/index.md | 2 +- .../docs/{img => neuron_models/lif}/lif_plot.png | Bin .../{img => neuron_models/snowball}/exif_plot.png | Bin docs-site/docs/neuron_models/snowball/index.md | 2 +- docs-site/mkdocs.yml | 2 ++ 8 files changed, 11 insertions(+), 7 deletions(-) delete mode 100644 docs-site/docs/neuron_models/fhn/README.md rename docs-site/docs/{img => neuron_models/lif}/lif_plot.png (100%) rename docs-site/docs/{img => neuron_models/snowball}/exif_plot.png (100%) diff --git a/docs-site/docs/index.md b/docs-site/docs/index.md index fdcfadc..b281c75 100644 --- a/docs-site/docs/index.md +++ b/docs-site/docs/index.md @@ -30,4 +30,4 @@ For GPU acceleration with CUDA 13: uv sync --extra cuda ``` -See the [examples](scripts/examples/neuron_models/) directory for more detailed usage examples. \ No newline at end of file +See the [examples](https://github.com/bics-rug/felice-models/tree/main/scripts/examples/neuron_models) directory for more detailed usage examples. \ No newline at end of file diff --git a/docs-site/docs/neuron_models/fhn/README.md b/docs-site/docs/neuron_models/fhn/README.md deleted file mode 100644 index 2682116..0000000 --- a/docs-site/docs/neuron_models/fhn/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# Circuit implementing the fhn neuron. - -- The circuits in the schematics implement the FHN neuron described. -- The FHN neuron is an implementation of the circuit described in (Ribar, L. (2019). Synthesis of neuromorphic circuits with neuromodulatory properties [Apollo - University of Cambridge Repository]. https://doi.org/10.17863/CAM.53750). The OTA and CMFB are well known designs that can be found in textbooks. diff --git a/docs-site/docs/neuron_models/fhn/index.md b/docs-site/docs/neuron_models/fhn/index.md index ba6b52e..b7f0e88 100644 --- a/docs-site/docs/neuron_models/fhn/index.md +++ b/docs-site/docs/neuron_models/fhn/index.md @@ -1,5 +1,10 @@ # FitzHugh-Nagumo +# Circuit implementing the fhn neuron. + +- The circuits in the schematics implement the FHN neuron described. +- The FHN neuron is an implementation of the circuit described in (Ribar, L. (2019). Synthesis of neuromorphic circuits with neuromodulatory properties [Apollo - University of Cambridge Repository]. [DOI: 10.17863/CAM.53750](https://doi.org/10.17863/CAM.53750)). The OTA and CMFB are well known designs that can be found in textbooks. + ## Circuit equation $$ @@ -15,6 +20,7 @@ where the currents are: - $I_{fast} = a_{fast} \tanh(v - v_{off,fast})$ - $I_{slow} = a_{slow} \tanh(v_{slow} - v_{off,slow})$ + ## Examples See the following interactive notebook for a practical example: diff --git a/docs-site/docs/neuron_models/lif/index.md b/docs-site/docs/neuron_models/lif/index.md index 7cc40e3..e177c8e 100644 --- a/docs-site/docs/neuron_models/lif/index.md +++ b/docs-site/docs/neuron_models/lif/index.md @@ -2,6 +2,6 @@ ## Circuit Design W/L = 4/3 ## Circuit Simulation -![lif, output plot](/docs-site/docs/img/lif_plot.png) Fig.1 The dynamics of leaky integrate and fire neuron. The grey signal is the input spikes, the yellow signal is the membrane potential and the dark blue is the output spikes from the neuron. +![lif, output plot](lif_plot.png) Fig.1 The dynamics of leaky integrate and fire neuron. The grey signal is the input spikes, the yellow signal is the membrane potential and the dark blue is the output spikes from the neuron. ## Referennces 1. Sourikopoulos I, Hedayat S, Loyez C, Danneville F, Hoel V, Mercier E and Cappy A (2017) A 4-fJ/Spike Artificial Neuron in 65 nm CMOS Technology. Front. Neurosci. 11:123. doi: 10.3389/fnins.2017.00123 \ No newline at end of file diff --git a/docs-site/docs/img/lif_plot.png b/docs-site/docs/neuron_models/lif/lif_plot.png similarity index 100% rename from docs-site/docs/img/lif_plot.png rename to docs-site/docs/neuron_models/lif/lif_plot.png diff --git a/docs-site/docs/img/exif_plot.png b/docs-site/docs/neuron_models/snowball/exif_plot.png similarity index 100% rename from docs-site/docs/img/exif_plot.png rename to docs-site/docs/neuron_models/snowball/exif_plot.png diff --git a/docs-site/docs/neuron_models/snowball/index.md b/docs-site/docs/neuron_models/snowball/index.md index 6c39f14..3675d3e 100644 --- a/docs-site/docs/neuron_models/snowball/index.md +++ b/docs-site/docs/neuron_models/snowball/index.md @@ -7,7 +7,7 @@ Input current mirror W/l = 0.2
All other transistors W/L = 4/3 ## Circuit Simulation -![snowball, output plot](/docs-site/docs/img/exif_plot.png) Fig.1 The dynamics of Exponential integrate and fire neuron. The light blue signal is the input spikes, the yellow signal is the membrane potential and the dark blue is the output spikes from the neuron. +![snowball, output plot](exif_plot.png) Fig.1 The dynamics of Exponential integrate and fire neuron. The light blue signal is the input spikes, the yellow signal is the membrane potential and the dark blue is the output spikes from the neuron. ## References 1. Rubino, Arianna, Melika Payvand, and Giacomo Indiveri. "Ultra-low power silicon neuron circuit for extreme-edge neuromorphic intelligence." 2019 26th IEEE International Conference on Electronics, Circuits and Systems (ICECS). IEEE, 2019. 2. Bartolozzi, Chiara, Srinjoy Mitra, and Giacomo Indiveri. "An ultra low power current-mode filter for neuromorphic systems and biomedical signal processing." 2006 IEEE Biomedical Circuits and Systems Conference. IEEE, 2006. diff --git a/docs-site/mkdocs.yml b/docs-site/mkdocs.yml index 5606d63..3d33174 100644 --- a/docs-site/mkdocs.yml +++ b/docs-site/mkdocs.yml @@ -27,6 +27,8 @@ nav: - Example: neuron_models/fhn/fhn.ipynb - Snowball: - Description: neuron_models/snowball/index.md + - LIF: + - Description: neuron_models/lif/index.md - API Reference: - api/index.md - Neuron Models: api/neuron_models.md