| |
| |
| <!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.onnx_inference module — Apache Beam 2.56.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_inference module" href="apache_beam.ml.inference.pytorch_inference.html" /> |
| <link rel="prev" title="apache_beam.ml.inference.huggingface_inference module" href="apache_beam.ml.inference.huggingface_inference.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.56.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> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.ml.transforms.html">apache_beam.ml.transforms 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="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.onnx_inference module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.ml.inference.onnx_inference.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.onnx_inference"> |
| <span id="apache-beam-ml-inference-onnx-inference-module"></span><h1>apache_beam.ml.inference.onnx_inference module<a class="headerlink" href="#module-apache_beam.ml.inference.onnx_inference" title="Permalink to this headline">¶</a></h1> |
| <dl class="class"> |
| <dt id="apache_beam.ml.inference.onnx_inference.OnnxModelHandlerNumpy"> |
| <em class="property">class </em><code class="descclassname">apache_beam.ml.inference.onnx_inference.</code><code class="descname">OnnxModelHandlerNumpy</code><span class="sig-paren">(</span><em>model_uri: str, session_options=None, providers=['CUDAExecutionProvider', 'CPUExecutionProvider'], provider_options=None, *, inference_fn: Callable[[Sequence[numpy.ndarray], <sphinx.ext.autodoc.importer._MockObject object at 0x7f761e5e8970>, Optional[Dict[str, Any]]], Iterable[apache_beam.ml.inference.base.PredictionResult]] = <function default_numpy_inference_fn>, large_model: bool = False, model_copies: Optional[int] = None, min_batch_size: Optional[int] = None, max_batch_size: Optional[int] = None, max_batch_duration_secs: Optional[int] = None, **kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/inference/onnx_inference.html#OnnxModelHandlerNumpy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.inference.onnx_inference.OnnxModelHandlerNumpy" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.ml.inference.base.html#apache_beam.ml.inference.base.ModelHandler" title="apache_beam.ml.inference.base.ModelHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.ml.inference.base.ModelHandler</span></code></a></p> |
| <p>Implementation of the ModelHandler interface for onnx |
| using numpy arrays as input. |
| Note that inputs to ONNXModelHandler should be of the same sizes</p> |
| <p>Example Usage:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pcoll</span> <span class="o">|</span> <span class="n">RunInference</span><span class="p">(</span><span class="n">OnnxModelHandler</span><span class="p">(</span><span class="n">model_uri</span><span class="o">=</span><span class="s2">"my_uri"</span><span class="p">))</span> |
| </pre></div> |
| </div> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>model_uri</strong> – The URI to where the model is saved.</li> |
| <li><strong>inference_fn</strong> – The inference function to use on RunInference calls. |
| default=default_numpy_inference_fn</li> |
| <li><strong>large_model</strong> – set to true if your model is large enough to run into |
| memory pressure if you load multiple copies. Given a model that |
| consumes N memory and a machine with W cores and M memory, you should |
| set this to True if N*W > M.</li> |
| <li><strong>model_copies</strong> – The exact number of models that you would like loaded |
| onto your machine. This can be useful if you exactly know your CPU or |
| GPU capacity and want to maximize resource utilization.</li> |
| <li><strong>min_batch_size</strong> – the minimum batch size to use when batching inputs.</li> |
| <li><strong>max_batch_size</strong> – the maximum batch size to use when batching inputs.</li> |
| <li><strong>max_batch_duration_secs</strong> – the maximum amount of time to buffer a batch |
| before emitting; used in streaming contexts.</li> |
| <li><strong>kwargs</strong> – ‘env_vars’ can be used to set environment variables |
| before loading the model.</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="method"> |
| <dt id="apache_beam.ml.inference.onnx_inference.OnnxModelHandlerNumpy.load_model"> |
| <code class="descname">load_model</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <sphinx.ext.autodoc.importer._MockObject object at 0x7f761e5e8430><a class="reference internal" href="_modules/apache_beam/ml/inference/onnx_inference.html#OnnxModelHandlerNumpy.load_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.inference.onnx_inference.OnnxModelHandlerNumpy.load_model" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Loads and initializes an onnx inference session for processing.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.ml.inference.onnx_inference.OnnxModelHandlerNumpy.run_inference"> |
| <code class="descname">run_inference</code><span class="sig-paren">(</span><em>batch: Sequence[numpy.ndarray], inference_session: <sphinx.ext.autodoc.importer._MockObject object at 0x7f761e5e84f0>, inference_args: Optional[Dict[str, Any]] = None</em><span class="sig-paren">)</span> → Iterable[apache_beam.ml.inference.base.PredictionResult]<a class="reference internal" href="_modules/apache_beam/ml/inference/onnx_inference.html#OnnxModelHandlerNumpy.run_inference"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.inference.onnx_inference.OnnxModelHandlerNumpy.run_inference" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Runs inferences on a batch of numpy arrays.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>batch</strong> – A sequence of examples as numpy arrays. They should |
| be single examples.</li> |
| <li><strong>inference_session</strong> – An onnx inference session. |
| Must be runnable with input x where x is sequence of numpy array</li> |
| <li><strong>inference_args</strong> – Any additional arguments for an inference.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An Iterable of type PredictionResult.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.ml.inference.onnx_inference.OnnxModelHandlerNumpy.get_num_bytes"> |
| <code class="descname">get_num_bytes</code><span class="sig-paren">(</span><em>batch: Sequence[numpy.ndarray]</em><span class="sig-paren">)</span> → int<a class="reference internal" href="_modules/apache_beam/ml/inference/onnx_inference.html#OnnxModelHandlerNumpy.get_num_bytes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.inference.onnx_inference.OnnxModelHandlerNumpy.get_num_bytes" title="Permalink to this definition">¶</a></dt> |
| <dd><table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The number of bytes of data for a batch.</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.ml.inference.onnx_inference.OnnxModelHandlerNumpy.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/onnx_inference.html#OnnxModelHandlerNumpy.get_metrics_namespace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.inference.onnx_inference.OnnxModelHandlerNumpy.get_metrics_namespace" title="Permalink to this definition">¶</a></dt> |
| <dd><table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A namespace for metrics collected by the RunInference transform.</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.ml.inference.onnx_inference.OnnxModelHandlerNumpy.share_model_across_processes"> |
| <code class="descname">share_model_across_processes</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → bool<a class="reference internal" href="_modules/apache_beam/ml/inference/onnx_inference.html#OnnxModelHandlerNumpy.share_model_across_processes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.inference.onnx_inference.OnnxModelHandlerNumpy.share_model_across_processes" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.ml.inference.onnx_inference.OnnxModelHandlerNumpy.model_copies"> |
| <code class="descname">model_copies</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → int<a class="reference internal" href="_modules/apache_beam/ml/inference/onnx_inference.html#OnnxModelHandlerNumpy.model_copies"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.inference.onnx_inference.OnnxModelHandlerNumpy.model_copies" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.ml.inference.onnx_inference.OnnxModelHandlerNumpy.batch_elements_kwargs"> |
| <code class="descname">batch_elements_kwargs</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → Mapping[str, Any]<a class="reference internal" href="_modules/apache_beam/ml/inference/onnx_inference.html#OnnxModelHandlerNumpy.batch_elements_kwargs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.inference.onnx_inference.OnnxModelHandlerNumpy.batch_elements_kwargs" 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_inference.html" class="btn btn-neutral float-right" title="apache_beam.ml.inference.pytorch_inference module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.ml.inference.huggingface_inference.html" class="btn btn-neutral float-left" title="apache_beam.ml.inference.huggingface_inference 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> |
