Merge pull request #133 from IFCA/fix-documentation

Update documentation

Author: Jaime Céspedes Sisniega

docs/source/api_reference.md

@@ -3,13 +3,11 @@
 Welcome to the API reference for `frouros`.
 
 ```{toctree}
-:maxdepth: 1
+:maxdepth: 2
 
+api_reference/callbacks
 api_reference/datasets
+api_reference/detectors
 api_reference/metrics
-api_reference/semi_supervised
-api_reference/supervised
-api_reference/transformations
-api_reference/unsupervised
 api_reference/utils
-```
+```

docs/source/api_reference/callbacks.md

@@ -0,0 +1,44 @@
+# Callbacks
+
+```{eval-rst}
+.. automodule:: frouros.callbacks
+    :no-members:
+    :no-inherited-members:
+```
+
+```{currentmodule} frouros.callbacks
+```
+
+## Batch
+
+```{eval-rst}
+.. automodule:: frouros.callbacks.batch
+    :no-members:
+    :no-inherited-members:
+```
+
+```{eval-rst}
+.. autosummary::
+    :toctree: auto_generated/
+    :template: class.md
+
+    PermutationTestOnBatchData
+    ResetOnBatchDataDrift
+```
+
+## Streaming
+
+```{eval-rst}
+.. automodule:: frouros.callbacks.streaming
+    :no-members:
+    :no-inherited-members:
+```
+
+```{eval-rst}
+.. autosummary::
+    :toctree: auto_generated/
+    :template: class.md
+
+    History
+    WarningSamplesBuffer
+```

docs/source/api_reference/datasets.md

@@ -39,4 +39,4 @@
     :template: class.md
 
     SEA
-```
+```

docs/source/api_reference/detectors.md

@@ -0,0 +1,169 @@
+# Detectors
+
+The {mod}`frouros.detectors` module contains drift detection algorithms.
+
+```{eval-rst}
+.. automodule:: frouros.detectors
+    :no-members:
+    :no-inherited-members:
+```
+
+```{currentmodule} frouros.detectors
+```
+
+## Concept drift
+
+```{eval-rst}
+.. automodule:: frouros.detectors.concept_drift
+    :no-members:
+    :no-inherited-members:
+```
+
+```{currentmodule} frouros.detectors.concept_drift
+```
+
+### CUSUM Test
+
+```{eval-rst}
+.. automodule:: frouros.detectors.concept_drift.cusum_based
+    :no-members:
+    :no-inherited-members:
+```
+
+```{eval-rst}
+.. autosummary::
+    :toctree: auto_generated/
+    :template: class.md
+
+    CUSUM
+    GeometricMovingAverage
+    PageHinkley
+```
+
+### DDM Based
+
+```{eval-rst}
+.. automodule:: frouros.detectors.concept_drift.ddm_based
+    :no-members:
+    :no-inherited-members:
+```
+
+```{eval-rst}
+.. autosummary::
+    :toctree: auto_generated/
+    :template: class.md
+
+    DDM
+    ECDDWT
+    EDDM
+    HDDMA
+    HDDMW
+    RDDM
+    STEPD
+```
+
+### Window Based
+
+```{eval-rst}
+.. automodule:: frouros.detectors.concept_drift.window_based
+    :no-members:
+    :no-inherited-members:
+```
+
+```{eval-rst}
+.. autosummary::
+    :toctree: auto_generated/
+    :template: class.md
+
+    ADWIN
+    KSWIN
+```
+
+## Data drift
+
+```{eval-rst}
+.. automodule:: frouros.detectors.data_drift
+    :no-members:
+    :no-inherited-members:
+```
+
+```{currentmodule} frouros.detectors.data_drift
+```
+
+### Batch
+
+```{eval-rst}
+.. automodule:: frouros.detectors.data_drift.batch
+    :no-members:
+    :no-inherited-members:
+```
+
+```{currentmodule} frouros.detectors.data_drift.batch
+```
+
+#### Distance Based
+
+```{eval-rst}
+.. automodule:: frouros.detectors.data_drift.batch.distance_based
+    :no-members:
+    :no-inherited-members:
+```
+
+```{eval-rst}
+.. autosummary::
+    :toctree: auto_generated/
+    :template: class.md
+
+    EMD
+    HistogramIntersection
+    JS
+    KL
+    MMD
+    PSI
+```
+
+#### Statistical Test
+
+```{eval-rst}
+.. automodule:: frouros.detectors.data_drift.batch.statistical_test
+    :no-members:
+    :no-inherited-members:
+```
+
+```{eval-rst}
+.. autosummary::
+    :toctree: auto_generated/
+    :template: class.md
+
+    ChiSquareTest
+    CVMTest
+    KSTest
+    WelchTTest
+```
+
+### Streaming
+
+```{eval-rst}
+.. automodule:: frouros.detectors.data_drift.streaming
+    :no-members:
+    :no-inherited-members:
+```
+
+```{currentmodule} frouros.detectors.data_drift.streaming
+```
+
+#### Statistical Test
+
+```{eval-rst}
+.. automodule:: frouros.detectors.data_drift.streaming.statistical_test
+    :no-members:
+    :no-inherited-members:
+```
+
+```{eval-rst}
+.. autosummary::
+    :toctree: auto_generated/
+    :template: class.md
+
+    IncrementalKSTest
+```

docs/source/api_reference/metrics.md

@@ -23,5 +23,4 @@
     :template: class.md
 
     PrequentialError
-    PrequentialErrorFadingFactor
 ```