Skip to content

Commit b6202a9

Browse files
google-labs-jules[bot]google-labs-jules[bot]
committed
Reorganize API documentation into multiple pages.
The API Reference page was getting long, so this change splits it into two pages: "Core Classes" and "NaN-handling Classes". This makes the documentation easier to navigate.
1 parent 93d1e2e commit b6202a9

3 files changed

Lines changed: 46 additions & 39 deletions

File tree

‎docs/source/api.rst‎

Lines changed: 6 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -4,43 +4,10 @@ API Reference
44

55
This page provides a reference for the classes available in the ``batchstats`` library.
66

7-
Core Classes
8-
------------
7+
.. toctree::
8+
:maxdepth: 2
9+
:caption: API:
10+
:hidden:
911

10-
These are the standard classes for computing statistics on datasets. If your data contains ``NaN`` values, they will be handled by removing the entire sample (row) that contains them.
11-
12-
.. autoclass:: batchstats.BatchSum
13-
:members: update_batch, __call__
14-
15-
.. autoclass:: batchstats.BatchMean
16-
:members: update_batch, __call__
17-
18-
.. autoclass:: batchstats.BatchVar
19-
:members: update_batch, __call__
20-
21-
.. autoclass:: batchstats.BatchStd
22-
:members: update_batch, __call__
23-
24-
.. autoclass:: batchstats.BatchCov
25-
:members: update_batch, __call__
26-
27-
.. autoclass:: batchstats.BatchMin
28-
:members: update_batch, __call__
29-
30-
.. autoclass:: batchstats.BatchMax
31-
:members: update_batch, __call__
32-
33-
.. autoclass:: batchstats.BatchPeakToPeak
34-
:members: update_batch, __call__
35-
36-
37-
NaN-handling Classes
38-
--------------------
39-
40-
These classes are designed to handle datasets that contain ``NaN`` values, similar to ``numpy``'s ``nan*`` functions. They compute statistics by ignoring ``NaN`` values.
41-
42-
.. autoclass:: batchstats.BatchNanSum
43-
:members: update_batch, __call__
44-
45-
.. autoclass:: batchstats.BatchNanMean
46-
:members: update_batch, __call__
12+
core_classes
13+
nan_handling_classes

‎docs/source/core_classes.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
=============
2+
Core Classes
3+
=============
4+
5+
These are the standard classes for computing statistics on datasets. If your data contains ``NaN`` values, they will be handled by removing the entire sample (row) that contains them.
6+
7+
.. autoclass:: batchstats.BatchSum
8+
:members: update_batch, __call__
9+
10+
.. autoclass:: batchstats.BatchMean
11+
:members: update_batch, __call__
12+
13+
.. autoclass:: batchstats.BatchVar
14+
:members: update_batch, __call__
15+
16+
.. autoclass:: batchstats.BatchStd
17+
:members: update_batch, __call__
18+
19+
.. autoclass:: batchstats.BatchCov
20+
:members: update_batch, __call__
21+
22+
.. autoclass:: batchstats.BatchMin
23+
:members: update_batch, __call__
24+
25+
.. autoclass:: batchstats.BatchMax
26+
:members: update_batch, __call__
27+
28+
.. autoclass:: batchstats.BatchPeakToPeak
29+
:members: update_batch, __call__

‎docs/source/nan_handling_classes.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
======================
2+
NaN-handling Classes
3+
======================
4+
5+
These classes are designed to handle datasets that contain ``NaN`` values, similar to ``numpy``'s ``nan*`` functions. They compute statistics by ignoring ``NaN`` values.
6+
7+
.. autoclass:: batchstats.BatchNanSum
8+
:members: update_batch, __call__
9+
10+
.. autoclass:: batchstats.BatchNanMean
11+
:members: update_batch, __call__

0 commit comments

Comments
 (0)