| <!DOCTYPE html> |
|
|
| <html lang="en" data-content_root="./"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
|
|
| <title>CUSUM — AIM-CU 1.0.0 documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" /> |
| <link rel="stylesheet" type="text/css" href="_static/basic.css?v=d35aba6c" /> |
| <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=0ca6144b" /> |
| <script src="_static/documentation_options.js?v=8d563738"></script> |
| <script src="_static/doctools.js?v=9bcbadda"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="ARLTheoretical" href="ref_theoretical.html" /> |
| <link rel="prev" title="Methods" href="ref_method.html" /> |
| |
| <link rel="stylesheet" href="_static/custom.css" type="text/css" /> |
| |
|
|
| |
| |
|
|
| </head><body> |
| |
|
|
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| |
|
|
| <div class="body" role="main"> |
| |
| <section id="module-package.cusum"> |
| <span id="cusum"></span><h1>CUSUM<a class="headerlink" href="#module-package.cusum" title="Link to this heading">¶</a></h1> |
| <p>Cumulative Sum (CUSUM)</p> |
| <p>@author: smriti.prathapan</p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="package.cusum.CUSUM"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">package.cusum.</span></span><span class="sig-name descname"><span class="pre">CUSUM</span></span><a class="headerlink" href="#package.cusum.CUSUM" title="Link to this definition">¶</a></dt> |
| <dd><p>CUSUM class and its functionalities.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="package.cusum.CUSUM.change_detection"> |
| <span class="sig-name descname"><span class="pre">change_detection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">normalized_ref_value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">normalized_threshold</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">4</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#package.cusum.CUSUM.change_detection" title="Link to this definition">¶</a></dt> |
| <dd><p>Detects a change in the process.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>pre_change_days</strong> (<em>int</em>) – Number of days for in-control phase.</p></li> |
| <li><p><strong>normalized_ref_value</strong> (<em>float</em><em>, </em><em>optional</em>) – Normalized reference value for detecting a unit standard deviation change in mean of the process. Defaults to 0.5.</p></li> |
| <li><p><strong>normalized_threshold</strong> (<em>float</em><em>, </em><em>optional</em>) – Normalized threshold. Defaults to 4.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
|
|
| <dl class="py method"> |
| <dt class="sig sig-object py" id="package.cusum.CUSUM.compute_cusum"> |
| <span class="sig-name descname"><span class="pre">compute_cusum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mu_0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#package.cusum.CUSUM.compute_cusum" title="Link to this definition">¶</a></dt> |
| <dd><p>Compute CUSUM for the observations in x</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>x</strong> (<em>list</em><em>[</em><em>float</em><em>]</em>) – Performance metric to be monitored</p></li> |
| <li><p><strong>mu_0</strong> (<em>float</em>) – In-control mean of the observations/performance metric</p></li> |
| <li><p><strong>k</strong> (<em>float</em>) – Reference value related to the magnitude of change that one is interested in detecting</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Positive cumulative sum, negative cumulative sum, and CUSUM</p> |
| </dd> |
| <dt class="field-odd">Return type<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>tuple[list[float], list[float], list[float]]</p> |
| </dd> |
| </dl> |
| </dd></dl> |
|
|
| <dl class="py method"> |
| <dt class="sig sig-object py" id="package.cusum.CUSUM.initialize"> |
| <span class="sig-name descname"><span class="pre">initialize</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#package.cusum.CUSUM.initialize" title="Link to this definition">¶</a></dt> |
| <dd><p>Initialize with the configuration file.</p> |
| </dd></dl> |
|
|
| <dl class="py method"> |
| <dt class="sig sig-object py" id="package.cusum.CUSUM.plot_cusum_plotly"> |
| <span class="sig-name descname"><span class="pre">plot_cusum_plotly</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Figure</span></span></span><a class="headerlink" href="#package.cusum.CUSUM.plot_cusum_plotly" title="Link to this definition">¶</a></dt> |
| <dd><p>Plot CUSUM value using Plotly</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>CUSUM plot using Plotly graph object.</p> |
| </dd> |
| <dt class="field-even">Return type<span class="colon">:</span></dt> |
| <dd class="field-even"><p>go.Figure</p> |
| </dd> |
| </dl> |
| </dd></dl> |
|
|
| <dl class="py method"> |
| <dt class="sig sig-object py" id="package.cusum.CUSUM.plot_input_metric_plotly"> |
| <span class="sig-name descname"><span class="pre">plot_input_metric_plotly</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Figure</span></span></span><a class="headerlink" href="#package.cusum.CUSUM.plot_input_metric_plotly" title="Link to this definition">¶</a></dt> |
| <dd><p>Plot the input metric using Plotly.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Scatter plot as Plotly graph object.</p> |
| </dd> |
| <dt class="field-even">Return type<span class="colon">:</span></dt> |
| <dd class="field-even"><p>go.Figure</p> |
| </dd> |
| </dl> |
| </dd></dl> |
|
|
| <dl class="py method"> |
| <dt class="sig sig-object py" id="package.cusum.CUSUM.plot_input_metric_plotly_raw"> |
| <span class="sig-name descname"><span class="pre">plot_input_metric_plotly_raw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Figure</span></span></span><a class="headerlink" href="#package.cusum.CUSUM.plot_input_metric_plotly_raw" title="Link to this definition">¶</a></dt> |
| <dd><p>Plot AI output using Plotly.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Scatter plot as Plotly graph object.</p> |
| </dd> |
| <dt class="field-even">Return type<span class="colon">:</span></dt> |
| <dd class="field-even"><p>go.Figure</p> |
| </dd> |
| </dl> |
| </dd></dl> |
|
|
| <dl class="py method"> |
| <dt class="sig sig-object py" id="package.cusum.CUSUM.set_df_metric_csv"> |
| <span class="sig-name descname"><span class="pre">set_df_metric_csv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_csv</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#package.cusum.CUSUM.set_df_metric_csv" title="Link to this definition">¶</a></dt> |
| <dd><p>Assign the performance metric data to be used for CUSUM.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>data_csv</strong> (<em>DataFrame</em><em> or </em><em>TextFileReader</em>) – A comma-separated values (csv) file is returned as two-dimensional data structure with labeled axes.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
|
|
| <dl class="py method"> |
| <dt class="sig sig-object py" id="package.cusum.CUSUM.set_df_metric_default"> |
| <span class="sig-name descname"><span class="pre">set_df_metric_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#package.cusum.CUSUM.set_df_metric_default" title="Link to this definition">¶</a></dt> |
| <dd><p>Read the provided performance metric data to be used for CUSUM for an example.</p> |
| </dd></dl> |
|
|
| <dl class="py method"> |
| <dt class="sig sig-object py" id="package.cusum.CUSUM.set_init_stats"> |
| <span class="sig-name descname"><span class="pre">set_init_stats</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">init_days</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#package.cusum.CUSUM.set_init_stats" title="Link to this definition">¶</a></dt> |
| <dd><p>Use number of baseline observations to calculate in-control mean and standard deviation.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>init_days</strong> (<em>int</em><em>, </em><em>optional</em>) – Number of baseline observations when observations are considered stable. Defaults to 30.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
|
|
| <dl class="py method"> |
| <dt class="sig sig-object py" id="package.cusum.CUSUM.set_timeline"> |
| <span class="sig-name descname"><span class="pre">set_timeline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#package.cusum.CUSUM.set_timeline" title="Link to this definition">¶</a></dt> |
| <dd><p>Set the timeline of observations.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>data</strong> (<em>np.ndarray</em>) – Data of the metric values across the observations.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
|
|
| </dd></dl> |
|
|
| </section> |
|
|
|
|
| </div> |
| |
| </div> |
| </div> |
| <div class="sphinxsidebar" role="navigation" aria-label="Main"> |
| <div class="sphinxsidebarwrapper"> |
| <h1 class="logo"><a href="index.html">AIM-CU</a></h1> |
|
|
|
|
|
|
|
|
|
|
|
|
| <p> |
| <iframe src="https://ghbtns.com/github-btn.html?user=DIDSR&repo=AIM-CU&type=watch&count=true&size=large&v=2" |
| allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe> |
| </p> |
|
|
|
|
|
|
|
|
|
|
|
|
| <search id="searchbox" style="display: none" role="search"> |
| <div class="searchformwrapper"> |
| <form class="search" action="search.html" method="get"> |
| <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/> |
| <input type="submit" value="Go" /> |
| </form> |
| </div> |
| </search> |
| <script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3> |
| <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="ref_method.html">Methods</a></li> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">CUSUM</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="#package.cusum.CUSUM"><code class="docutils literal notranslate"><span class="pre">CUSUM</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="ref_theoretical.html">ARLTheoretical</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="ref_utils.html">Utils</a></li> |
| </ul> |
|
|
| <div class="relations"> |
| <h3>Related Topics</h3> |
| <ul> |
| <li><a href="index.html">Documentation overview</a><ul> |
| <li>Previous: <a href="ref_method.html" title="previous chapter">Methods</a></li> |
| <li>Next: <a href="ref_theoretical.html" title="next chapter">ARLTheoretical</a></li> |
| </ul></li> |
| </ul> |
| </div> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| </div> |
| </div> |
| <div class="clearer"></div> |
| </div> |
| <div class="footer"> |
| |
| |
| |
| Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a> |
| & <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a> |
| |
| | |
| <a href="_sources/ref_cusum.rst.txt" |
| rel="nofollow">Page source</a> |
| </div> |
|
|
| |
|
|
| |
| </body> |
| </html> |
