v4

CyrilJl · May 28, 2024 · ba5bf25 · ba5bf25
1 parent 249d31e
commit ba5bf25
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 23 deletions.
diff --git a/batchstats/__init__.py b/batchstats/__init__.py
@@ -4,4 +4,4 @@
 __all__ = ['BatchCov', 'BatchMax', 'BatchMean', 'BatchMin', 'BatchPeakToPeak', 'BatchStat', 'BatchStd', 'BatchSum',
            'BatchVar', 'BatchNanMean', 'BatchNanStat', 'BatchNanSum']
 
-__version__ = '0.3.3'
+__version__ = '0.4'
diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst
@@ -3,26 +3,8 @@
 API Reference
 =============
 
-The class ``BatchStat`` is the parent class from which other classes inherit. It allows for the factorization of the ``_process_batch`` method, which removes samples containing at least one NaN and keeps track of the number of samples seen by the class up to date.
+.. toctree::
+   :maxdepth: 1   
 
-.. autoclass:: batchstats.BatchStat
-
-The following classes inherit from ``BatchStat``, and enable the user to compute various statistics over batch-accessed data:
-
-.. automodule:: batchstats
-    :members: BatchCov, BatchMax, BatchMean, BatchMin, BatchSum, BatchVar, BatchStd, BatchPeakToPeak
-    :undoc-members:
-    :show-inheritance:
-
-
-The class ``BatchNanStat`` is the parent class from which other classes that can treat NaNs inherit. It allows for the factorization of the ``_process_batch`` method, which keeps track of the number of NaNs per feature.
-
-.. autoclass:: batchstats.BatchNanStat
-
-The following classes inherit from ``BatchNanStat``:
-
-.. automodule:: batchstats
-    :members: BatchNanMean, BatchNanSum
-    :undoc-members:
-    :show-inheritance:
-    :no-index:
+   stats
+   nan_stats
diff --git a/docs/source/nan_stats.rst b/docs/source/nan_stats.rst
@@ -0,0 +1,13 @@
+BatchNaNStat classes
+====================
+
+The class ``BatchNanStat`` is the parent class from which other classes that can treat NaNs inherit. It allows for the factorization of the ``_process_batch`` method, which keeps track of the number of NaNs per feature.
+
+.. autoclass:: batchstats.BatchNanStat
+
+The following classes inherit from ``BatchNanStat``:
+
+.. automodule:: batchstats
+    :members: BatchNanMean, BatchNanSum
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/stats.rst b/docs/source/stats.rst
@@ -0,0 +1,13 @@
+BatchStat classes
+=================
+
+The class ``BatchStat`` is the parent class from which other classes inherit. It allows for the factorization of the ``_process_batch`` method, which removes samples containing at least one NaN and keeps track of the number of samples seen by the class up to date.
+
+.. autoclass:: batchstats.BatchStat
+
+The following classes inherit from ``BatchStat``, and enable the user to compute various statistics over batch-accessed data:
+
+.. automodule:: batchstats
+    :members: BatchCov, BatchMax, BatchMean, BatchMin, BatchSum, BatchVar, BatchStd, BatchPeakToPeak
+    :undoc-members:
+    :show-inheritance: