|
|
<!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>AIM-CU documentation — 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> |
|
|
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script> |
|
|
<link rel="index" title="Index" href="genindex.html" /> |
|
|
<link rel="search" title="Search" href="search.html" /> |
|
|
<link rel="next" 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="aim-cu-documentation"> |
|
|
<h1>AIM-CU documentation<a class="headerlink" href="#aim-cu-documentation" title="Link to this heading">¶</a></h1> |
|
|
<p>A CUSUM-based tool for AI Monitoring</p> |
|
|
<p>AIM-CU is a statistical tool for AI monitoring using cumulative sum (AIM-CU). AIM-CU computes:</p> |
|
|
<ul class="simple"> |
|
|
<li><p>The parameter choices for change-point detection based on an acceptable false alarm rate</p></li> |
|
|
<li><p>Detection delay estimates for a given displacement of the performance metric from the target for those parameter choices.</p></li> |
|
|
</ul> |
|
|
<section id="code-execution"> |
|
|
<h2>Code execution<a class="headerlink" href="#code-execution" title="Link to this heading">¶</a></h2> |
|
|
<p>Clone AIM-CU repository.</p> |
|
|
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/DIDSR/AIM-CU.git |
|
|
</pre></div> |
|
|
</div> |
|
|
<p>Run the following commands to install required dependencies (Python = 3.10 is used).</p> |
|
|
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>apt-get<span class="w"> </span>-y<span class="w"> </span>install<span class="w"> </span>python3 |
|
|
apt-get<span class="w"> </span>-y<span class="w"> </span>install<span class="w"> </span>pip |
|
|
<span class="nb">cd</span><span class="w"> </span>AIM-CU |
|
|
pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements.txt |
|
|
</pre></div> |
|
|
</div> |
|
|
<p>Run AIM-CU.</p> |
|
|
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python3<span class="w"> </span>app.py |
|
|
</pre></div> |
|
|
</div> |
|
|
<p>Open the URL <a class="reference external" href="http://0.0.0.0:7860">http://0.0.0.0:7860</a> that is running the AIM-CU locally.</p> |
|
|
</section> |
|
|
<section id="demo"> |
|
|
<h2>Demo<a class="headerlink" href="#demo" title="Link to this heading">¶</a></h2> |
|
|
<p>AIM-CU can also be run through the demo available at <a class="reference external" href="https://huggingface.co/spaces/didsr/AIM-CU">https://huggingface.co/spaces/didsr/AIM-CU</a>. If Space is paused, click on Restart button.</p> |
|
|
<div class="toctree-wrapper compound"> |
|
|
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> |
|
|
<ul> |
|
|
<li class="toctree-l1"><a class="reference internal" href="ref_method.html">Methods</a><ul> |
|
|
<li class="toctree-l2"><a class="reference internal" href="ref_method.html#cusum-parameters">CUSUM parameters</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="ref_method.html#cusum-chart">CUSUM chart</a></li> |
|
|
</ul> |
|
|
</li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="ref_cusum.html">CUSUM</a><ul> |
|
|
<li class="toctree-l2"><a class="reference internal" href="ref_cusum.html#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><ul> |
|
|
<li class="toctree-l2"><a class="reference internal" href="ref_theoretical.html#package.ARLTheoretical.get_ARL_1"><code class="docutils literal notranslate"><span class="pre">get_ARL_1()</span></code></a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="ref_theoretical.html#package.ARLTheoretical.get_ARL_1_h_mu1_k"><code class="docutils literal notranslate"><span class="pre">get_ARL_1_h_mu1_k()</span></code></a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="ref_theoretical.html#package.ARLTheoretical.get_ref_value"><code class="docutils literal notranslate"><span class="pre">get_ref_value()</span></code></a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="ref_theoretical.html#package.ARLTheoretical.get_ref_value_k"><code class="docutils literal notranslate"><span class="pre">get_ref_value_k()</span></code></a></li> |
|
|
</ul> |
|
|
</li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="ref_utils.html">Utils</a><ul> |
|
|
<li class="toctree-l2"><a class="reference internal" href="ref_utils.html#package.utils.get_greattable_as_html"><code class="docutils literal notranslate"><span class="pre">get_greattable_as_html()</span></code></a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="ref_utils.html#package.utils.populate_summary_table_ARL0_k"><code class="docutils literal notranslate"><span class="pre">populate_summary_table_ARL0_k()</span></code></a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="ref_utils.html#package.utils.populate_summary_table_ARL1_k"><code class="docutils literal notranslate"><span class="pre">populate_summary_table_ARL1_k()</span></code></a></li> |
|
|
</ul> |
|
|
</li> |
|
|
</ul> |
|
|
</div> |
|
|
</section> |
|
|
</section> |
|
|
|
|
|
|
|
|
</div> |
|
|
|
|
|
</div> |
|
|
</div> |
|
|
<div class="sphinxsidebar" role="navigation" aria-label="Main"> |
|
|
<div class="sphinxsidebarwrapper"> |
|
|
<h1 class="logo"><a href="#">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> |
|
|
<li class="toctree-l1"><a class="reference internal" href="ref_method.html">Methods</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="ref_cusum.html">CUSUM</a></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="#">Documentation overview</a><ul> |
|
|
<li>Next: <a href="ref_method.html" title="next chapter">Methods</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/index.rst.txt" |
|
|
rel="nofollow">Page source</a> |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body> |
|
|
</html> |
