From ba5bf25e9269509c4d56890f934990cfe9ae3292 Mon Sep 17 00:00:00 2001 From: CyrilJl Date: Tue, 28 May 2024 19:22:42 +0200 Subject: [PATCH] v4 --- batchstats/__init__.py | 2 +- docs/source/api_reference.rst | 26 ++++---------------------- docs/source/nan_stats.rst | 13 +++++++++++++ docs/source/stats.rst | 13 +++++++++++++ 4 files changed, 31 insertions(+), 23 deletions(-) create mode 100644 docs/source/nan_stats.rst create mode 100644 docs/source/stats.rst diff --git a/batchstats/__init__.py b/batchstats/__init__.py index 783c729..3986f46 100644 --- 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 index 0026853..dd8eeec 100644 --- 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: \ No newline at end of file + stats + nan_stats \ No newline at end of file diff --git a/docs/source/nan_stats.rst b/docs/source/nan_stats.rst new file mode 100644 index 0000000..6b181dd --- /dev/null +++ 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: \ No newline at end of file diff --git a/docs/source/stats.rst b/docs/source/stats.rst new file mode 100644 index 0000000..2c807f0 --- /dev/null +++ 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: \ No newline at end of file