| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>apache_beam.ml.inference.base module — Apache Beam 2.39.0 documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |
| <script type="text/javascript" src="_static/jquery.js"></script> |
| <script type="text/javascript" src="_static/underscore.js"></script> |
| <script type="text/javascript" src="_static/doctools.js"></script> |
| <script type="text/javascript" src="_static/language_data.js"></script> |
| <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> |
| |
| <script type="text/javascript" src="_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="apache_beam.ml.inference.pytorch module" href="apache_beam.ml.inference.pytorch.html" /> |
| <link rel="prev" title="apache_beam.ml.inference.api module" href="apache_beam.ml.inference.api.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 class="version"> |
| 2.39.0 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="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="main navigation"> |
| |
| |
| |
| |
| |
| |
| <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"><a class="reference internal" href="apache_beam.ml.gcp.html">apache_beam.ml.gcp package</a></li> |
| <li class="toctree-l3 current"><a class="reference internal" href="apache_beam.ml.inference.html">apache_beam.ml.inference package</a><ul class="current"> |
| <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.ml.inference.html#submodules">Submodules</a></li> |
| </ul> |
| </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> |
| </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="top navigation"> |
| |
| <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="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="index.html">Docs</a> »</li> |
| |
| <li><a href="apache_beam.ml.html">apache_beam.ml package</a> »</li> |
| |
| <li><a href="apache_beam.ml.inference.html">apache_beam.ml.inference package</a> »</li> |
| |
| <li>apache_beam.ml.inference.base module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.ml.inference.base.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"> |
| |
| <div class="section" id="module-apache_beam.ml.inference.base"> |
| <span id="apache-beam-ml-inference-base-module"></span><h1>apache_beam.ml.inference.base module<a class="headerlink" href="#module-apache_beam.ml.inference.base" title="Permalink to this headline">¶</a></h1> |
| <p>An extensible run inference transform.</p> |
| <p>Users of this module can extend the ModelLoader class for any MLframework. Then |
| pass their extended ModelLoader object into RunInference to create a |
| RunInference Beam transform for that framework.</p> |
| <p>The transform will handle standard inference functionality like metric |
| collection, sharing model between threads and batching elements.</p> |
| <p>Note: This module is still actively being developed and users should have |
| no expectation that these interfaces will not change.</p> |
| <dl class="class"> |
| <dt id="apache_beam.ml.inference.base.InferenceRunner"> |
| <em class="property">class </em><code class="descclassname">apache_beam.ml.inference.base.</code><code class="descname">InferenceRunner</code><a class="reference internal" href="_modules/apache_beam/ml/inference/base.html#InferenceRunner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.inference.base.InferenceRunner" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>Implements running inferences for a framework.</p> |
| <dl class="method"> |
| <dt id="apache_beam.ml.inference.base.InferenceRunner.run_inference"> |
| <code class="descname">run_inference</code><span class="sig-paren">(</span><em>batch: List[Any], model: Any</em><span class="sig-paren">)</span> → Iterable[Any]<a class="reference internal" href="_modules/apache_beam/ml/inference/base.html#InferenceRunner.run_inference"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.inference.base.InferenceRunner.run_inference" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Runs inferences on a batch of examples and |
| returns an Iterable of Predictions.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.ml.inference.base.InferenceRunner.get_num_bytes"> |
| <code class="descname">get_num_bytes</code><span class="sig-paren">(</span><em>batch: Any</em><span class="sig-paren">)</span> → int<a class="reference internal" href="_modules/apache_beam/ml/inference/base.html#InferenceRunner.get_num_bytes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.inference.base.InferenceRunner.get_num_bytes" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the number of bytes of data for a batch.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.ml.inference.base.InferenceRunner.get_metrics_namespace"> |
| <code class="descname">get_metrics_namespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → str<a class="reference internal" href="_modules/apache_beam/ml/inference/base.html#InferenceRunner.get_metrics_namespace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.inference.base.InferenceRunner.get_metrics_namespace" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a namespace for metrics collected by RunInference transform.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.ml.inference.base.ModelLoader"> |
| <em class="property">class </em><code class="descclassname">apache_beam.ml.inference.base.</code><code class="descname">ModelLoader</code><a class="reference internal" href="_modules/apache_beam/ml/inference/base.html#ModelLoader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.inference.base.ModelLoader" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Generic" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">typing.Generic</span></code></a></p> |
| <p>Has the ability to load an ML model.</p> |
| <dl class="method"> |
| <dt id="apache_beam.ml.inference.base.ModelLoader.load_model"> |
| <code class="descname">load_model</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → T<a class="reference internal" href="_modules/apache_beam/ml/inference/base.html#ModelLoader.load_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.inference.base.ModelLoader.load_model" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Loads and initializes a model for processing.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.ml.inference.base.ModelLoader.get_inference_runner"> |
| <code class="descname">get_inference_runner</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → apache_beam.ml.inference.base.InferenceRunner<a class="reference internal" href="_modules/apache_beam/ml/inference/base.html#ModelLoader.get_inference_runner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.inference.base.ModelLoader.get_inference_runner" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns an implementation of InferenceRunner for this model.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.ml.inference.base.RunInference"> |
| <em class="property">class </em><code class="descclassname">apache_beam.ml.inference.base.</code><code class="descname">RunInference</code><span class="sig-paren">(</span><em>model_loader: apache_beam.ml.inference.base.ModelLoader</em>, <em>clock=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/inference/base.html#RunInference"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.inference.base.RunInference" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p> |
| <p>An extensible transform for running inferences.</p> |
| <dl class="method"> |
| <dt id="apache_beam.ml.inference.base.RunInference.expand"> |
| <code class="descname">expand</code><span class="sig-paren">(</span><em>pcoll: apache_beam.pvalue.PCollection</em><span class="sig-paren">)</span> → apache_beam.pvalue.PCollection<a class="reference internal" href="_modules/apache_beam/ml/inference/base.html#RunInference.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.inference.base.RunInference.expand" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.ml.inference.pytorch.html" class="btn btn-neutral float-right" title="apache_beam.ml.inference.pytorch module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.ml.inference.api.html" class="btn btn-neutral float-left" title="apache_beam.ml.inference.api module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © Copyright |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
