Skip to content

Commit 45d711c

Browse files
ago109Alexander Ororbiarxng8
authored
Merge over further doc edits/clean-up from main (#120)
* minor edit to math in hh-lesson doc * Fix workflow, numpy install, and pytest bug in github action workflows (#117) * Update pyproject.toml * Update python-package-conda.yml * Update python-package-conda.yml * Update python-package-conda.yml * Update python-package-conda.yml * Update python-package-conda.yml * Update python-package-conda.yml * Update python-package-conda.yml * minor nudge/cleanup to minor patched version 2.0.1 * minor nudge/cleanup to minor patched version 2.0.3 * Merged back minor doc fix back to main (for syncing purposes) (#119) * Nudge of release to minor patched version 2.0.3 (#118) * nudge of doc to 2.0.2 (#115) Co-authored-by: Alexander Ororbia <ago@hal3.cs.rit.edu> * minor edit to math in hh-lesson doc * Fix workflow, numpy install, and pytest bug in github action workflows (#117) * Update pyproject.toml * Update python-package-conda.yml * Update python-package-conda.yml * Update python-package-conda.yml * Update python-package-conda.yml * Update python-package-conda.yml * Update python-package-conda.yml * Update python-package-conda.yml * minor nudge/cleanup to minor patched version 2.0.1 * minor nudge/cleanup to minor patched version 2.0.3 --------- Co-authored-by: Alexander Ororbia <ago@hal3.cs.rit.edu> Co-authored-by: Viet Dung Nguyen <60036798+rxng8@users.noreply.github.com> * fixed typo/error in doc evolving_synapses.md --------- Co-authored-by: Alexander Ororbia <ago@hal3.cs.rit.edu> Co-authored-by: Viet Dung Nguyen <60036798+rxng8@users.noreply.github.com> * minor clean-up in model_basics docs * minor fixes/cleanup of docs --------- Co-authored-by: Alexander Ororbia <ago@hal3.cs.rit.edu> Co-authored-by: Viet Dung Nguyen <60036798+rxng8@users.noreply.github.com>
1 parent 26617aa commit 45d711c

File tree

4 files changed

+17
-21
lines changed

4 files changed

+17
-21
lines changed

docs/tutorials/model_basics/evolving_synapses.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,13 @@ dkey, *subkeys = random.split(dkey, 6)
2929

3030
## create simple system with only one F-N cell
3131
with Context("Circuit") as circuit:
32-
a = RateCell(name="a", n_units=1, tau_m=0.,
33-
act_fx="identity", key=subkeys[0])
34-
b = RateCell(name="b", n_units=1, tau_m=0.,
35-
act_fx="identity", key=subkeys[1])
36-
37-
Wab = HebbianSynapse(name="Wab", shape=(1, 1), eta=1.,
38-
sign_value=-1., weight_init=dist.constant(value=1.),
39-
w_bound=0., key=subkeys[3])
32+
a = RateCell(name="a", n_units=1, tau_m=0., act_fx="identity", key=subkeys[0])
33+
b = RateCell(name="b", n_units=1, tau_m=0., act_fx="identity", key=subkeys[1])
34+
35+
Wab = HebbianSynapse(
36+
name="Wab", shape=(1, 1), eta=1., sign_value=-1., weight_init=dist.constant(value=1.),
37+
w_bound=0., key=subkeys[3]
38+
)
4039

4140
# wire output compartment (rate-coded output zF) of RateCell `a` to input compartment of HebbianSynapse `Wab`
4241
Wab.inputs << a.zF

docs/tutorials/model_basics/model_building.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,11 @@ dkey, *subkeys = random.split(dkey, 4)
2121

2222
## create simple dynamical system: a --> w_ab --> b
2323
with Context("model") as model:
24-
a = RateCell(name="a", n_units=1, tau_m=0.,
25-
act_fx="identity", key=subkeys[0])
26-
b = RateCell(name="b", n_units=1, tau_m=20.,
27-
act_fx="identity", key=subkeys[1])
28-
Wab = HebbianSynapse(name="Wab", shape=(1, 1),
29-
weight_init=dist.constant(value=1.), key=subkeys[2])
24+
a = RateCell(name="a", n_units=1, tau_m=0., act_fx="identity", key=subkeys[0])
25+
b = RateCell(name="b", n_units=1, tau_m=20., act_fx="identity", key=subkeys[1])
26+
Wab = HebbianSynapse(
27+
name="Wab", shape=(1, 1), weight_init=dist.constant(value=1.), key=subkeys[2]
28+
)
3029
```
3130

3231
Next, we will want to wire together the three components we have embedded into

docs/tutorials/neurocog/hodgkin_huxley_cell.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,6 @@ essentially probability values:
7777
`m` ($\mathbf{m}_t$) for the probability of sodium channel subunit activation, and
7878
`h` ($\mathbf{h}_t$) for the probability of sodium channel subunit inactivation.
7979

80-
neurons and muscle cells. It is a continuous-time dynamical system.
81-
8280
Formally, the core dynamics of the H-H cell can be written out as follows:
8381

8482
$$

docs/tutorials/neurocog/simple_leaky_integrator.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ integrator components, the simplified leaky integrate-and-fire (SLIF).
1010
With our JSON configuration in place, go ahead and create a Python script,
1111
i.e., `run_slif.py`, to write your code for this part of the tutorial.
1212

13-
Now let's go ahead and set up the controller for this lesson's simulation,
13+
Now let's go ahead and set up the controller/context for this lesson's simulation,
1414
where we will a dynamical system with only a single component,
1515
specifically the simplified LIF (sLIF), like so:
1616

@@ -55,14 +55,14 @@ with Context("Model") as model:
5555
```
5656

5757
This node has quite a few compartments and constants but only a handful are important
58-
for understanding how this model governs spiking/firing rates during
59-
a controller's simulation window. Specifically, in this lesson, we will focus on
58+
for understanding how this model governs spiking/firing rates within its simulation window.
59+
Specifically, in this lesson, we will focus on
6060
its electrical current `j` (formally labeled here as $\mathbf{j}_t$),
6161
its voltage `v` (formally labeled: $\mathbf{v}_t$), its spike emission
6262
(or action potential) `s` (formally $\mathbf{s}_t$), and its refractory
6363
variable/marker (formally $\mathbf{r}_t$). The subscript $t$ indicates
6464
that this compartment variable takes on a certain value at a certain time step
65-
$t$ and we will refer to the ngc-learn controller's integration time constant,
65+
$t$ and we will refer to the ngc-learn context's integration time constant,
6666
the amount of time we move forward by, as $\Delta t$. The constants or
6767
hyper-parameters we will be most interested in are the cell's membrane resistance
6868
`R_m` (formally $R$ with its capacitance $C$ implied), its membrane time
@@ -198,7 +198,7 @@ its synaptic current over time - we will not, however, cover this functionality
198198
in this walkthrough.)-->
199199

200200
In effect, given the above, every time the `sLIF`'s `.advanceState()` function is
201-
called within a simulation controller (`Controller()`), the above Euler integration of
201+
called within a simulation controller context (`Context()`), the above Euler integration of
202202
the membrane potential differential equation is happening each time step. Knowing this,
203203
the last item required to understand ngc-learn's `sLIF` node's computation is
204204
related to its spike $\mathbf{s}_t$. The spike reading is computed simply by

0 commit comments

Comments
 (0)