tsadmetrics 0.1.13__py3-none-any.whl → 0.1.14__py3-none-any.whl

tsadmetrics/binary_metrics.py

@@ -766,21 +766,21 @@ def range_based_f_score(y_true: np.array, y_pred: np.array, p_alpha: float, r_al
     
 
     Parameters:
-    y_true (np.array):
-        The ground truth binary labels for the time series data.
-    y_pred (np.array):
-        The predicted binary labels for the time series data.
-    alpha (float):
-        Relative importance of existence reward. 0 ≤ alpha ≤ 1.
-    p_bias (str):
-        Positional bias for precision. This should be "flat", "front", "middle", or "back".
-    r_bias (str):
-        Positional bias for recall. This should be "flat", "front", "middle", or "back".
-    cardinality_mode (str, optional):
-        Cardinality type. This should be "one", "reciprocal" or "udf_gamma".
-    beta (float):
-        The beta value, which determines the weight of precision in the combined score.
-        Default is 1, which gives equal weight to precision and recall.
+        y_true (np.array):
+            The ground truth binary labels for the time series data.
+        y_pred (np.array):
+            The predicted binary labels for the time series data.
+        alpha (float):
+            Relative importance of existence reward. 0 ≤ alpha ≤ 1.
+        p_bias (str):
+            Positional bias for precision. This should be "flat", "front", "middle", or "back".
+        r_bias (str):
+            Positional bias for recall. This should be "flat", "front", "middle", or "back".
+        cardinality_mode (str, optional):
+            Cardinality type. This should be "one", "reciprocal" or "udf_gamma".
+        beta (float):
+            The beta value, which determines the weight of precision in the combined score.
+            Default is 1, which gives equal weight to precision and recall.
 
     Returns:
         float: The range-based F-score, which is the harmonic mean of precision and recall, adjusted by the beta value.
@@ -1220,14 +1220,20 @@ def total_detected_in_range(y_true: np.array, y_pred: np.array, k: int):
 
     This metric measures the proportion of true anomaly events that are correctly detected.
     It is defined as:
-        TDIR = (EM + DA) / (EM + DA + MA)
+
+    .. math::
+        \\text{TDIR} = \\frac{EM + DA}{EM + DA + MA}
 
     Where:
-        EM (Exact Match)     = number of predicted anomaly segments that exactly match a true anomaly segment.
-        DA (Detected Anomaly)= number of true anomaly points not exactly matched where at least one prediction falls
-                               within a window [i-k, i+k] around the true point index i or within the true segment range.
-        FA (False Anomaly)   = number of predicted anomaly segments that do not overlap any true anomaly segment
-                               even within a k-step tolerance window around true points.
+
+    - EM (Exact Match):
+        Number of predicted anomaly segments that exactly match a true anomaly segment.
+    - DA (Detected Anomaly):
+        Number of true anomaly points not exactly matched where at least one prediction falls
+        within a window [i-k, i+k] around the true point index i or within the true segment range.
+    - MA (Missed Anomaly):
+        Number of true anomaly segments that do not overlap any predicted anomaly segment
+        even within a k-step tolerance window around true points.
 
     For more information, see the original paper:
     https://acta.sapientia.ro/content/docs/evaluation-metrics-for-anomaly-detection.pdf
@@ -1258,14 +1264,20 @@ def detection_accuracy_in_range(y_true: np.array, y_pred: np.array, k: int):
 
     This metric measures the proportion of predicted anomaly events that correspond to true anomalies.
     It is defined as:
-        DAIR = (EM + DA) / (EM + DA + FA)
+
+    .. math::
+        \\text{DAIR} = \\frac{EM + DA}{EM + DA + FA}
 
     Where:
-        EM (Exact Match)     = number of predicted anomaly segments that exactly match a true anomaly segment.
-        DA (Detected Anomaly)= number of true anomaly points not exactly matched where at least one prediction falls
-                               within a window [i-k, i+k] around the true point index i or within the true segment range.
-        FA (False Anomaly)   = number of predicted anomaly segments that do not overlap any true anomaly segment
-                               even within a k-step tolerance window around true points.
+
+    - EM (Exact Match):
+        Number of predicted anomaly segments that exactly match a true anomaly segment.
+    - DA (Detected Anomaly):
+        Number of true anomaly points not exactly matched where at least one prediction falls
+        within a window [i-k, i+k] around the true point index i or within the true segment range.
+    - FA (False Anomaly):
+        Number of predicted anomaly segments that do not overlap any true anomaly segment
+        even within a k-step tolerance window around true points.
 
     For more information, see the original paper:
     https://acta.sapientia.ro/content/docs/evaluation-metrics-for-anomaly-detection.pdf
@@ -1280,7 +1292,7 @@ def detection_accuracy_in_range(y_true: np.array, y_pred: np.array, k: int):
             time steps of a true point counts toward detection.
 
     Returns:
-        float: The total detected in range.
+        float: The detection accuracy in range score.
     """
     if np.sum(y_pred) == 0:
         return 0
@@ -1305,13 +1317,21 @@ def weighted_detection_difference(y_true: np.array, y_pred: np.array, k: int):
     not overlap any true anomaly segment (within the same extension).
 
     The final score is:
-        WDD = WS - WF*FA
+
+        .. math::
+            \\text{WDD} = \\text{WS} - \\text{WF} \\cdot \\text{FA}
 
     Where:
-        WS = Σ weights_true_predictions
-        WF = Σ weights_false_positives
-        FA (False Anomaly)   = number of predicted anomaly segments that do not overlap any true anomaly segment
-                               even within a k-step tolerance window around true points.
+
+    - WS: 
+        Sum of Gaussian weights for all predicted anomaly points that fall 
+        within any true anomaly segment (extended by delta time steps at the ends).
+    - WF:
+        Sum of Gaussian weights for all predicted anomaly points that do not 
+        overlap any true anomaly segment (within the same extension).
+    - FA (False Anomaly):
+        Number of predicted anomaly segments that do not overlap any true anomaly segment
+        even within a k-step tolerance window around true points.
 
     For more information, see the original paper:
     https://acta.sapientia.ro/content/docs/evaluation-metrics-for-anomaly-detection.pdf
@@ -1400,7 +1420,10 @@ def mean_time_to_detect(y_true: np.array, y_pred: np.array):
     For each ground-truth anomaly segment, let i be the index where the segment starts, 
     and let j ≥ i be the first index within that segment where the model predicts an anomaly.  
     The detection delay for that event is defined as:
-        Δ = j - i
+
+    .. math::
+        \Delta = j - i
+
     The MTTD is the mean of all such Δ values, one per true anomaly segment, and expresses 
     the average number of time steps between the true onset of an anomaly and its first detection.
 

{tsadmetrics-0.1.13.dist-info → tsadmetrics-0.1.14.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tsadmetrics
-Version: 0.1.13
+Version: 0.1.14
 Summary: =?unknown-8bit?q?Librer=C3=ADa_para_evaluaci=C3=B3n_de_detecci=C3=B3n_de_anomal=C3=ADas?= en series temporales
 Home-page: https://github.com/pathsko/TSADmetrics
 Author: Pedro Rafael Velasco Priego

{tsadmetrics-0.1.13.dist-info → tsadmetrics-0.1.14.dist-info}/RECORD

@@ -16,7 +16,7 @@ tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/test_binary.py,sha256=dj9BsKBo5rpWw4JGiKKoVkg4rIW4YylTie2VxH2DAGo,29787
 tests/test_non_binary.py,sha256=syANlwm0DKsL6geGeq6nQI6ZVe6T_YXWTyk2-Hmck4s,11308
 tsadmetrics/__init__.py,sha256=MTWOa43fgOdkMNo5NglCReRnB8hoF0ob2PIvDziCNHw,1575
-tsadmetrics/binary_metrics.py,sha256=UdXoITIATf585Kvz5i3xhdqEVUogrUHMmJgxj-HoeB0,62477
+tsadmetrics/binary_metrics.py,sha256=6GxE3HSiAC9OeDOpP6QFgPwbp-Q37-F3cUdyYcpRrxE,62841
 tsadmetrics/metric_utils.py,sha256=fm8v0X37_AlqWpkcUT9r3680QsjLljrHe2YuXkRLAZ4,10873
 tsadmetrics/non_binary_metrics.py,sha256=O6AqceHrjCVV1kJPBzXQIgtiu6afzoiJz2biNsxf3_4,13389
 tsadmetrics/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -53,7 +53,7 @@ tsadmetrics/_tsadeval/prts/time_series_metrics/fscore.py,sha256=pJz4iuPyVGNvwsaR
 tsadmetrics/_tsadeval/prts/time_series_metrics/precision.py,sha256=jLkcMg7UNl25SHtZUBGkP-RV8HsvaZCtjakryl7PFWU,3204
 tsadmetrics/_tsadeval/prts/time_series_metrics/precision_recall.py,sha256=OhUJSm_I7VZ_gX_SSg8AYUq3_NW9rMIy7lAVsnOFw4Q,417
 tsadmetrics/_tsadeval/prts/time_series_metrics/recall.py,sha256=LL-0pPer3ymovVRlktaHo5XDzpgiDhWOVfdPOzKR6og,3152
-tsadmetrics-0.1.13.dist-info/METADATA,sha256=k3BVjOM_Ife2-uXsEWu3o-6tRTUXUqLDd9I9NBV-61g,831
-tsadmetrics-0.1.13.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
-tsadmetrics-0.1.13.dist-info/top_level.txt,sha256=s2VIr_ePl-WZbYt9FsYbsDGM7J-Qc5cgpwEOeQ3FVpM,31
-tsadmetrics-0.1.13.dist-info/RECORD,,
+tsadmetrics-0.1.14.dist-info/METADATA,sha256=TCFL9Dpv6zwwM_5n2HeCxKgFP-KB4AHYrvCe3rMZMOI,831
+tsadmetrics-0.1.14.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
+tsadmetrics-0.1.14.dist-info/top_level.txt,sha256=s2VIr_ePl-WZbYt9FsYbsDGM7J-Qc5cgpwEOeQ3FVpM,31
+tsadmetrics-0.1.14.dist-info/RECORD,,