Skip to content

Commit c23e3c9

Browse files
Add missing note in HDDMA and HDDMW docstring
1 parent 5fec98e commit c23e3c9

File tree

1 file changed

+6
-0
lines changed
  • frouros/detectors/concept_drift/streaming/statistical_process_control

1 file changed

+6
-0
lines changed

frouros/detectors/concept_drift/streaming/statistical_process_control/hddm.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -346,6 +346,9 @@ class HDDMA(BaseSPC):
346346
:param callbacks: callbacks, defaults to None
347347
:type callbacks: Optional[Union[BaseCallbackStreaming, List[BaseCallbackStreaming]]]
348348
349+
:Note:
350+
:func:`update` method expects to receive a value of 0 if the instance is correctly classified (no error) and 1 otherwise (error).
351+
349352
:References:
350353
351354
.. [frias2014online] Frias-Blanco, Isvani, et al.
@@ -663,6 +666,9 @@ class HDDMW(BaseSPC):
663666
:param callbacks: callbacks, defaults to None
664667
:type callbacks: Optional[Union[BaseCallbackStreaming, List[BaseCallbackStreaming]]]
665668
669+
:Note:
670+
:func:`update` method expects to receive a value of 0 if the instance is correctly classified (no error) and 1 otherwise (error).
671+
666672
:References:
667673
668674
.. [frias2014online] Frias-Blanco, Isvani, et al.

0 commit comments

Comments
 (0)