Replace index with step word in API examples

Author: jaime-cespedes-sisniega

frouros/detectors/concept_drift/streaming/change_detection/bocd.py

@@ -208,9 +208,9 @@ class BOCD(BaseChangeDetection):
     >>> for i, value in enumerate(stream):
     ...     _ = detector.update(value=value)
     ...     if detector.drift:
-    ...         print(f"Change detected at index {i}")
+    ...         print(f"Change detected at step {i}")
     ...         break
-    Change detected at index 1031
+    Change detected at step 1031
     """  # noqa: E501
 
     config_type = BOCDConfig  # type: ignore

frouros/detectors/concept_drift/streaming/change_detection/cusum.py

@@ -67,9 +67,9 @@ class CUSUM(BaseCUSUM):
     >>> for i, value in enumerate(stream):
     ...     _ = detector.update(value=value)
     ...     if detector.drift:
-    ...         print(f"Change detected at index {i}")
+    ...         print(f"Change detected at step {i}")
     ...         break
-    Change detected at index 1086
+    Change detected at step 1086
     """  # noqa: E501
 
     config_type = CUSUMConfig  # type: ignore

frouros/detectors/concept_drift/streaming/change_detection/geometric_moving_average.py

@@ -67,9 +67,9 @@ class GeometricMovingAverage(BaseCUSUM):
     >>> for i, value in enumerate(stream):
     ...     _ = detector.update(value=value)
     ...     if detector.drift:
-    ...         print(f"Change detected at index {i}")
+    ...         print(f"Change detected at step {i}")
     ...         break
-    Change detected at index 1071
+    Change detected at step 1071
     """  # noqa: E501
 
     config_type = GeometricMovingAverageConfig  # type: ignore

frouros/detectors/concept_drift/streaming/change_detection/page_hinkley.py

@@ -70,9 +70,9 @@ class PageHinkley(BaseCUSUM):
     >>> for i, value in enumerate(stream):
     ...     _ = detector.update(value=value)
     ...     if detector.drift:
-    ...         print(f"Change detected at index {i}")
+    ...         print(f"Change detected at step {i}")
     ...         break
-    Change detected at index 1094
+    Change detected at step 1094
     """  # noqa: E501
 
     config_type = PageHinkleyConfig  # type: ignore

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

@@ -74,13 +74,13 @@ class DDM(BaseSPCError):
     >>> for i, value in enumerate(stream):
     ...     _ = detector.update(value=value)
     ...     if detector.drift:
-    ...         print(f"Change detected at index {i}")
+    ...         print(f"Change detected at step {i}")
     ...         break
     ...     if not warning_flag and detector.warning:
-    ...         print(f"Warning detected at index {i}")
+    ...         print(f"Warning detected at step {i}")
     ...         warning_flag = True
-    Warning detected at index 1049
-    Change detected at index 1131
+    Warning detected at step 1049
+    Change detected at step 1131
     """  # noqa: E501
 
     config_type = DDMConfig

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

@@ -160,13 +160,13 @@ class EDDM(BaseSPC):
     >>> for i, value in enumerate(stream):
     ...     _ = detector.update(value=value)
     ...     if detector.drift:
-    ...         print(f"Change detected at index {i}")
+    ...         print(f"Change detected at step {i}")
     ...         break
     ...     if not warning_flag and detector.warning:
-    ...         print(f"Warning detected at index {i}")
+    ...         print(f"Warning detected at step {i}")
     ...         warning_flag = True
-    Warning detected at index 39
-    Change detected at index 1294
+    Warning detected at step 39
+    Change detected at step 1294
     """  # noqa: E501
 
     config_type = EDDMConfig  # type: ignore

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

@@ -369,13 +369,13 @@ class HDDMA(BaseSPC):
     >>> for i, value in enumerate(stream):
     ...     _ = detector.update(value=value)
     ...     if detector.drift:
-    ...         print(f"Change detected at index {i}")
+    ...         print(f"Change detected at step {i}")
     ...         break
     ...     if not warning_flag and detector.warning:
-    ...         print(f"Warning detected at index {i}")
+    ...         print(f"Warning detected at step {i}")
     ...         warning_flag = True
-    Warning detected at index 1043
-    Change detected at index 1054
+    Warning detected at step 1043
+    Change detected at step 1054
     """  # noqa: E501
 
     config_type = HDDMAConfig  # type: ignore
@@ -689,13 +689,13 @@ class HDDMW(BaseSPC):
     >>> for i, value in enumerate(stream):
     ...     _ = detector.update(value=value)
     ...     if detector.drift:
-    ...         print(f"Change detected at index {i}")
+    ...         print(f"Change detected at step {i}")
     ...         break
     ...     if not warning_flag and detector.warning:
-    ...         print(f"Warning detected at index {i}")
+    ...         print(f"Warning detected at step {i}")
     ...         warning_flag = True
-    Warning detected at index 1017
-    Change detected at index 1029
+    Warning detected at step 1017
+    Change detected at step 1029
     """  # noqa: E501
 
     config_type = HDDMWConfig  # type: ignore

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

@@ -137,13 +137,13 @@ class RDDM(BaseSPCError):
     >>> for i, value in enumerate(stream):
     ...     _ = detector.update(value=value)
     ...     if detector.drift:
-    ...         print(f"Change detected at index {i}")
+    ...         print(f"Change detected at step {i}")
     ...         break
     ...     if not warning_flag and detector.warning:
-    ...         print(f"Warning detected at index {i}")
+    ...         print(f"Warning detected at step {i}")
     ...         warning_flag = True
-    Warning detected at index 1036
-    Change detected at index 1066
+    Warning detected at step 1036
+    Change detected at step 1066
     """  # noqa: E501
 
     config_type = RDDMConfig  # type: ignore

frouros/detectors/concept_drift/streaming/window_based/adwin.py

@@ -301,9 +301,9 @@ class ADWIN(BaseWindow):
     >>> for i, value in enumerate(stream):
     ...     _ = detector.update(value=value)
     ...     if detector.drift:
-    ...         print(f"Change detected at index {i}")
+    ...         print(f"Change detected at step {i}")
     ...         break
-    Change detected at index 1055
+    Change detected at step 1055
     """  # noqa: E501
 
     config_type = ADWINConfig

frouros/detectors/concept_drift/streaming/window_based/kswin.py

@@ -123,9 +123,9 @@ class KSWIN(BaseWindow):
     >>> for i, value in enumerate(stream):
     ...     _ = detector.update(value=value)
     ...     if detector.drift:
-    ...         print(f"Change detected at index {i}")
+    ...         print(f"Change detected at step {i}")
     ...         break
-    Change detected at index 1016
+    Change detected at step 1016
     """  # noqa: E501
 
     config_type = KSWINConfig