Skip to content

Fix readme #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 9, 2023
Merged

Fix readme #140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bd9a5c9
Replace README.md tables with diagrams
jaime-cespedes-sisniega Mar 9, 2023
c0a0f5e
Change README latex syntax
jaime-cespedes-sisniega Mar 9, 2023
684b891
Replace latex code with images
jaime-cespedes-sisniega Mar 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
307 changes: 4 additions & 303 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,313 +63,14 @@ Frouros supports Python 3.8, 3.9 and 3.10 versions. It can be installed via pip:
pip install frouros
```

Latest main branch modifications can be installed via:
```bash
pip install git+https://github.com/IFCA/frouros.git
```

## Drift detection methods

The currently supported methods are listed in the following table. They are divided in three main categories depending on the type of drift that they are capable of detecting and how they detect it.
The currently implemented detectors are listed in the following diagram.

<table class="center">
<thead>
<tr>
<th>Type</th>
<th>Subtype</th>
<th>Method</th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan="12">
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/concept_drift/base.py">
<div style="height:100%;width:100%">
Concept drift
</div>
</a>
</td>
<td rowspan="3">
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/supervised/cusum_based/base.py">
<div style="height:100%;width:100%">
CUSUM Based
</div>
</a>
</td>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/supervised/cusum_based/cusum.py">
<div style="height:100%;width:100%">
CUSUM
</div>
</a>
</td>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/supervised/cusum_based/geometric_moving_average.py">
<div style="height:100%;width:100%">
Geometric Moving Average
</div>
</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/supervised/cusum_based/page_hinkley.py">
<div style="height:100%;width:100%">
Page Hinkley
</div>
</a>
</td>
</tr>
<td rowspan="7">
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/supervised/ddm_based/base.py">
<div style="height:100%;width:100%">
DDM Based
</div>
</a>
</td>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/supervised/ddm_based/ddm.py">
<div style="height:100%;width:100%">
DDM
</div>
</a>
</td>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/supervised/ddm_based/ecdd.py">
<div style="height:100%;width:100%">
ECDD-WT
</div>
</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/supervised/ddm_based/eddm.py">
<div style="height:100%;width:100%">
EDDM
</div>
</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/supervised/ddm_based/hddm.py">
<div style="height:100%;width:100%">
HDDM-A
</div>
</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/supervised/ddm_based/hddm.py">
<div style="height:100%;width:100%">
HDDM-W
</div>
</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/supervised/ddm_based/rddm.py">
<div style="height:100%;width:100%">
RDDM
</div>
</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/supervised/ddm_based/stepd.py">
<div style="height:100%;width:100%">
STEPD
</div>
</a>
</td>
</tr>
<td rowspan="2">
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/supervised/window_based/base.py">
<div style="height:100%;width:100%">
Window Based
</div>
</a>
</td>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/supervised/window_based/adwin.py">
<div style="height:100%;width:100%">
ADWIN
</div>
</a>
</td>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/supervised/window_based/kswin.py">
<div style="height:100%;width:100%">
KSWIN
</div>
</a>
</td>
</tr>
</tr>
<tr>
<td rowspan="10">
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/data_drift/base.py">
<div style="height:100%;width:100%">
Data drift
</div>
</a>
</td>
<td rowspan="6">
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/unsupervised/distance_based/base.py">
<div style="height:100%;width:100%">
Distance Based
</div>
</a>
</td>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/unsupervised/distance_based/emd.py">
<div style="height:100%;width:100%">
EMD
</div>
</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/unsupervised/distance_based/histogram_intersection.py">
<div style="height:100%;width:100%">
Histogram Intersection
</div>
</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/unsupervised/distance_based/js.py">
<div style="height:100%;width:100%">
JS
</div>
</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/unsupervised/distance_based/kl.py">
<div style="height:100%;width:100%">
KL
</div>
</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/unsupervised/distance_based/mmd.py">
<div style="height:100%;width:100%">
MMD
</div>
</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/unsupervised/distance_based/psi.py">
<div style="height:100%;width:100%">
PSI
</div>
</a>
</td>
</tr>
<tr>
<td rowspan="4">
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/unsupervised/statistical_test/base.py">
<div style="height:100%;width:100%">
Statistical Test
</div>
</a>
</td>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/unsupervised/statistical_test/chisquare.py">
<div style="height:100%;width:100%">
Chi-Square
</div>
</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/unsupervised/statistical_test/cvm.py">
<div style="height:100%;width:100%">
CVM
</div>
</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/unsupervised/statistical_test/ks.py">
<div style="height:100%;width:100%">
KS
</div>
</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/unsupervised/statistical_test/welch_t_test.py">
<div style="height:100%;width:100%">
Welch's T-test
</div>
</a>
</td>
</tr>
</tbody>
</table>
![Detectors diagram](images/detectors.png)

## Datasets

Some well-known datasets and synthetic generators are provided and listed in the following table.
Some well-known datasets and synthetic generators are provided and listed in the following diagram.

<table class="center">
<thead>
<tr>
<th>Type</th>
<th>Dataset</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/datasets/real.py">
<div style="height:100%;width:100%">
Real
</div>
</a>
</td>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/datasets/real.py">
<div style="height:100%;width:100%">
Elec2
</div>
</a>
</td>
</tr>
<tr>
<td rowspan="3">
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/datasets/synthetic.py">
<div style="height:100%;width:100%">
Synthetic
</div>
</a>
</td>
<td>
<a href="https://github.com/jaime-cespedes-sisniega/frouros/blob/main/frouros/datasets/synthetic.py">
<div style="height:100%;width:100%">
SEA
</div>
</a>
</td>
</tr>
</tbody>
</table>
![Datasets diagram](images/datasets.png)
Binary file added images/datasets.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/detectors.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.