Skip to content

Commit 1ea790e

Browse files
committed
update API list for sub-objects
1 parent 89e37c2 commit 1ea790e

File tree

1 file changed

+73
-6
lines changed

1 file changed

+73
-6
lines changed

doc/api.rst

Lines changed: 73 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,16 +67,18 @@ Functions to manipulate, examine, and analyze model objects.
6767
average_reconstructions
6868
fit_models_3d
6969

70+
Component Objects
71+
-----------------
7072

71-
Data Objects
72-
------------
73+
The model object combines multiple sub-objects that define and store different
74+
elements of the model definition, data, and results.
7375

74-
Objects to manage frequency bands, model information, and simulation parameters.
76+
Here, the main sub-objects are listed, some of which can also be used independently.
7577

76-
Bands Object
77-
~~~~~~~~~~~~
78+
Bands
79+
~~~~~
7880

79-
An object to handle frequency band definitions.
81+
An object for defining frequency band definitions.
8082

8183
.. currentmodule:: specparam
8284

@@ -85,6 +87,71 @@ An object to handle frequency band definitions.
8587

8688
Bands
8789

90+
Algorithm
91+
~~~~~~~~~
92+
93+
An object for defining fit algorithms.
94+
95+
.. currentmodule:: specparam.algorithms.algorithm
96+
97+
.. autosummary::
98+
:toctree: generated/
99+
100+
Algorithm
101+
102+
Modes
103+
~~~~~
104+
105+
An object for defining fit modes.
106+
107+
.. currentmodule:: specparam.modes.mode
108+
109+
.. autosummary::
110+
:toctree: generated/
111+
112+
Mode
113+
114+
Metrics
115+
~~~~~~~
116+
117+
An object for defining metrics.
118+
119+
.. currentmodule:: specparam.metrics.metric
120+
121+
.. autosummary::
122+
:toctree: generated/
123+
124+
Metric
125+
126+
Data
127+
~~~~
128+
129+
An object for managing data to be modeled.
130+
131+
.. currentmodule:: specparam.data.data
132+
133+
.. autosummary::
134+
:toctree: generated/
135+
136+
Data
137+
138+
Results
139+
~~~~~~~
140+
141+
An object for managing model results.
142+
143+
.. currentmodule:: specparam.results.results
144+
145+
.. autosummary::
146+
:toctree: generated/
147+
148+
Results
149+
150+
Data Objects
151+
------------
152+
153+
Objects to manage model information, and simulation parameters.
154+
88155
Model Information
89156
~~~~~~~~~~~~~~~~~
90157

0 commit comments

Comments
 (0)