| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" data-content_root="./"> |
| <head> |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>apache_beam.ml.anomaly.univariate.mad module — Apache Beam 2.68.0 documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> |
| <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> |
| |
| |
| <script src="_static/jquery.js?v=5d32c60e"></script> |
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="_static/documentation_options.js?v=2388e03a"></script> |
| <script src="_static/doctools.js?v=9a2dae69"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="apache_beam.ml.anomaly.univariate.mean module" href="apache_beam.ml.anomaly.univariate.mean.html" /> |
| <link rel="prev" title="apache_beam.ml.anomaly.univariate.base module" href="apache_beam.ml.anomaly.univariate.base.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| <div class="wy-grid-for-nav"> |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="index.html" class="icon icon-home"> |
| Apache Beam |
| </a> |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.ml.html#subpackages">Subpackages</a><ul class="current"> |
| <li class="toctree-l3 current"><a class="reference internal" href="apache_beam.ml.anomaly.html">apache_beam.ml.anomaly package</a><ul class="current"> |
| <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.ml.anomaly.html#subpackages">Subpackages</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="apache_beam.ml.anomaly.html#submodules">Submodules</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.ml.gcp.html">apache_beam.ml.gcp package</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.ml.inference.html">apache_beam.ml.inference package</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.ml.rag.html">apache_beam.ml.rag package</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.ml.transforms.html">apache_beam.ml.transforms package</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.ml.ts.html">apache_beam.ml.ts package</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml package</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="index.html">Apache Beam</a> |
| </nav> |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.ml.html">apache_beam.ml package</a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.ml.anomaly.html">apache_beam.ml.anomaly package</a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.ml.anomaly.univariate.html">apache_beam.ml.anomaly.univariate package</a></li> |
| <li class="breadcrumb-item active">apache_beam.ml.anomaly.univariate.mad module</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/apache_beam.ml.anomaly.univariate.mad.rst.txt" rel="nofollow"> View page source</a> |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <section id="module-apache_beam.ml.anomaly.univariate.mad"> |
| <span id="apache-beam-ml-anomaly-univariate-mad-module"></span><h1>apache_beam.ml.anomaly.univariate.mad module<a class="headerlink" href="#module-apache_beam.ml.anomaly.univariate.mad" title="Link to this heading"></a></h1> |
| <p>Trackers for calculating median absolute deviation in windowed fashion.</p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.univariate.mad.MadTracker"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.ml.anomaly.univariate.mad.</span></span><span class="sig-name descname"><span class="pre">MadTracker</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/anomaly/univariate/mad.html#MadTracker"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.ml.anomaly.univariate.mad.MadTracker" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.ml.anomaly.univariate.base.html#apache_beam.ml.anomaly.univariate.base.BaseTracker" title="apache_beam.ml.anomaly.univariate.base.BaseTracker"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseTracker</span></code></a></p> |
| <p>Tracks the Median Absolute Deviation (MAD) of a stream of values.</p> |
| <p>This class calculates the MAD, a robust measure of statistical dispersion, in |
| an online setting.</p> |
| <p>Similar functionality is available in the River library: |
| <a class="reference external" href="https://github.com/online-ml/river/blob/main/river/stats/mad.py">https://github.com/online-ml/river/blob/main/river/stats/mad.py</a></p> |
| <div class="admonition important"> |
| <p class="admonition-title">Important</p> |
| <p>This online version of MAD that does not exactly match its batch |
| counterpart. In a streaming data context, where the true median is initially |
| unknown, we employ an iterative estimation process. For each incoming data |
| point, we first update the estimated median, and then calculate the absolute |
| difference between the data point and this updated median. To maintain |
| computational efficiency, previously calculated absolute differences are not |
| recalculated with each subsequent median update.</p> |
| </div> |
| <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>median_tracker</strong> – An optional <cite>MedianTracker</cite> instance for tracking the |
| median of the input values. If None, a default <cite>MedianTracker</cite> is |
| created.</p></li> |
| <li><p><strong>diff_median_tracker</strong> – An optional <cite>MedianTracker</cite> instance for tracking |
| the median of the absolute deviations from the median. If None, a |
| default <cite>MedianTracker</cite> is created.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.univariate.mad.MadTracker.push"> |
| <span class="sig-name descname"><span class="pre">push</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/anomaly/univariate/mad.html#MadTracker.push"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.ml.anomaly.univariate.mad.MadTracker.push" title="Link to this definition"></a></dt> |
| <dd><p>Adds a new value to the tracker and updates the MAD.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>x</strong> – The value to be added to the tracked stream.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.univariate.mad.MadTracker.get"> |
| <span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/anomaly/univariate/mad.html#MadTracker.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.ml.anomaly.univariate.mad.MadTracker.get" title="Link to this definition"></a></dt> |
| <dd><p>Retrieves the current MAD value.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><dl class="simple"> |
| <dt>The MAD of the values within the defined window. Returns <cite>NaN</cite> if</dt><dd><p>the window is empty.</p> |
| </dd> |
| </dl> |
| </p> |
| </dd> |
| <dt class="field-even">Return type<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)">float</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.univariate.mad.MadTracker.get_median"> |
| <span class="sig-name descname"><span class="pre">get_median</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/anomaly/univariate/mad.html#MadTracker.get_median"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.ml.anomaly.univariate.mad.MadTracker.get_median" title="Link to this definition"></a></dt> |
| <dd><p>Retrieves the current median value.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><dl class="simple"> |
| <dt>The median of the values within the defined window. Returns <cite>NaN</cite></dt><dd><p>if the window is empty.</p> |
| </dd> |
| </dl> |
| </p> |
| </dd> |
| <dt class="field-even">Return type<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)">float</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.univariate.mad.MadTracker.MadTracker__spec_type"> |
| <span class="sig-name descname"><span class="pre">MadTracker__spec_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MadTracker'</span></em><a class="headerlink" href="#apache_beam.ml.anomaly.univariate.mad.MadTracker.MadTracker__spec_type" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.univariate.mad.MadTracker.from_spec"> |
| <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_spec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.ml.anomaly.specifiable.html#apache_beam.ml.anomaly.specifiable.Spec" title="apache_beam.ml.anomaly.specifiable.Spec"><span class="pre">Spec</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">_run_init</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</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">Self</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.13)"><span class="pre">type</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Self</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#apache_beam.ml.anomaly.univariate.mad.MadTracker.from_spec" title="Link to this definition"></a></dt> |
| <dd><p>Generate a <cite>Specifiable</cite> subclass object based on a spec.</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>spec</strong> – the specification of a <cite>Specifiable</cite> subclass object</p></li> |
| <li><p><strong>_run_init</strong> – whether to call <cite>__init__</cite> or not for the initial instantiation</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>the <cite>Specifiable</cite> subclass object</p> |
| </dd> |
| <dt class="field-odd">Return type<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Self</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.univariate.mad.MadTracker.run_original_init"> |
| <span class="sig-name descname"><span class="pre">run_original_init</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"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#apache_beam.ml.anomaly.univariate.mad.MadTracker.run_original_init" title="Link to this definition"></a></dt> |
| <dd><p>Execute the original <cite>__init__</cite> method with its saved arguments.</p> |
| <p>For instances of the <cite>Specifiable</cite> class, initialization is deferred |
| (lazy initialization). This function forces the execution of the |
| original <cite>__init__</cite> method using the arguments captured during |
| the object’s initial instantiation.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.univariate.mad.MadTracker.spec_type"> |
| <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">spec_type</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.ml.anomaly.univariate.mad.MadTracker.spec_type" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.univariate.mad.MadTracker.to_spec"> |
| <span class="sig-name descname"><span class="pre">to_spec</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"><a class="reference internal" href="apache_beam.ml.anomaly.specifiable.html#apache_beam.ml.anomaly.specifiable.Spec" title="apache_beam.ml.anomaly.specifiable.Spec"><span class="pre">Spec</span></a></span></span><a class="headerlink" href="#apache_beam.ml.anomaly.univariate.mad.MadTracker.to_spec" title="Link to this definition"></a></dt> |
| <dd><p>Generate a spec from a <cite>Specifiable</cite> subclass object.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The specification of the instance.</p> |
| </dd> |
| <dt class="field-even">Return type<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="apache_beam.ml.anomaly.specifiable.html#apache_beam.ml.anomaly.specifiable.Spec" title="apache_beam.ml.anomaly.specifiable.Spec">Spec</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.univariate.mad.MadTracker.unspecifiable"> |
| <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unspecifiable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.ml.anomaly.univariate.mad.MadTracker.unspecifiable" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="apache_beam.ml.anomaly.univariate.base.html" class="btn btn-neutral float-left" title="apache_beam.ml.anomaly.univariate.base module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="apache_beam.ml.anomaly.univariate.mean.html" class="btn btn-neutral float-right" title="apache_beam.ml.anomaly.univariate.mean module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright %Y, Apache Beam.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
