Skip to content

Commit e0c75fa

Browse files
author
Alexander Ororbia
committed
some cleanup
1 parent 5dcdfe4 commit e0c75fa

18 files changed

+164
-225
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ ngc-learn requires:
3232
1) Python (>=3.10)
3333
2) NumPy (>=1.22.0)
3434
3) SciPy (>=1.7.0)
35-
4) ngcsimlib (>=1.0.0), (visit official page <a href="https://github.com/NACLab/ngc-sim-lib">here</a>)
35+
4) ngcsimlib (>=2.0.0), (visit official page <a href="https://github.com/NACLab/ngc-sim-lib">here</a>)
3636
5) JAX (>=0.4.28) (to enable GPU use, make sure to install one of the CUDA variants)
3737
<!--
3838
5) scikit-learn (>=1.3.1) if using `ngclearn.utils.density`
@@ -42,7 +42,7 @@ ngc-learn requires:
4242
-->
4343

4444
---
45-
ngc-learn 2.0.0 and later require Python 3.10 or newer as well as ngcsimlib >=1.0.0.
45+
ngc-learn 3.0.0 and later require Python 3.10 or newer as well as ngcsimlib >=2.0.0.
4646
ngc-learn's plotting capabilities (routines within `ngclearn.utils.viz`) require
4747
Matplotlib (>=3.8.0) and imageio (>=2.31.5) and both plotting and density estimation
4848
tools (routines within ``ngclearn.utils.density``) will require Scikit-learn (>=0.24.2).
@@ -75,7 +75,7 @@ Python 3.11.4 (main, MONTH DAY YEAR, TIME) [GCC XX.X.X] on linux
7575
Type "help", "copyright", "credits" or "license" for more information.
7676
>>> import ngclearn
7777
>>> ngclearn.__version__
78-
'2.0.0'
78+
'3.0.0'
7979
```
8080

8181
<i>Note:</i> For access to the previous Tensorflow-2 version of ngc-learn (of
@@ -122,7 +122,7 @@ $ python install -e .
122122
</pre>
123123

124124
**Version:**<br>
125-
2.0.2 <!--1.2.3-Beta--> <!-- -Alpha -->
125+
3.0.0 <!--1.2.3-Beta--> <!-- -Alpha -->
126126

127127
Author:
128128
Alexander G. Ororbia II<br>

docs/source/ngclearn.commands.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/source/ngclearn.components.lava.neurons.rst

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/source/ngclearn.components.lava.rst

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/source/ngclearn.components.lava.synapses.rst

Lines changed: 0 additions & 37 deletions
This file was deleted.

docs/source/ngclearn.components.lava.traces.rst

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/source/ngclearn.components.neurons.graded.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ ngclearn.components.neurons.graded.laplacianErrorCell module
2828
:undoc-members:
2929
:show-inheritance:
3030

31+
ngclearn.components.neurons.graded.leakyNoiseCell module
32+
--------------------------------------------------------
33+
34+
.. automodule:: ngclearn.components.neurons.graded.leakyNoiseCell
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
3139
ngclearn.components.neurons.graded.rateCell module
3240
--------------------------------------------------
3341

docs/source/ngclearn.components.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ Subpackages
88
:maxdepth: 4
99

1010
ngclearn.components.input_encoders
11-
ngclearn.components.lava
1211
ngclearn.components.neurons
1312
ngclearn.components.other
1413
ngclearn.components.synapses

docs/source/ngclearn.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ Subpackages
77
.. toctree::
88
:maxdepth: 4
99

10-
ngclearn.commands
1110
ngclearn.components
1211
ngclearn.modules
1312
ngclearn.operations

docs/source/ngclearn.utils.rst

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ Subpackages
1616
Submodules
1717
----------
1818

19+
ngclearn.utils.JaxProcessesMixin module
20+
---------------------------------------
21+
22+
.. automodule:: ngclearn.utils.JaxProcessesMixin
23+
:members:
24+
:undoc-members:
25+
:show-inheritance:
26+
1927
ngclearn.utils.data\_loader module
2028
----------------------------------
2129

@@ -24,18 +32,18 @@ ngclearn.utils.data\_loader module
2432
:undoc-members:
2533
:show-inheritance:
2634

27-
ngclearn.utils.io\_utils module
28-
-------------------------------
35+
ngclearn.utils.distribution\_generator module
36+
---------------------------------------------
2937

30-
.. automodule:: ngclearn.utils.io_utils
38+
.. automodule:: ngclearn.utils.distribution_generator
3139
:members:
3240
:undoc-members:
3341
:show-inheritance:
3442

35-
ngclearn.utils.jaxProcess module
36-
--------------------------------
43+
ngclearn.utils.io\_utils module
44+
-------------------------------
3745

38-
.. automodule:: ngclearn.utils.jaxProcess
46+
.. automodule:: ngclearn.utils.io_utils
3947
:members:
4048
:undoc-members:
4149
:show-inheritance:
@@ -56,6 +64,14 @@ ngclearn.utils.model\_utils module
5664
:undoc-members:
5765
:show-inheritance:
5866

67+
ngclearn.utils.patch module
68+
---------------------------
69+
70+
.. automodule:: ngclearn.utils.patch
71+
:members:
72+
:undoc-members:
73+
:show-inheritance:
74+
5975
ngclearn.utils.patch\_utils module
6076
----------------------------------
6177

0 commit comments

Comments
 (0)