From d61763807ee78e41effe1098ed0ecf1c2f8c305b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jaime=20C=C3=A9spedes=20Sisniega?= Date: Thu, 1 Jun 2023 10:31:16 +0200 Subject: [PATCH 1/3] Remove detectors_old.md --- docs/source/api_reference/detectors_old.md | 210 --------------------- 1 file changed, 210 deletions(-) delete mode 100644 docs/source/api_reference/detectors_old.md diff --git a/docs/source/api_reference/detectors_old.md b/docs/source/api_reference/detectors_old.md deleted file mode 100644 index 16914c3..0000000 --- a/docs/source/api_reference/detectors_old.md +++ /dev/null @@ -1,210 +0,0 @@ -# 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 -``` - -### Streaming - -```{eval-rst} -.. automodule:: frouros.detectors.concept_drift.streaming - :no-members: - :no-inherited-members: -``` - -```{currentmodule} frouros.detectors.concept_drift.streaming -``` - -#### CUSUM Test - -```{eval-rst} -.. automodule:: frouros.detectors.concept_drift.streaming.cusum_based - :no-members: - :no-inherited-members: -``` - -```{eval-rst} -.. autosummary:: - :toctree: auto_generated/ - :template: class.md - - CUSUM - CUSUMConfig - GeometricMovingAverage - GeometricMovingAverageConfig - PageHinkley - PageHinkleyConfig -``` - -#### Statistical Process Control - -```{eval-rst} -.. automodule:: frouros.detectors.concept_drift.streaming.statistical_process_control - :no-members: - :no-inherited-members: -``` - -```{eval-rst} -.. autosummary:: - :toctree: auto_generated/ - :template: class.md - - DDM - DDMConfig - ECDDWT - ECDDWTConfig - EDDM - EDDMConfig - HDDMA - HDDMAConfig - HDDMW - HDDMWConfig - RDDM - RDDMConfig -``` - -#### Window Based - -```{eval-rst} -.. automodule:: frouros.detectors.concept_drift.streaming.window_based - :no-members: - :no-inherited-members: -``` - -```{eval-rst} -.. autosummary:: - :toctree: auto_generated/ - :template: class.md - - ADWIN - ADWINConfig - KSWIN - KSWINConfig - STEPD - STEPDConfig -``` - -## 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 - - BhattacharyyaDistance - EMD - HellingerDistance - HINormalizedComplement - 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 -``` - -#### Distance Based - -```{eval-rst} -.. automodule:: frouros.detectors.data_drift.streaming.distance_based - :no-members: - :no-inherited-members: -``` - -```{eval-rst} -.. autosummary:: - :toctree: auto_generated/ - :template: class.md - - MMD -``` - -#### 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 -``` \ No newline at end of file From c3fd2439ed45bdc927ffd3d344fc7aafdc69f189 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jaime=20C=C3=A9spedes=20Sisniega?= Date: Thu, 1 Jun 2023 10:35:38 +0200 Subject: [PATCH 2/3] Fix documentation concepts section links --- docs/source/concepts.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/concepts.md b/docs/source/concepts.md index 5aea8a6..661c121 100644 --- a/docs/source/concepts.md +++ b/docs/source/concepts.md @@ -49,13 +49,13 @@ Drift detection methods can be classified according to the type of drift they ca Their main objective is to **detect concept drift**. They are closely related to data stream mining, online and incremental learning. -At the time of writing this, Frouros only implements *concept drift* detectors that work in a streaming manner. This means that the detector can only be updated with a single sample each time. +At the time of writing this, Frouros only implements *concept drift* detectors that work in a {doc}`streaming ` manner. This means that the detector can only be updated with a single sample each time. ### Data drift On the other hand, there are problems where it is very costly or even impossible to obtain labels in a reasonable amount of time (see [verification latency](#verification-latency-or-delay)). In this case, is not possible to directly check if *concept drift* is occurring, so **detect data drift** becomes the main objective of these type of methods. -Al the time of writing this, Frouros implements detectors that are capable to work in {ref}`batch ` or {ref}`streaming ` mode. In addition, we can difference between univariate and multivariate data drift detectors, according to the type of feature/covariate distributions used. +At the time of writing this, Frouros implements detectors that are capable to work in {doc}`batch ` or {doc}`streaming ` mode. In addition, we can difference between univariate and multivariate data drift detectors, according to the type of feature/covariate distributions used. ```{bibliography} :filter: docname in docnames ``` From 07753515acb505088a2d07fbac89af2de3afcfec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jaime=20C=C3=A9spedes=20Sisniega?= Date: Thu, 1 Jun 2023 10:37:33 +0200 Subject: [PATCH 3/3] Update CONTRIBUTING.md venv url --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ede3078..9198ceb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ Frouros is an open-source project. Anyone with an interest in the project can jo Recommended steps for first time contributors: 1. Fork repository on GitHub. -2. Set up develop environment (it is not mandatory, but we highly recommend the use of a [virtual environment](https://docs.python.org/3.9/library/venv.html)): +2. Set up develop environment (it is not mandatory, but we highly recommend the use of a [virtual environment](https://docs.python.org/3.11/library/venv.html)): ```bash python3 -m venv .venv source .venv/bin/activate