Skip to content

Commit 40d21e6

Browse files
reniertsclaude
renierts
and
claude
committed
docs: convert API reference to autosummary
Phase 7 - API reference: - enable sphinx.ext.autosummary with autosummary_generate = True - add a custom autosummary/class.rst template that renders full member docs - rewrite every api/pyrcn.*.rst page: replace inline autoclass/autofunction with `.. autosummary:: :toctree: generated` tables, keeping the curated groupings (reservoir layers/cells, input-to-node/node-to-node, metrics by task, util classes/functions) - each object now gets a scannable summary table on the module page plus a dedicated stub page with full documentation The generated/ stub pages are build artifacts (regenerated on Read the Docs), so they are gitignored. Full build produces 74 stub pages at 0 warnings. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 886b7d2 commit 40d21e6

15 files changed

Lines changed: 216 additions & 111 deletions

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@ dmypy.json
175175
/sequential_search_fsdd_kmeans_rec.joblib
176176
/sequential_search_fsdd_kmeans.joblib
177177
/docs/source/_build
178+
/docs/source/api/generated/
178179
/junit
179180
/pyrcn/junit
180181
/tests/junit

‎docs/source/_templates/autosummary/class.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{{ fullname | escape | underline }}
2+
3+
.. currentmodule:: {{ module }}
4+
5+
.. autoclass:: {{ objname }}
6+
:members:
7+
:undoc-members:
8+
:show-inheritance:

‎docs/source/api/pyrcn.base.rst‎

Lines changed: 23 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -5,38 +5,26 @@ pyrcn.base
55

66
.. automodule:: pyrcn.base
77

8-
pyrcn.base.blocks.InputToNode
9-
-----------------------------
10-
11-
.. autoclass:: pyrcn.base.blocks.InputToNode
12-
:members:
13-
:undoc-members:
14-
:show-inheritance:
15-
16-
.. autoclass:: pyrcn.base.blocks.PredefinedWeightsInputToNode
17-
:members:
18-
:undoc-members:
19-
:show-inheritance:
20-
21-
.. autoclass:: pyrcn.base.blocks.BatchIntrinsicPlasticity
22-
:members:
23-
:undoc-members:
24-
:show-inheritance:
25-
26-
pyrcn.base.blocks.NodeToNode
27-
----------------------------
28-
29-
.. autoclass:: pyrcn.base.blocks.NodeToNode
30-
:members:
31-
:undoc-members:
32-
:show-inheritance:
33-
34-
.. autoclass:: pyrcn.base.blocks.PredefinedWeightsNodeToNode
35-
:members:
36-
:undoc-members:
37-
:show-inheritance:
38-
39-
.. autoclass:: pyrcn.base.blocks.HebbianNodeToNode
40-
:members:
41-
:undoc-members:
42-
:show-inheritance:
8+
.. currentmodule:: pyrcn.base.blocks
9+
10+
Input-to-Node
11+
-------------
12+
13+
.. autosummary::
14+
:toctree: generated
15+
:nosignatures:
16+
17+
InputToNode
18+
PredefinedWeightsInputToNode
19+
BatchIntrinsicPlasticity
20+
21+
Node-to-Node
22+
------------
23+
24+
.. autosummary::
25+
:toctree: generated
26+
:nosignatures:
27+
28+
NodeToNode
29+
PredefinedWeightsNodeToNode
30+
HebbianNodeToNode

‎docs/source/api/pyrcn.datasets.rst‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
.. _`pyrcn.datasets`:
22

33
pyrcn.datasets
4-
==================
4+
==============
55

66
.. automodule:: pyrcn.datasets
7-
:members:
8-
:undoc-members:
9-
:show-inheritance:
7+
8+
.. currentmodule:: pyrcn.datasets
9+
10+
.. autosummary::
11+
:toctree: generated
12+
:nosignatures:
13+
14+
mackey_glass
15+
lorenz
16+
load_digits

‎docs/source/api/pyrcn.echo_state_network.rst‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,14 @@ pyrcn.echo_state_network
55

66
.. automodule:: pyrcn.echo_state_network
77

8+
.. currentmodule:: pyrcn.echo_state_network
9+
810
Echo State Network
911
------------------
1012

11-
.. autoclass:: pyrcn.echo_state_network.ESNRegressor
12-
:members:
13-
:undoc-members:
14-
:show-inheritance:
13+
.. autosummary::
14+
:toctree: generated
15+
:nosignatures:
1516

16-
.. autoclass:: pyrcn.echo_state_network.ESNClassifier
17-
:members:
18-
:undoc-members:
19-
:show-inheritance:
17+
ESNRegressor
18+
ESNClassifier

‎docs/source/api/pyrcn.extreme_learning_machine.rst‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@ pyrcn.extreme_learning_machine
55

66
.. automodule:: pyrcn.extreme_learning_machine
77

8-
.. autoclass:: pyrcn.extreme_learning_machine.ELMRegressor
9-
:members:
10-
:undoc-members:
11-
:show-inheritance:
8+
.. currentmodule:: pyrcn.extreme_learning_machine
129

13-
.. autoclass:: pyrcn.extreme_learning_machine.ELMClassifier
14-
:members:
15-
:undoc-members:
16-
:show-inheritance:
10+
Extreme Learning Machine
11+
------------------------
12+
13+
.. autosummary::
14+
:toctree: generated
15+
:nosignatures:
16+
17+
ELMRegressor
18+
ELMClassifier

‎docs/source/api/pyrcn.linear_model.rst‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@ pyrcn.linear_model
55

66
.. automodule:: pyrcn.linear_model
77

8-
.. autoclass:: pyrcn.linear_model.IncrementalRegression
9-
:members:
10-
:undoc-members:
11-
:show-inheritance:
8+
.. currentmodule:: pyrcn.linear_model
9+
10+
.. autosummary::
11+
:toctree: generated
12+
:nosignatures:
13+
14+
IncrementalRegression

‎docs/source/api/pyrcn.metrics.rst‎

Lines changed: 47 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,50 @@ pyrcn.metrics
44
=============
55

66
.. automodule:: pyrcn.metrics
7-
:members:
8-
:undoc-members:
9-
:show-inheritance:
7+
8+
.. currentmodule:: pyrcn.metrics
9+
10+
Classification metrics
11+
-----------------------
12+
13+
.. autosummary::
14+
:toctree: generated
15+
:nosignatures:
16+
17+
accuracy_score
18+
balanced_accuracy_score
19+
classification_report
20+
cohen_kappa_score
21+
confusion_matrix
22+
f1_score
23+
fbeta_score
24+
hamming_loss
25+
hinge_loss
26+
jaccard_score
27+
log_loss
28+
matthews_corrcoef
29+
precision_recall_fscore_support
30+
precision_score
31+
recall_score
32+
zero_one_loss
33+
brier_score_loss
34+
multilabel_confusion_matrix
35+
36+
Regression metrics
37+
-------------------
38+
39+
.. autosummary::
40+
:toctree: generated
41+
:nosignatures:
42+
43+
explained_variance_score
44+
max_error
45+
mean_absolute_error
46+
mean_squared_error
47+
mean_squared_log_error
48+
median_absolute_error
49+
mean_absolute_percentage_error
50+
r2_score
51+
mean_tweedie_deviance
52+
mean_poisson_deviance
53+
mean_gamma_deviance

‎docs/source/api/pyrcn.model_selection.rst‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ pyrcn.model_selection
44
=====================
55

66
.. automodule:: pyrcn.model_selection
7-
:members:
8-
:undoc-members:
9-
:show-inheritance:
7+
8+
.. currentmodule:: pyrcn.model_selection
9+
10+
.. autosummary::
11+
:toctree: generated
12+
:nosignatures:
13+
14+
SequentialSearchCV
15+
SHGOSearchCV

‎docs/source/api/pyrcn.nn.rst‎

Lines changed: 38 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -5,60 +5,64 @@ pyrcn.nn
55

66
.. automodule:: pyrcn.nn
77

8+
.. currentmodule:: pyrcn.nn
9+
810
Reservoir layers
911
----------------
1012

11-
.. autoclass:: pyrcn.nn.Reservoir
12-
:members:
13-
:undoc-members:
14-
:show-inheritance:
13+
.. autosummary::
14+
:toctree: generated
15+
:nosignatures:
1516

16-
.. autoclass:: pyrcn.nn.EulerReservoir
17-
:members:
18-
:undoc-members:
19-
:show-inheritance:
17+
Reservoir
18+
EulerReservoir
2019

2120
Reservoir cells
2221
---------------
2322

24-
.. autoclass:: pyrcn.nn.LeakyESNCell
25-
:members:
26-
:undoc-members:
27-
:show-inheritance:
23+
.. autosummary::
24+
:toctree: generated
25+
:nosignatures:
2826

29-
.. autoclass:: pyrcn.nn.EulerESNCell
30-
:members:
31-
:undoc-members:
32-
:show-inheritance:
27+
LeakyESNCell
28+
EulerESNCell
3329

3430
Feature map and readout
3531
------------------------
3632

37-
.. autoclass:: pyrcn.nn.InputFeatureMap
38-
:members:
39-
:undoc-members:
40-
:show-inheritance:
41-
42-
.. autoclass:: pyrcn.nn.IncrementalRidge
43-
:members:
44-
:undoc-members:
45-
:show-inheritance:
33+
.. autosummary::
34+
:toctree: generated
35+
:nosignatures:
4636

47-
.. autoclass:: pyrcn.nn.LinearReadout
48-
:members:
49-
:undoc-members:
50-
:show-inheritance:
37+
InputFeatureMap
38+
IncrementalRidge
39+
LinearReadout
5140

5241
Gradient training
5342
-----------------
5443

55-
.. autofunction:: pyrcn.nn.train_readout
44+
.. autosummary::
45+
:toctree: generated
46+
:nosignatures:
5647

57-
.. autofunction:: pyrcn.nn.torch_generator
48+
train_readout
49+
torch_generator
5850

5951
Weight initializers
6052
-------------------
6153

62-
.. automodule:: pyrcn.nn.init
63-
:members:
64-
:undoc-members:
54+
.. currentmodule:: pyrcn.nn.init
55+
56+
.. autosummary::
57+
:toctree: generated
58+
:nosignatures:
59+
60+
antisymmetric_recurrent_weights
61+
bernoulli_input_weights
62+
delay_line_feedback_weights
63+
delay_line_weights
64+
normal_recurrent_weights
65+
simple_cycle_weights
66+
spectral_normalize
67+
uniform_bias_weights
68+
uniform_input_weights

0 commit comments

Comments
 (0)