tsadmetrics 0.1.15__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_binary.py

@@ -593,8 +593,40 @@ class TestAverageDetectionCount(unittest.TestCase):
         """
         pass
 
+    def setUp(self):
+        """
+        Configuración inicial para las pruebas.
+        """
+        self.y_true1 = np.array([0,0,0,0,0,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,1,1,1,1,1,1,1,1])
+        self.y_pred1 = np.array([0,0,0,0,0,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0])
+        self.y_pred2 = np.array([0,0,0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0])
+
+        self.y_true2  = np.array([0,0,0,1,1,0,0,1,1,0,0,0,0,0,0,0,0,1,1,1,1,1])
+        self.y_pred21 = np.array([0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,1,1,1])
+        self.y_pred22 = np.array([0,0,0,1,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0])
+
     
 
+    def test_average_detection_count(self):
+        """
+        Prueba para la función average_detection_count.
+        """
+        metric = round(average_detection_count(self.y_true1, self.y_pred1),2)
+        expected_metric = 0.5
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(average_detection_count(self.y_true1, self.y_pred2),2)
+        expected_metric = 0.12
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(average_detection_count(self.y_true2, self.y_pred21),2)
+        expected_metric = 0.33
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(average_detection_count(self.y_true2, self.y_pred22),2)
+        expected_metric = 0.67
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
         
     def test_average_detection_count_consistency(self):
         try:
@@ -615,9 +647,33 @@ class TestAbsoluteDetectionDistance(unittest.TestCase):
         """
         Configuración inicial para las pruebas.
         """
-        pass
+        self.y_true1 = np.array([0,0,0,0,0,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,1,1,1,1,1,1,1,1])
+        self.y_pred1 = np.array([0,0,0,0,0,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0])
+        self.y_pred2 = np.array([0,0,0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0])
 
-    
+        self.y_true2  = np.array([0,0,0,1,1,0,0,1,1,0,0,0,0,0,0,0,0,1,1,1,1,1])
+        self.y_pred21 = np.array([0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,1,1,1])
+        self.y_pred22 = np.array([0,0,0,1,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0])
+
+    def test_absolute_detection_distance(self):
+        """
+        Prueba para la función absolute_detection_distance.
+        """
+        metric = round(absolute_detection_distance(self.y_true1, self.y_pred1),2)
+        expected_metric = 0.25
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(absolute_detection_distance(self.y_true1, self.y_pred2),2)
+        expected_metric = 0.25
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(absolute_detection_distance(self.y_true2, self.y_pred21),2)
+        expected_metric = 0.06
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(absolute_detection_distance(self.y_true2, self.y_pred22),2)
+        expected_metric = 0.12
+        self.assertAlmostEqual(metric, expected_metric, places=4)
 
         
     def test_absolute_detection_distance_consistency(self):
@@ -639,7 +695,33 @@ class TestTotalDetectedInRange(unittest.TestCase):
         """
         Configuración inicial para las pruebas.
         """
-        pass
+        self.y_true1 = np.array([0,0,0,0,0,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,1,1,1,1,1,1,1,1])
+        self.y_pred1 = np.array([0,0,0,0,0,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0])
+        self.y_pred2 = np.array([0,0,0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0])
+
+        self.y_true2  = np.array([0,0,0,1,1,0,0,1,1,0,0,0,0,0,0,0,0,1,1,1,1,1])
+        self.y_pred21 = np.array([0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,1,1,1])
+        self.y_pred22 = np.array([0,0,0,1,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0])
+
+    def test_total_detected_in_range(self):
+        """
+        Prueba para la función total_detected_in_range.
+        """
+        metric = round(total_detected_in_range(self.y_true1, self.y_pred1,k=3),2)
+        expected_metric = 0.5
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(total_detected_in_range(self.y_true1, self.y_pred2,k=3),2)
+        expected_metric = 0.5
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(total_detected_in_range(self.y_true2, self.y_pred21,k=3),2)
+        expected_metric = 0.56
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(total_detected_in_range(self.y_true2, self.y_pred22,k=3),2)
+        expected_metric = 0.44
+        self.assertAlmostEqual(metric, expected_metric, places=4)
 
     
 
@@ -663,7 +745,33 @@ class TestDetectionAccuracyInRange(unittest.TestCase):
         """
         Configuración inicial para las pruebas.
         """
-        pass
+        self.y_true1 = np.array([0,0,0,0,0,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,1,1,1,1,1,1,1,1])
+        self.y_pred1 = np.array([0,0,0,0,0,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0])
+        self.y_pred2 = np.array([0,0,0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0])
+
+        self.y_true2  = np.array([0,0,0,1,1,0,0,1,1,0,0,0,0,0,0,0,0,1,1,1,1,1])
+        self.y_pred21 = np.array([0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,1,1,1])
+        self.y_pred22 = np.array([0,0,0,1,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0])
+
+    def test_detection_accuracy_in_range(self):
+        """
+        Prueba para la función detection_accuracy_in_range.
+        """
+        metric = round(detection_accuracy_in_range(self.y_true1, self.y_pred1,k=3),2)
+        expected_metric = 1.0
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(detection_accuracy_in_range(self.y_true1, self.y_pred2,k=3),2)
+        expected_metric = 1.0
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(detection_accuracy_in_range(self.y_true2, self.y_pred21,k=3),2)
+        expected_metric = 1.0
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(detection_accuracy_in_range(self.y_true2, self.y_pred22,k=3),2)
+        expected_metric = 1.0
+        self.assertAlmostEqual(metric, expected_metric, places=4)
 
     
 
@@ -688,7 +796,33 @@ class TestWeightedDetectionDifference(unittest.TestCase):
         """
         Configuración inicial para las pruebas.
         """
-        pass
+        self.y_true1 = np.array([0,0,0,0,0,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,1,1,1,1,1,1,1,1])
+        self.y_pred1 = np.array([0,0,0,0,0,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0])
+        self.y_pred2 = np.array([0,0,0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0])
+
+        self.y_true2  = np.array([0,0,0,1,1,0,0,1,1,0,0,0,0,0,0,0,0,1,1,1,1,1])
+        self.y_pred21 = np.array([0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,1,1,1])
+        self.y_pred22 = np.array([0,0,0,1,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0])
+
+    def test_weighted_detection_difference(self):
+        """
+        Prueba para la función weighted_detection_difference.
+        """
+        metric = round(weighted_detection_difference(self.y_true1, self.y_pred1,k=3),2)
+        expected_metric = 18.89
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(weighted_detection_difference(self.y_true1, self.y_pred2,k=3),2)
+        expected_metric = 24.89
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(weighted_detection_difference(self.y_true2, self.y_pred21,k=3),2)
+        expected_metric = 15.73
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(weighted_detection_difference(self.y_true2, self.y_pred22,k=3),2)
+        expected_metric = 16.73
+        self.assertAlmostEqual(metric, expected_metric, places=4)
 
     
 
@@ -712,7 +846,33 @@ class TestPATE(unittest.TestCase):
         """
         Configuración inicial para las pruebas.
         """
-        pass
+        self.y_true1 = np.array([0,0,0,0,0,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,1,1,1,1,1,1,1,1])
+        self.y_pred1 = np.array([0,0,0,0,0,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0])
+        self.y_pred2 = np.array([0,0,0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0])
+
+        self.y_true2  = np.array([0,0,0,1,1,0,0,1,1,0,0,0,0,0,0,0,0,1,1,1,1,1])
+        self.y_pred21 = np.array([0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,1,1,1])
+        self.y_pred22 = np.array([0,0,0,1,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0])
+
+    def test_binary_pate(self):
+        """
+        Prueba para la función binary_pate.
+        """
+        metric = round(binary_pate(self.y_true1, self.y_pred1,early=2, delay=2),2)
+        expected_metric = 0.67
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(binary_pate(self.y_true1, self.y_pred2,early=2, delay=2),2)
+        expected_metric = 0.27
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(binary_pate(self.y_true2, self.y_pred21,early=2, delay=2),2)
+        expected_metric = 0.71
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(binary_pate(self.y_true2, self.y_pred22,early=2, delay=2),2)
+        expected_metric = 0.62
+        self.assertAlmostEqual(metric, expected_metric, places=4)
 
     
 
@@ -737,7 +897,34 @@ class TestMeanTimeToDetect(unittest.TestCase):
         """
         Configuración inicial para las pruebas.
         """
-        pass
+        self.y_true1 = np.array([0,0,0,0,0,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,1,1,1,1,1,1,1,1])
+        self.y_pred1 = np.array([0,0,0,0,0,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0])
+        self.y_pred2 = np.array([0,0,0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0])
+
+        self.y_true2  = np.array([0,0,0,1,1,0,0,1,1,0,0,0,0,0,0,0,0,1,1,1,1,1])
+        self.y_pred21 = np.array([0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,1,1,1])
+        self.y_pred22 = np.array([0,0,0,1,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0])
+
+    def test_mean_time_to_detect(self):
+        """
+        Prueba para la función mean_time_to_detect.
+        """
+        metric = round(mean_time_to_detect(self.y_true1, self.y_pred1),2)
+        expected_metric = 0.0
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(mean_time_to_detect(self.y_true1, self.y_pred2),2)
+        expected_metric = 0.0
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(mean_time_to_detect(self.y_true2, self.y_pred21),2)
+        expected_metric = 8.0
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+
+        metric = round(mean_time_to_detect(self.y_true2, self.y_pred22),2)
+        expected_metric = 0.0
+        self.assertAlmostEqual(metric, expected_metric, places=4)
+