Skip to content

Commit 9e59845

Browse files
author
Jaime Céspedes Sisniega
authored
Merge pull request #197 from IFCA/feature-readme-table
Add columns readme table
2 parents c514cad + 2f111f8 commit 9e59845

File tree

1 file changed

+129
-75
lines changed

1 file changed

+129
-75
lines changed

‎README.md‎

Lines changed: 129 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -193,132 +193,186 @@ pip install frouros
193193

194194
The currently implemented detectors are listed in the following table.
195195

196-
<table>
197-
<thead>
196+
<table style="width: 100%; text-align: center; border-collapse: collapse; border: 1px solid grey;">
197+
<thead>
198+
<tr>
199+
<th style="text-align: center; border: 1px solid grey; padding: 4px;">Drift detector</th>
200+
<th style="text-align: center; border: 1px solid grey; padding: 4px;">Type</th>
201+
<th style="text-align: center; border: 1px solid grey; padding: 4px;">Family</th>
202+
<th style="text-align: center; border: 1px solid grey; padding: 4px;">Univariate (U) / Multivariate (M)</th>
203+
<th style="text-align: center; border: 1px solid grey; padding: 4px;">Numerical (N) / Categorical (C)</th>
204+
<th style="text-align: center; border: 1px solid grey; padding: 4px;">Method</th>
205+
<th style="text-align: center; border: 1px solid grey; padding: 4px;">Reference</th>
206+
</tr>
207+
</thead>
208+
<tbody>
198209
<tr>
199-
<th>Drift detector</th>
200-
<th>Type</th>
201-
<th>Family</th>
202-
<th>Method</th>
203-
<th>Reference</th>
210+
<td rowspan="12" style="text-align: center; border: 1px solid grey; padding: 8px;">Concept drift</td>
211+
<td rowspan="12" style="text-align: center; border: 1px solid grey; padding: 8px;">Streaming</td>
212+
<td rowspan="3" style="text-align: center; border: 1px solid grey; padding: 8px;">CUMSUM</td>
213+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
214+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
215+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">CUMSUM</td>
216+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.2307/2333009">Page (1954)</a></td>
204217
</tr>
205-
</thead>
206-
<tbody>
207218
<tr>
208-
<td rowspan="12">Concept drift</td>
209-
<td rowspan="12">Streaming</td>
210-
<td rowspan="3">CUMSUM</td>
211-
<td>CUMSUM</td>
212-
<td><a href="https://doi.org/10.2307/2333009">Page (1954)</a></td>
219+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
220+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
221+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">Geometric moving average</td>
222+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.2307/1266443">Roberts (1959)</a></td>
213223
</tr>
214224
<tr>
215-
<td>Geometric moving average</td>
216-
<td><a href="https://doi.org/10.2307/1266443">Roberts (1959)</a></td>
225+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
226+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
227+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">Page Hinkley</td>
228+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.2307/2333009">Page (1954)</a></td>
217229
</tr>
218230
<tr>
219-
<td>Page Hinkley</td>
220-
<td><a href="https://doi.org/10.2307/2333009">Page (1954)</a></td>
231+
<td rowspan="6" style="text-align: center; border: 1px solid grey; padding: 8px;">Statistical process control</td>
232+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
233+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
234+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">DDM</td>
235+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.1007/978-3-540-28645-5_29">Gama et al. (2004)</a></td>
221236
</tr>
222237
<tr>
223-
<td rowspan="6">Statistical process control</td>
224-
<td>DDM</td>
225-
<td><a href="https://doi.org/10.1007/978-3-540-28645-5_29">Gama et al. (2004)</a></td>
238+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
239+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
240+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">ECDD-WT</td>
241+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.1016/j.patrec.2011.08.019">Ross et al. (2012)</a></td>
226242
</tr>
227243
<tr>
228-
<td>ECDD-WT</td>
229-
<td><a href="https://doi.org/10.1016/j.patrec.2011.08.019">Ross et al. (2012)</a></td>
244+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
245+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
246+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">EDDM</td>
247+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://www.researchgate.net/publication/245999704_Early_Drift_Detection_Method">Baena-Garcıa et al. (2006)</a></td>
230248
</tr>
231249
<tr>
232-
<td>EDDM</td>
233-
<td><a href="https://www.researchgate.net/publication/245999704_Early_Drift_Detection_Method">Baena-Garcıa et al. (2006)</a></td>
250+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
251+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
252+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">HDDM-A</td>
253+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.1109/TKDE.2014.2345382">Frias-Blanco et al. (2014)</a></td>
234254
</tr>
235255
<tr>
236-
<td>HDDM-A</td>
237-
<td><a href="https://doi.org/10.1109/TKDE.2014.2345382">Frias-Blanco et al. (2014)</a></td>
256+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
257+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
258+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">HDDM-W</td>
259+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.1109/TKDE.2014.2345382">Frias-Blanco et al. (2014)</a></td>
238260
</tr>
239261
<tr>
240-
<td>HDDM-W</td>
241-
<td><a href="https://doi.org/10.1109/TKDE.2014.2345382">Frias-Blanco et al. (2014)</a></td>
262+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
263+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
264+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">RDDM</td>
265+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.1016/j.eswa.2017.08.023">Barros et al. (2017)</a></td>
242266
</tr>
243267
<tr>
244-
<td>RDDM</td>
245-
<td><a href="https://doi.org/10.1016/j.eswa.2017.08.023">Barros et al. (2017)</a></td>
268+
<td rowspan="3" style="text-align: center; border: 1px solid grey; padding: 8px;">Window based</td>
269+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
270+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
271+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">ADWIN</td>
272+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.1137/1.9781611972771.42">Bifet and Gavalda (2007)</a></td>
246273
</tr>
247274
<tr>
248-
<td rowspan="3">Window based</td>
249-
<td>ADWIN</td>
250-
<td><a href="https://doi.org/10.1137/1.9781611972771.42">Bifet and Gavalda (2007)</a></td>
275+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
276+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
277+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">KSWIN</td>
278+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.1016/j.neucom.2019.11.111">Raab et al. (2020)</a></td>
251279
</tr>
252280
<tr>
253-
<td>KSWIN</td>
254-
<td><a href="https://doi.org/10.1016/j.neucom.2019.11.111">Raab et al. (2020)</a></td>
281+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
282+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
283+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">STEPD</td>
284+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.1007/978-3-540-75488-6_27">Nishida and Yamauchi (2007)</a></td>
255285
</tr>
256286
<tr>
257-
<td>STEPD</td>
258-
<td><a href="https://doi.org/10.1007/978-3-540-75488-6_27">Nishida and Yamauchi (2007)</a></td>
287+
<td rowspan="14" style="text-align: center; border: 1px solid grey; padding: 8px;">Data drift</td>
288+
<td rowspan="12" style="text-align: center; border: 1px solid grey; padding: 8px;">Batch</td>
289+
<td rowspan="8" style="text-align: center; border: 1px solid grey; padding: 8px;">Distance based</td>
290+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
291+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
292+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">Bhattacharyya distance</td>
293+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://www.jstor.org/stable/25047882">Bhattacharyya (1946)</a></td>
259294
</tr>
260295
<tr>
261-
<td rowspan="14">Data drift</td>
262-
<td rowspan="12">Batch</td>
263-
<td rowspan="8">Distance based</td>
264-
<td>Bhattacharyya distance</td>
265-
<td><a href="https://www.jstor.org/stable/25047882">Bhattacharyya (1946)</a></td>
296+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
297+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
298+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">Earth Mover's distance</td>
299+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.1023/A:1026543900054">Rubner et al. (2000)</a></td>
266300
</tr>
267301
<tr>
268-
<td>Earth Mover's distance</td>
269-
<td><a href="https://doi.org/10.1023/A:1026543900054">Rubner et al. (2000)</a></td>
302+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
303+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
304+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">Hellinger distance</td>
305+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.1515/CRLL.1909.136.210">Hellinger (1909)</a></td>
270306
</tr>
271307
<tr>
272-
<td>Hellinger distance</td>
273-
<td><a href="https://doi.org/10.1515/CRLL.1909.136.210">Hellinger (1909)</a></td>
308+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
309+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
310+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">Histogram intersection normalized complement</td>
311+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.1007/BF00130487">Swain and Ballard (1991)</a></td>
274312
</tr>
275313
<tr>
276-
<td>Histogram intersection normalized complement</td>
277-
<td><a href="https://doi.org/10.1007/BF00130487">Swain and Ballard (1991)</a></td>
314+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
315+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
316+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">Jensen-Shannon distance</td>
317+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.1109/18.61115">Lin (1991)</a></td>
278318
</tr>
279319
<tr>
280-
<td>Jensen-Shannon distance</td>
281-
<td><a href="https://doi.org/10.1109/18.61115">Lin (1991)</a></td>
320+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
321+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
322+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">Kullback-Leibler divergence</td>
323+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.1214/aoms/1177729694">Kullback and Leibler (1951)</a></td>
282324
</tr>
283325
<tr>
284-
<td>Kullback-Leibler divergence</td>
285-
<td><a href="https://doi.org/10.1214/aoms/1177729694">Kullback and Leibler (1951)</a></td>
326+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">M</td>
327+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
328+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">MMD</td>
329+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://dl.acm.org/doi/10.5555/2188385.2188410">Gretton et al. (2012)</a></td>
286330
</tr>
287331
<tr>
288-
<td>MMD</td>
289-
<td><a href="https://dl.acm.org/doi/10.5555/2188385.2188410">Gretton et al. (2012)</a></td>
332+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
333+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
334+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">PSI</td>
335+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.1057/jors.2008.144">Wu and Olson (2010)</a></td>
290336
</tr>
291337
<tr>
292-
<td>PSI</td>
293-
<td><a href="https://doi.org/10.1057/jors.2008.144">Wu and Olson (2010)</a></td>
338+
<td rowspan="4" style="text-align: center; border: 1px solid grey; padding: 8px;">Statistical test</td>
339+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
340+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">C</td>
341+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">Chi-square test</td>
342+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.1080/14786440009463897">Pearson (1900)</a></td>
294343
</tr>
295344
<tr>
296-
<td rowspan="4">Statistical test</td>
297-
<td>Chi-square test</td>
298-
<td><a href="https://doi.org/10.1080/14786440009463897">Pearson (1900)</a></td>
345+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
346+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
347+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">Cramér-von Mises test</td>
348+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.1080/03461238.1928.10416862">Cramér (1902)</a></td>
299349
</tr>
300350
<tr>
301-
<td>Cramér-von Mises test</td>
302-
<td><a href="https://doi.org/10.1080/03461238.1928.10416862">Cramér (1902)</a></td>
351+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
352+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
353+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">Kolmogorov-Smirnov test</td>
354+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.2307/2280095">Massey Jr (1951)</a></td>
303355
</tr>
304356
<tr>
305-
<td>Kolmogorov-Smirnov test</td>
306-
<td><a href="https://doi.org/10.2307/2280095">Massey Jr (1951)</a></td>
357+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
358+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
359+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">Welch's T-Test</td>
360+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.2307/2332510">Welch (1947)</a></td>
307361
</tr>
308362
<tr>
309-
<td>Welch's T-Test</td>
310-
<td><a href="https://doi.org/10.2307/2332510">Welch (1947)</a></td>
363+
<td rowspan="2" style="text-align: center; border: 1px solid grey; padding: 8px;">Streaming</td>
364+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">Distance based</td>
365+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">M</td>
366+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
367+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">MMD</td>
368+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://dl.acm.org/doi/10.5555/2188385.2188410">Gretton et al. (2012)</a></td>
311369
</tr>
312370
<tr>
313-
<td rowspan="2">Streaming</td>
314-
<td>Distance based</td>
315-
<td>MMD</td>
316-
<td><a href="https://dl.acm.org/doi/10.5555/2188385.2188410">Gretton et al. (2012)</a></td>
317-
</tr>
318-
<tr>
319-
<td>Statistical test</td>
320-
<td>Incremental Kolmogorov-Smirnov test</td>
321-
<td><a href="https://doi.org/10.1145/2939672.2939836">dos Reis et al. (2016)</a></td>
371+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">Statistical test</td>
372+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">U</td>
373+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">N</td>
374+
<td style="text-align: center; border: 1px solid grey; padding: 8px;">Incremental Kolmogorov-Smirnov test</td>
375+
<td style="text-align: center; border: 1px solid grey; padding: 8px;"><a href="https://doi.org/10.1145/2939672.2939836">dos Reis et al. (2016)</a></td>
322376
</tr>
323377
</tbody>
324378
</table>

0 commit comments

Comments
 (0)