| |
| |
| <!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.thresholds 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.transforms module" href="apache_beam.ml.anomaly.transforms.html" /> |
| <link rel="prev" title="apache_beam.ml.anomaly.specifiable module" href="apache_beam.ml.anomaly.specifiable.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"><a class="reference internal" href="apache_beam.ml.anomaly.html#subpackages">Subpackages</a></li> |
| <li class="toctree-l4 current"><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 active">apache_beam.ml.anomaly.thresholds module</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/apache_beam.ml.anomaly.thresholds.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.thresholds"> |
| <span id="apache-beam-ml-anomaly-thresholds-module"></span><h1>apache_beam.ml.anomaly.thresholds module<a class="headerlink" href="#module-apache_beam.ml.anomaly.thresholds" title="Link to this heading"></a></h1> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.thresholds.FixedThreshold"> |
| <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.thresholds.</span></span><span class="sig-name descname"><span class="pre">FixedThreshold</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/thresholds.html#FixedThreshold"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.ml.anomaly.thresholds.FixedThreshold" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.ml.anomaly.base.html#apache_beam.ml.anomaly.base.ThresholdFn" title="apache_beam.ml.anomaly.base.ThresholdFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">ThresholdFn</span></code></a></p> |
| <p>Applies a fixed cutoff value to anomaly scores.</p> |
| <p>This <cite>ThresholdFn</cite> is stateless and uses a pre-defined cutoff value to |
| classify anomaly scores. Scores below the cutoff are considered normal, while |
| scores at or above the cutoff are classified as outliers.</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>cutoff</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a>) – The fixed threshold value. Anomaly scores at or above this |
| value will be labeled as outliers.</p></li> |
| <li><p><strong>**kwargs</strong> – Additional keyword arguments to be passed to the base |
| <cite>ThresholdFn</cite> constructor.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.thresholds.FixedThreshold.is_stateful"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_stateful</span></span><em class="property"><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#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></em><a class="headerlink" href="#apache_beam.ml.anomaly.thresholds.FixedThreshold.is_stateful" title="Link to this definition"></a></dt> |
| <dd><p>Indicates whether this ThresholdFn is stateful.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Always False for <cite>FixedThreshold</cite> as it is stateless.</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#bool" title="(in Python v3.13)">bool</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.thresholds.FixedThreshold.threshold"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">threshold</span></span><em class="property"><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#float" title="(in Python v3.13)"><span class="pre">float</span></a></em><a class="headerlink" href="#apache_beam.ml.anomaly.thresholds.FixedThreshold.threshold" title="Link to this definition"></a></dt> |
| <dd><p>Returns the fixed cutoff threshold value.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The fixed threshold value.</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.thresholds.FixedThreshold.apply"> |
| <span class="sig-name descname"><span class="pre">apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">score</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#float" title="(in Python v3.13)"><span class="pre">float</span></a><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/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></em><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/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a><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/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/ml/anomaly/thresholds.html#FixedThreshold.apply"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.ml.anomaly.thresholds.FixedThreshold.apply" title="Link to this definition"></a></dt> |
| <dd><p>Applies the fixed threshold to an anomaly score.</p> |
| <p>Classifies the given anomaly score as normal or outlier based on the |
| predefined cutoff.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>score</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a><em>]</em>) – The input anomaly score.</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><dl class="simple"> |
| <dt>The anomaly label:</dt><dd><ul class="simple"> |
| <li><p><cite>normal_label</cite> if the score is less than the threshold.</p></li> |
| <li><p><cite>outlier_label</cite> if the score is at or above the threshold.</p></li> |
| <li><p><cite>missing_label</cite> if the score is <cite>NaN</cite> (detector not ready).</p></li> |
| <li><p><cite>None</cite> if the score is <cite>None</cite> (detector ready, but unable to produce |
| score).</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd> |
| <dt class="field-odd">Return type<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Optional[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>]</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.thresholds.FixedThreshold.FixedThreshold__spec_type"> |
| <span class="sig-name descname"><span class="pre">FixedThreshold__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">'FixedThreshold'</span></em><a class="headerlink" href="#apache_beam.ml.anomaly.thresholds.FixedThreshold.FixedThreshold__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.thresholds.FixedThreshold.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.thresholds.FixedThreshold.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.thresholds.FixedThreshold.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.thresholds.FixedThreshold.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.thresholds.FixedThreshold.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.thresholds.FixedThreshold.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.thresholds.FixedThreshold.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.thresholds.FixedThreshold.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.thresholds.FixedThreshold.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.thresholds.FixedThreshold.unspecifiable" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.thresholds.QuantileThreshold"> |
| <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.thresholds.</span></span><span class="sig-name descname"><span class="pre">QuantileThreshold</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/thresholds.html#QuantileThreshold"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.ml.anomaly.thresholds.QuantileThreshold" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.ml.anomaly.base.html#apache_beam.ml.anomaly.base.ThresholdFn" title="apache_beam.ml.anomaly.base.ThresholdFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">ThresholdFn</span></code></a></p> |
| <p>Applies a quantile-based dynamic threshold to anomaly scores.</p> |
| <p>This <cite>ThresholdFn</cite> is stateful and uses a quantile tracker to dynamically |
| determine the threshold for anomaly detection. It estimates the specified |
| quantile of the incoming anomaly scores and uses this quantile value as the |
| threshold.</p> |
| <p>The threshold adapts over time as more data is processed, making it suitable |
| for scenarios where the distribution of anomaly scores may change.</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>quantile</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a><em>]</em>) – The quantile to be tracked (e.g., 0.95 for the |
| 95th percentile). This value determines the dynamic threshold. Defaults to |
| 0.95.</p></li> |
| <li><p><strong>quantile_tracker</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="apache_beam.ml.anomaly.univariate.quantile.html#apache_beam.ml.anomaly.univariate.quantile.BufferedQuantileTracker" title="apache_beam.ml.anomaly.univariate.quantile.BufferedQuantileTracker"><em>BufferedQuantileTracker</em></a><em>]</em>) – An optional |
| pre-initialized quantile tracker. If provided, this tracker will be used; |
| otherwise, a <cite>BufferedSlidingQuantileTracker</cite> will be created with a |
| default window size of 100.</p></li> |
| <li><p><strong>**kwargs</strong> – Additional keyword arguments to be passed to the base |
| <cite>ThresholdFn</cite> constructor.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.thresholds.QuantileThreshold.is_stateful"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_stateful</span></span><em class="property"><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#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></em><a class="headerlink" href="#apache_beam.ml.anomaly.thresholds.QuantileThreshold.is_stateful" title="Link to this definition"></a></dt> |
| <dd><p>Indicates whether this ThresholdFn is stateful.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Always True for <cite>QuantileThreshold</cite> as it is stateful.</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#bool" title="(in Python v3.13)">bool</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.thresholds.QuantileThreshold.threshold"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">threshold</span></span><em class="property"><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#float" title="(in Python v3.13)"><span class="pre">float</span></a></em><a class="headerlink" href="#apache_beam.ml.anomaly.thresholds.QuantileThreshold.threshold" title="Link to this definition"></a></dt> |
| <dd><p>Returns the current quantile-based threshold 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 dynamically calculated threshold value based on the quantile</dt><dd><p>tracker.</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.thresholds.QuantileThreshold.QuantileThreshold__spec_type"> |
| <span class="sig-name descname"><span class="pre">QuantileThreshold__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">'QuantileThreshold'</span></em><a class="headerlink" href="#apache_beam.ml.anomaly.thresholds.QuantileThreshold.QuantileThreshold__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.thresholds.QuantileThreshold.apply"> |
| <span class="sig-name descname"><span class="pre">apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">score</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#float" title="(in Python v3.13)"><span class="pre">float</span></a><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/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></em><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/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a><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/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/ml/anomaly/thresholds.html#QuantileThreshold.apply"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.ml.anomaly.thresholds.QuantileThreshold.apply" title="Link to this definition"></a></dt> |
| <dd><p>Applies the quantile-based threshold to an anomaly score.</p> |
| <p>Updates the quantile tracker with the given score and classifies the score |
| as normal or outlier based on the current quantile threshold.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>score</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a><em>]</em>) – The input anomaly score.</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><dl class="simple"> |
| <dt>The anomaly label:</dt><dd><ul class="simple"> |
| <li><p><cite>normal_label</cite> if the score is less than the threshold.</p></li> |
| <li><p><cite>outlier_label</cite> if the score is at or above the threshold.</p></li> |
| <li><p><cite>missing_label</cite> if the score is <cite>NaN</cite> (detector not ready).</p></li> |
| <li><p><cite>None</cite> if the score is <cite>None</cite> (detector ready, but unable to produce |
| score).</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd> |
| <dt class="field-odd">Return type<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Optional[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>]</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.ml.anomaly.thresholds.QuantileThreshold.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.thresholds.QuantileThreshold.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.thresholds.QuantileThreshold.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.thresholds.QuantileThreshold.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.thresholds.QuantileThreshold.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.thresholds.QuantileThreshold.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.thresholds.QuantileThreshold.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.thresholds.QuantileThreshold.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.thresholds.QuantileThreshold.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.thresholds.QuantileThreshold.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.specifiable.html" class="btn btn-neutral float-left" title="apache_beam.ml.anomaly.specifiable module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="apache_beam.ml.anomaly.transforms.html" class="btn btn-neutral float-right" title="apache_beam.ml.anomaly.transforms 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> |
