tsadmetrics 0.1.16__py3-none-any.whl → 0.1.17__py3-none-any.whl

docs_api/conf.py

@@ -0,0 +1,90 @@
+# Configuration file for the Sphinx documentation builder.
+#
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../'))
+
+
+project = 'TSADmetrics'
+copyright = '2025, Pedro Rafael Velasco Priego'
+author = 'Pedro Rafael Velasco Priego'
+release = 'MIT'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+
+extensions = ['sphinx.ext.duration', 'sphinx.ext.doctest', 'sphinx.ext.autodoc',]
+
+
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+html_theme = 'furo'
+html_static_path = ['_static']
+html_theme_options = {
+    #"sidebar_hide_name": True,
+    "light_css_variables": {
+        "color-brand-primary": "#2e5c7d",
+        "color-brand-content": "#2e5c7d",
+        "codebgcolor": "red",
+        "codetextcolor": "red",
+    },
+    "dark_css_variables": {
+        "color-brand-primary": "#6998b4",
+        "color-brand-content": "#6998b4",
+        "codebgcolor": "green",
+        "codetextcolor": "green",
+    },
+    "navigation_with_keys": True
+
+}
+html_baseurl = ''
+
+html_css_files = [
+    'css/custom.css',
+]
+
+epub_show_urls = 'footnote'
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+
+
+
+### -- LaTeX options -------------------------------------------------
+
+# comando para compilar: make latexpdf LATEXMKOPTS="-xelatex"
+
+latex_elements = {
+    'maxlistdepth': '10',  # Aumenta el límite de anidamiento
+    'papersize': 'a4paper',
+    'pointsize': '10pt',
+    'maketitle': r'''
+\makeatletter
+\begin{titlepage}
+\noindent\rule{\textwidth}{1pt}\\[3cm]
+\begin{center}
+{\Huge\sffamily\bfseries TSADmetrics API Reference}\\[1.5cm]
+{\Large\sffamily Time Series Anomaly Detection Metrics}\\[3cm]
+\begin{minipage}{0.8\textwidth}
+\centering
+{\large\sffamily
+\begin{tabular}{l@{\hspace{1cm}}l}
+\textbf{Autor:}      & Pedro Rafael Velasco Priego \\
+\textbf{Directores:} & Dra. Amelia Zafra Gómez \\
+                     & Dr. Sebastián Ventura Soto \\
+\end{tabular}
+}
+\end{minipage}\\[5cm]
+{\large\sffamily \@date}\\
+{\large\sffamily \copyright\ 2025 Pedro Rafael Velasco Priego}
+\end{center}
+\noindent\rule{\textwidth}{1pt}
+\end{titlepage}
+\makeatother
+''',
+}

docs_manual/conf.py

@@ -0,0 +1,90 @@
+# Configuration file for the Sphinx documentation builder.
+#
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../'))
+
+
+project = 'TSADmetrics'
+copyright = '2025, Pedro Rafael Velasco Priego'
+author = 'Pedro Rafael Velasco Priego'
+release = 'MIT'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+
+extensions = ['sphinx.ext.duration', 'sphinx.ext.doctest', 'sphinx.ext.autodoc',]
+
+
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+html_theme = 'furo'
+html_static_path = ['_static']
+html_theme_options = {
+    #"sidebar_hide_name": True,
+    "light_css_variables": {
+        "color-brand-primary": "#2e5c7d",
+        "color-brand-content": "#2e5c7d",
+        "codebgcolor": "red",
+        "codetextcolor": "red",
+    },
+    "dark_css_variables": {
+        "color-brand-primary": "#6998b4",
+        "color-brand-content": "#6998b4",
+        "codebgcolor": "green",
+        "codetextcolor": "green",
+    },
+    "navigation_with_keys": True
+
+}
+html_baseurl = ''
+
+html_css_files = [
+    'css/custom.css',
+]
+
+epub_show_urls = 'footnote'
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+
+
+
+### -- LaTeX options -------------------------------------------------
+
+# comando para compilar: make latexpdf LATEXMKOPTS="-xelatex"
+
+latex_elements = {
+    'maxlistdepth': '10',  # Aumenta el límite de anidamiento
+    'papersize': 'a4paper',
+    'pointsize': '10pt',
+    'maketitle': r'''
+\makeatletter
+\begin{titlepage}
+\noindent\rule{\textwidth}{1pt}\\[3cm]
+\begin{center}
+{\Huge\sffamily\bfseries TSADmetrics User Manual}\\[1.5cm]
+{\Large\sffamily Time Series Anomaly Detection Metrics}\\[3cm]
+\begin{minipage}{0.8\textwidth}
+\centering
+{\large\sffamily
+\begin{tabular}{l@{\hspace{1cm}}l}
+\textbf{Autor:}      & Pedro Rafael Velasco Priego \\
+\textbf{Directores:} & Dra. Amelia Zafra Gómez \\
+                     & Dr. Sebastián Ventura Soto \\
+\end{tabular}
+}
+\end{minipage}\\[5cm]
+{\large\sffamily \@date}\\
+{\large\sffamily \copyright\ 2025 Pedro Rafael Velasco Priego}
+\end{center}
+\noindent\rule{\textwidth}{1pt}
+\end{titlepage}
+\makeatother
+''',
+}

tests/test_non_binary.py

@@ -148,8 +148,7 @@ class TestAUCPRPW(unittest.TestCase):
 
 
     
-
-class TestAUCPRPA(unittest.TestCase):
+class TestAUCROCPA(unittest.TestCase):
 
     def setUp(self):
         """
@@ -189,40 +188,40 @@ class TestAUCPRPA(unittest.TestCase):
         ,0.26972245 ,0.78780138 ,0.37649185 ,0.08467683]
 
 
-    def test_auc_pr_pa(self):
+    def test_auc_roc_pa(self):
         """
         Prueba para la función auc_pr_pa.
         """
-        score = round(auc_pr_pa(self.y_true1, self.y_pred1),2)
-        expected_score = 1.0
+        score = round(auc_roc_pa(self.y_true1, self.y_pred1),2)
+        expected_score = 0.5
         self.assertAlmostEqual(score, expected_score, places=4)
 
-        score = round(auc_pr_pa(self.y_true1, self.y_pred2),2)
-        expected_score = 1.0
+        score = round(auc_roc_pa(self.y_true1, self.y_pred2),2)
+        expected_score = 0.5
         self.assertAlmostEqual(score, expected_score, places=4)
 
-        score = round(auc_pr_pa(self.y_true1, self.y_pred3),2)
-        expected_score = 0.75
+        score = round(auc_roc_pa(self.y_true1, self.y_pred3),2)
+        expected_score = 0.25
         self.assertAlmostEqual(score, expected_score, places=4)
 
         
-        score = round(auc_pr_pa(self.y_true2, self.y_pred4),2)
-        expected_score = 0.78
+        score = round(auc_roc_pa(self.y_true2, self.y_pred4),2)
+        expected_score = 0.33
         self.assertAlmostEqual(score, expected_score, places=4)
 
         
-    def test_auc_pr_pa_consistency(self):
+    def test_auc_roc_pa_consistency(self):
         y_true, y_pred = [],[]
         try:
             for _ in range(100):
                 y_true = np.random.choice([0, 1], size=(100,))
                 y_pred = np.random.random( size=(100,))
-                score = auc_pr_pa(y_true, y_pred)
+                score = auc_roc_pa(y_true, y_pred)
         except Exception as e:
-            self.fail(f"auc_roc_pr_pa raised an exception {e}")
-            
+            self.fail(f"auc_roc_pa raised an exception {e}")
 
-class TestAUCPRSW(unittest.TestCase):
+
+class TestAUCPRPA(unittest.TestCase):
 
     def setUp(self):
         """
@@ -237,34 +236,65 @@ class TestAUCPRSW(unittest.TestCase):
         self.y_pred2 = np.array([1, 2, 3, 4])
 
         self.y_pred3 = np.array([4, 4, 4, 4])
-    
 
-    def test_auc_pr_sw(self):
+        self.y_true2 = np.array([0,1,1,0,0,0,0,0,1,1,0,0,0,0,1,0,0,0,0,1,1,1,1,1,1,1,1,0,0,0,0,1,0,0,1,1,0
+        ,1,1,1,0,0,1,0,0,1,0,1,1,0,0,1,0,0,0,0,1,0,0,0,0,1,0,0,1,0,1,1,1,1,1,0,1,1
+        ,1,1,1,1,0,0,1,1,1,1,0,1,0,0,1,1,1,0,0,1,0,0,1,0,1,1])
+
+
+        self.y_pred4 = [0.1280475, 0.12059283 ,0.29936968 ,0.85866402 ,0.74071874 ,0.22310849
+        ,0.11281839 ,0.26133246 ,0.33696106 ,0.01442675 ,0.51962876 ,0.07828833
+        ,0.45337844 ,0.09444483 ,0.91216588 ,0.18847595 ,0.26828481 ,0.65248919
+        ,0.46291981 ,0.43730757 ,0.78087553 ,0.45031043 ,0.88661033 ,0.56209352
+        ,0.45029423 ,0.17638205 ,0.9261279 ,0.58830652 ,0.01602648 ,0.73903379
+        ,0.61831379 ,0.74779903 ,0.42682106 ,0.82583519 ,0.19709012 ,0.44925962
+        ,0.62752415 ,0.52458327 ,0.46291768 ,0.33937527 ,0.34868777 ,0.12293847
+        ,0.84477504 ,0.10225254 ,0.37048167 ,0.04476031 ,0.36680499 ,0.11346155
+        ,0.10583112 ,0.09493136 ,0.54878736 ,0.68514489 ,0.5940307 ,0.14526962
+        ,0.69385728 ,0.38888727 ,0.61495304 ,0.06795402 ,0.02894603 ,0.08293609
+        ,0.22865685 ,0.63531487 ,0.97966126 ,0.31418622 ,0.8943095 ,0.22974177
+        ,0.94402929 ,0.13140625 ,0.80539267 ,0.40160344 ,0.38151339 ,0.65011626
+        ,0.71657942 ,0.93297398 ,0.32043329 ,0.54667941 ,0.90645979 ,0.98730183
+        ,0.82351336 ,0.10404812 ,0.6962921 ,0.72890752 ,0.49700666 ,0.47461103
+        ,0.59696079 ,0.85876179 ,0.247344 ,0.38187879 ,0.23906861 ,0.5266315
+        ,0.08171512 ,0.27903375 ,0.61112439 ,0.20784267 ,0.90652453 ,0.87575255
+        ,0.26972245 ,0.78780138 ,0.37649185 ,0.08467683]
+
+
+    def test_auc_pr_pa(self):
         """
-        Prueba para la función auc_pr_sw.
+        Prueba para la función auc_pr_pa.
         """
-        score = round(auc_pr_sw(self.y_true1, self.y_pred1),2)
+        score = round(auc_pr_pa(self.y_true1, self.y_pred1),2)
         expected_score = 1.0
         self.assertAlmostEqual(score, expected_score, places=4)
 
-        score = round(auc_pr_sw(self.y_true1, self.y_pred2),2)
-        expected_score = 1
+        score = round(auc_pr_pa(self.y_true1, self.y_pred2),2)
+        expected_score = 1.0
         self.assertAlmostEqual(score, expected_score, places=4)
 
-        score = round(auc_pr_sw(self.y_true1, self.y_pred3),2)
-        expected_score = 1
+        score = round(auc_pr_pa(self.y_true1, self.y_pred3),2)
+        expected_score = 0.75
         self.assertAlmostEqual(score, expected_score, places=4)
 
         
-    # def test_auc_pr_sw_consistency(self):
-    #     try:
-    #         for _ in range(100):
-    #             y_true = np.random.choice([0, 1], size=(100,))
-    #             y_pred = np.random.random( size=(100,))
-
-    #             score = auc_pr_sw(y_true, y_pred)
-    #     except Exception as e:
-    #         self.fail(f"auc_pr_sw raised an exception {e}")
+        score = round(auc_pr_pa(self.y_true2, self.y_pred4),2)
+        expected_score = 0.78
+        self.assertAlmostEqual(score, expected_score, places=4)
+
+        
+    def test_auc_pr_pa_consistency(self):
+        y_true, y_pred = [],[]
+        try:
+            for _ in range(100):
+                y_true = np.random.choice([0, 1], size=(100,))
+                y_pred = np.random.random( size=(100,))
+                score = auc_pr_pa(y_true, y_pred)
+        except Exception as e:
+            self.fail(f"auc_roc_pr_pa raised an exception {e}")
+            
+
+
 
 
 class TestVUSROC(unittest.TestCase):

tsadmetrics/__init__.py

@@ -18,4 +18,4 @@ __all__ = ['point_wise_recall', 'point_wise_precision', 'point_wise_f_score','po
                 'affiliation_based_recall','affiliation_based_precision','affiliation_based_f_score','nab_score','temporal_distance',
                 'average_detection_count','absolute_detection_distance','total_detected_in_range','detection_accuracy_in_range','weighted_detection_difference',
                 'binary_pate','real_pate','mean_time_to_detect',
-                'precision_at_k','auc_roc_pw','auc_pr_pw','auc_pr_pa','auc_pr_sw','vus_roc','vus_pr', 'compute_metrics', 'compute_metrics_from_file']
+                'precision_at_k','auc_roc_pw','auc_pr_pw','auc_roc_pa','auc_pr_pa','vus_roc','vus_pr', 'compute_metrics', 'compute_metrics_from_file']

tsadmetrics/non_binary_metrics.py

@@ -84,6 +84,91 @@ def auc_pr_pw(y_true : np.array ,y_anomaly_scores:  np.array):
     return m.get_score()
 
 
+def auc_roc_pa(y_true: np.array, y_anomaly_scores: np.array):
+    """
+    Calculate the AUC-ROC score using point-adjusted evaluation for anomaly detection in time series.
+
+    This is the standard Area Under the Receiver Operating Characteristic Curve (AUC-ROC), but instead 
+    of computing true positive rate (TPR) and false positive rate (FPR) point-wise, it uses a point-adjusted 
+    approach. Specifically, for each ground-truth anomalous segment, if at least one point within that 
+    segment is predicted as anomalous, the entire segment is considered correctly detected. The adjusted 
+    predictions are then compared to the ground-truth labels to compute true positives, false positives, 
+    and false negatives, which are used to construct the ROC curve.
+
+    Implementation of https://link.springer.com/article/10.1007/s10618-023-00988-8
+
+    Parameters:
+        y_true (np.array):
+            Ground-truth binary labels for the time series (0 = normal, 1 = anomaly).
+        y_anomaly_scores (np.array):
+            Continuous anomaly scores assigned to each point in the series.
+
+    Returns:
+        float: AUC-ROC score (with point-adjusted evaluation).
+    """
+    validate_non_binary_inputs(y_true, y_anomaly_scores)
+    
+    tprs = [0]
+    fprs = [0]
+    tps, fps, fns = [], [], []
+
+    p_adj = PointAdjust(len(y_true), y_true, (np.array(y_anomaly_scores) >= 0.5).astype(int))
+    segments = p_adj.get_gt_anomalies_segmentwise()
+    idx = np.argsort(y_anomaly_scores)[::-1].astype(int)
+    y_true_sorted = np.array(y_true)[idx]
+    y_anomaly_scores_sorted = np.array(y_anomaly_scores)[idx]
+    
+    segment_mins = []
+    for start, end in segments:
+        anoms_scores = y_anomaly_scores[start:end+1]
+        segment_mins.append([np.max(anoms_scores), end-start+1])
+
+    for i_t in range(len(y_anomaly_scores_sorted)):
+        fp, tp, fn = 0, 0, 0
+        if i_t > 0 and y_anomaly_scores_sorted[i_t] == y_anomaly_scores_sorted[i_t-1]:
+            tp = tps[-1]
+            fp = fps[-1]
+            fn = fns[-1]
+        else:
+            if y_true_sorted[i_t] == 0:
+                # FP
+                if len(fps) == 0:
+                    aux_y_pred = (y_anomaly_scores >= y_anomaly_scores_sorted[i_t]).astype(int)
+                    for i in range(len(aux_y_pred)):
+                        if aux_y_pred[i] == 1 and y_true[i] == 0:
+                            fp += 1
+                else:
+                    fp = fps[i_t-1] + 1
+            else:
+                if len(fps) == 0:
+                    aux_y_pred = (y_anomaly_scores >= y_anomaly_scores_sorted[i_t]).astype(int)
+                    for i in range(len(aux_y_pred)):
+                        if aux_y_pred[i] == 1 and y_true[i] == 0:
+                            fp += 1
+                else:
+                    fp = fps[i_t-1]
+            for score, length in segment_mins:
+                if score >= y_anomaly_scores_sorted[i_t]:
+                    # TP
+                    tp += length
+                else:
+                    # FN
+                    fn += length
+        tps.append(tp)
+        fns.append(fn)
+        fps.append(fp)
+    for tp, fp, fn in zip(tps, fps, fns):
+        if tp + fn > 0:
+            tprs.append(tp / (tp + fn))
+        else:
+            tprs.append(0)
+        if fp + (len(y_true) - np.sum(y_true)) > 0:
+            fprs.append(fp / (fp + (len(y_true) - np.sum(y_true))))
+        else:
+            fprs.append(0)
+    
+    auc_value = auc(fprs, tprs)
+    return auc_value
 
 def auc_pr_pa(y_true: np.array, y_anomaly_scores: np.array):
     """
@@ -178,117 +263,6 @@ def auc_pr_pa(y_true: np.array, y_anomaly_scores: np.array):
 
 
 
-def auc_pr_sw(y_true: np.array, y_anomaly_scores: np.array):
-    """
-    Calculate the AUC-PR score using segment-wise evaluation for anomaly detection in time series.
-
-    This is the standard Area Under the Precision-Recall Curve (AUC-PR), but it uses a segment-wise 
-    adjustment when computing precision and recall. In this evaluation, each contiguous segment of 
-    anomalous ground-truth points is treated as a single unit. A true positive is counted if at least 
-    one predicted anomaly overlaps with the segment. A false negative occurs when a segment is 
-    completely missed, and a false positive is recorded for each predicted anomalous segment 
-    that does not overlap with any ground-truth anomaly. These adjusted counts are then used 
-    to compute precision and recall for constructing the PR curve.
-
-    Implementation of https://link.springer.com/article/10.1007/s10618-023-00988-8
-
-    Parameters:
-        y_true (np.array):
-            Ground-truth binary labels for the time series (0 = normal, 1 = anomaly).
-        y_anomaly_scores (np.array):
-            Continuous anomaly scores assigned to each point in the series.
-
-    Returns:
-        float: AUC-PR score (with segment-wise evaluation).
-    """
-    validate_non_binary_inputs(y_true, y_anomaly_scores)
-
-    precisions = [1]
-    recalls = [0]
-    tps,fps,fns = [],[],[]
-
-
-    segments = []
-    i=0
-    while i < len(y_true):
-        if y_true[i] == 1:
-            start = i
-            end = i
-            while i < len(y_true) and y_true[i] == 1:
-                end = i
-                i += 1
-            segments.append([start,end])
-        i+=1
-    idx = np.argsort(y_anomaly_scores)[::-1].astype(int)
-    y_anomaly_scores_sorted = np.array(y_anomaly_scores)[idx]
-    
-    segment_mins = []
-    for start,end in segments:
-        anoms_scores = y_anomaly_scores[start:end+1]
-        segment_mins.append([np.max(anoms_scores),[start,end]])
-
-    for i_t in range(len(y_anomaly_scores_sorted)):
-        fp,tp,fn = 0,0,0
-        
-            
-        aux_y_pred = (y_anomaly_scores >= y_anomaly_scores_sorted[i_t]).astype(int) 
-        for score,seg in segment_mins:
-            start,end = seg
-            if score >= y_anomaly_scores_sorted[i_t]:
-                #TP
-                tp+= 1
-                if aux_y_pred[start]== 1:
-                    # Extender hacia la izquierda
-                    i = start - 1
-                    while i >= 0 and aux_y_pred[i] == 1:
-                        aux_y_pred[i] = 0
-                        i -= 1
-                
-                if aux_y_pred[end] == 1:
-                    # Extender hacia la derecha
-                    i = end + 1
-                    while i < len(aux_y_pred) and aux_y_pred[i] == 1:
-                        aux_y_pred[i] = 0
-                        i += 1
-                aux_y_pred[start:end+1] = 0
-
-            else:
-                #FN
-                fn+= 1
-        
-        if np.sum(aux_y_pred)>0:
-            fpsegments = []
-            i=0
-            while i < len(aux_y_pred):
-                if aux_y_pred[i] == 1:
-                    start = i
-                    end = i
-                    while i < len(aux_y_pred) and aux_y_pred[i] == 1:
-                        end = i
-                        i += 1
-                    fpsegments.append([start,end])
-                i+=1
-            fp = len(fpsegments)
-        else:
-            fp = 0
-            
-            
-        tps.append(tp)
-        fns.append(fn)
-        fps.append(fp)
-    for tp,fp,fn in zip(tps,fps,fns):
-        if tp>0:
-            precisions.append(tp/(tp+fp))
-            recalls.append(tp/(tp+fn))
-        else:
-            precisions.append(0)
-            recalls.append(0)    
-      
-    
-
-    auc_value = auc(recalls, precisions)
-
-    return auc_value
 
 
 def vus_roc(y_true : np.array ,y_anomaly_scores:  np.array, window=4):

tsadmetrics/utils.py

@@ -61,8 +61,10 @@ def compute_metrics_from_file(results_file: str, conf_file: str, output_dir: str
     Computes metrics based on prediction results from a CSV file and configuration from a JSON file.
 
     Parameters:
-        results_file (str): Path to CSV file containing y_true and y_pred columns.
-        conf_file (str): Path to JSON configuration file with metrics and parameters.
+        results_file (str):
+            Path to CSV file containing y_true and y_pred columns.
+        conf_file (str):
+            Path to JSON configuration file with metrics and parameters.
 
     Returns:
         pd.DataFrame: DataFrame with computed metrics.

tsadmetrics-0.1.17.dist-info/METADATA

@@ -0,0 +1,54 @@
+Metadata-Version: 2.1
+Name: tsadmetrics
+Version: 0.1.17
+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
+Author-email: Pedro Rafael Velasco Priego <i12veprp@uco.es>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: joblib (==1.4.2)
+Requires-Dist: numpy (==1.24.4)
+Requires-Dist: pandas (==2.0.3)
+Requires-Dist: PATE (==0.1.1)
+Requires-Dist: patsy (==0.5.6)
+Requires-Dist: python-dateutil (==2.9.0.post0)
+Requires-Dist: pytz (==2024.1)
+Requires-Dist: scikit-learn (==1.3.2)
+Requires-Dist: scipy (==1.10.1)
+Requires-Dist: six (==1.16.0)
+Requires-Dist: statsmodels (==0.14.1)
+Requires-Dist: threadpoolctl (==3.5.0)
+Requires-Dist: tzdata (==2024.1)
+
+# TSADmetrics - Time Series Anomaly Detection Metrics
+
+**TSADmetrics** is a Python library for evaluating anomaly detection algorithms in time series data. It provides a comprehensive set of binary and non-binary metrics designed specifically for the challenges of anomaly detection in temporal contexts.
+
+## Features
+
+- **Binary Metrics**: Evaluate discrete anomaly predictions (0/1 labels)
+
+- **Non-Binary Metrics**: Assess continuous anomaly scores
+
+- **Efficient Computation**: Compute multiple metrics at once
+
+- **CLI Tool**: Evaluate metrics directly from CSV/JSON files
+
+## Installation
+
+Install TSADmetrics via pip:
+
+```bash
+pip install tsadmetrics
+```
+
+## Documentation
+
+The complete documentation for TSADmetrics is available at:  
+���� [https://tsadmetrics.readthedocs.io/](https://tsadmetrics.readthedocs.io/)
+
+## Acknowledgements
+
+This library is based on the concepts and implementations from:  
+S��rb��, S., & Ruocco, M. (2023). *Navigating the metric maze: a taxonomy of evaluation metrics for anomaly detection in time series*. https://doi.org/10.1007/s10618-023-00988-8

{tsadmetrics-0.1.16.dist-info → tsadmetrics-0.1.17.dist-info}/RECORD

@@ -1,4 +1,6 @@
 docs/conf.py,sha256=UvAyr0jPk75vQyREMEG3TIs96Pk-hslOgLQUpySp2tw,1645
+docs_api/conf.py,sha256=Ba8bUV-53VLgJ93hOesXr1xzLMpXlATnyZYlmyoM85g,2333
+docs_manual/conf.py,sha256=uUY57MH63QsFLhn_W7LIbwMMQO3rcdUxhCAdzx_d0Z0,2331
 entorno/bin/activate_this.py,sha256=45dnJsdtOWIt5LtVSBmBfB8E7AlKcnhnZe9e3WGclak,1199
 entorno/bin/rst2html.py,sha256=h4RydG-iAectsUra0lNFGwB4_1mngxrtPPgQrxUWQ3A,643
 entorno/bin/rst2html4.py,sha256=Xiv3Zb1gk4jT7DYFVlf5w4LJtI5ZI3pW3b1KLxyPS5A,765
@@ -14,14 +16,14 @@ entorno/bin/rst2xml.py,sha256=uoIfpn3prnir2tzqdycsAjOg-OWw663XOK47IeHCZdY,651
 entorno/bin/rstpep2html.py,sha256=sthYQHEgYfj4JqwG45URwVbRAs-HYuwKget7SUwp9fc,719
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/test_binary.py,sha256=Qt14fP-F-TW6KlPz6X-2DhtFpaHNrODiMA2DI39JrBI,39311
-tests/test_non_binary.py,sha256=NLXnSvzu5hqsCSlPhNE2IJdE-r-YZv4I7iCCBiYrrsc,13962
+tests/test_non_binary.py,sha256=jBn3GfBpbK7ktIS9FNIeYi0ob8jkkbMCyCX7-_8LI-k,15755
 tests/test_utils.py,sha256=8Favmlyix1YaAm03XuzMfEjLnq_Ud0YV_6aFwsIMpl8,2192
-tsadmetrics/__init__.py,sha256=Qg5AvsmzqC3vhNC2WmRpHx4MYrmNBjnXjou9V-WfwE4,1603
+tsadmetrics/__init__.py,sha256=BxSqvH0NselzEIZhw4rpnUh6UkzRh0eDpkNvChqWv_8,1604
 tsadmetrics/binary_metrics.py,sha256=PiecIZ2z2B3-uCx1H3KXfLXdSIu8vxY5sUsIb2vmobk,69729
 tsadmetrics/metric_utils.py,sha256=1nuHQp5fc7whPMfJTfWmKb6XmSngoe6p7fdsoP0Vz-I,2876
-tsadmetrics/non_binary_metrics.py,sha256=oCpRQhHmbauXoYMWD3cuI1eycoTOwyfoOKA2D-UQHeM,14545
+tsadmetrics/non_binary_metrics.py,sha256=FsXRMeZIvQsEP5BLT02nW7_yjDnF9wD-h8h-B6eTRVs,14238
 tsadmetrics/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tsadmetrics/utils.py,sha256=TiOFwPNBgWWFCIwOO0BPFr5alRABhj597jsmevUjx54,4889
+tsadmetrics/utils.py,sha256=mu49QEftRI4HEXvjfiE_CnsujgiNd62U9DRWCEvtO9M,4913
 tsadmetrics/validation.py,sha256=fseGfpGhN-3zAMo2WZLxahcOAsOOyBb2RAFRDKB1KI8,1340
 tsadmetrics/_tsadeval/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tsadmetrics/_tsadeval/auc_roc_pr_plot.py,sha256=PHqJUXq2qI248XV9o04D8SsUJgowetaKq0Cu5bYrIAE,12689
@@ -57,8 +59,8 @@ tsadmetrics/_tsadeval/prts/time_series_metrics/precision_recall.py,sha256=OhUJSm
 tsadmetrics/_tsadeval/prts/time_series_metrics/recall.py,sha256=LL-0pPer3ymovVRlktaHo5XDzpgiDhWOVfdPOzKR6og,3152
 tsadmetrics/scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tsadmetrics/scripts/compute_metrics.py,sha256=PwtH6XmpKEWwdY62pMfZGrgIBTIms0z3qVpw5LjnuwE,991
-tsadmetrics-0.1.16.dist-info/METADATA,sha256=inUh6ZZm5fg0cpluGAHUR1ULoN4WP480ZjZ9MNuWxAo,831
-tsadmetrics-0.1.16.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
-tsadmetrics-0.1.16.dist-info/entry_points.txt,sha256=fnsO232FxrQC6pmeZnyZ4UaiXyvN1rKxksLKQO9n7q8,81
-tsadmetrics-0.1.16.dist-info/top_level.txt,sha256=s2VIr_ePl-WZbYt9FsYbsDGM7J-Qc5cgpwEOeQ3FVpM,31
-tsadmetrics-0.1.16.dist-info/RECORD,,
+tsadmetrics-0.1.17.dist-info/METADATA,sha256=Lcjim8NZYuZ-WRBosqpYy_CISaVXF2SOZ7dI-RjoiVI,1936
+tsadmetrics-0.1.17.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
+tsadmetrics-0.1.17.dist-info/entry_points.txt,sha256=fnsO232FxrQC6pmeZnyZ4UaiXyvN1rKxksLKQO9n7q8,81
+tsadmetrics-0.1.17.dist-info/top_level.txt,sha256=jFJiGEaMZwBStgmkeS19H9fyWDDcPDgmNjinjVrh0jk,52
+tsadmetrics-0.1.17.dist-info/RECORD,,

{tsadmetrics-0.1.16.dist-info → tsadmetrics-0.1.17.dist-info}/top_level.txt

@@ -1,4 +1,6 @@
 docs
+docs_api
+docs_manual
 entorno
 tests
 tsadmetrics

tsadmetrics-0.1.16.dist-info/METADATA

@@ -1,23 +0,0 @@
-Metadata-Version: 2.1
-Name: tsadmetrics
-Version: 0.1.16
-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
-Author-email: Pedro Rafael Velasco Priego <i12veprp@uco.es>
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: joblib (==1.4.2)
-Requires-Dist: numpy (==1.24.4)
-Requires-Dist: pandas (==2.0.3)
-Requires-Dist: PATE (==0.1.1)
-Requires-Dist: patsy (==0.5.6)
-Requires-Dist: python-dateutil (==2.9.0.post0)
-Requires-Dist: pytz (==2024.1)
-Requires-Dist: scikit-learn (==1.3.2)
-Requires-Dist: scipy (==1.10.1)
-Requires-Dist: six (==1.16.0)
-Requires-Dist: statsmodels (==0.14.1)
-Requires-Dist: threadpoolctl (==3.5.0)
-Requires-Dist: tzdata (==2024.1)
-