| |
| |
| <!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.transforms.resources module — Apache Beam 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.transforms.sideinputs module" href="apache_beam.transforms.sideinputs.html" /> |
| <link rel="prev" title="apache_beam.transforms.ptransform module" href="apache_beam.transforms.ptransform.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" /> |
| <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"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></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 current"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.transforms.html#submodules">Submodules</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.combinefn_lifecycle_pipeline.html">apache_beam.transforms.combinefn_lifecycle_pipeline module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.combiners.html">apache_beam.transforms.combiners module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.core.html">apache_beam.transforms.core module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.create_source.html">apache_beam.transforms.create_source module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.deduplicate.html">apache_beam.transforms.deduplicate module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.display.html">apache_beam.transforms.display module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.environments.html">apache_beam.transforms.environments module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external.html">apache_beam.transforms.external module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external_java.html">apache_beam.transforms.external_java module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.periodicsequence.html">apache_beam.transforms.periodicsequence module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.ptransform.html">apache_beam.transforms.ptransform module</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.transforms.resources module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.sideinputs.html">apache_beam.transforms.sideinputs module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.sql.html">apache_beam.transforms.sql module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.stats.html">apache_beam.transforms.stats module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.timeutil.html">apache_beam.transforms.timeutil module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.trigger.html">apache_beam.transforms.trigger module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.userstate.html">apache_beam.transforms.userstate module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.util.html">apache_beam.transforms.util module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.window.html">apache_beam.transforms.window module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </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.transforms.html">apache_beam.transforms package</a> »</li> |
| |
| <li>apache_beam.transforms.resources module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.transforms.resources.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.transforms.resources"> |
| <span id="apache-beam-transforms-resources-module"></span><h1>apache_beam.transforms.resources module<a class="headerlink" href="#module-apache_beam.transforms.resources" title="Permalink to this headline">¶</a></h1> |
| <p>A module for defining resource requirements for execution of transforms.</p> |
| <p>Pipeline authors can use resource hints to provide additional information to |
| runners about the desired aspects of the execution environment.</p> |
| <p>Resource hints can be specified on a transform level for parts of the pipeline, |
| or globally via –resource_hint pipeline option.</p> |
| <p>See also: PTransforms.with_resource_hints().</p> |
| <dl class="class"> |
| <dt id="apache_beam.transforms.resources.ResourceHint"> |
| <em class="property">class </em><code class="descclassname">apache_beam.transforms.resources.</code><code class="descname">ResourceHint</code><a class="reference internal" href="_modules/apache_beam/transforms/resources.html#ResourceHint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.resources.ResourceHint" 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.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>A superclass to define resource hints.</p> |
| <dl class="attribute"> |
| <dt id="apache_beam.transforms.resources.ResourceHint.urn"> |
| <code class="descname">urn</code><em class="property"> = None</em><a class="headerlink" href="#apache_beam.transforms.resources.ResourceHint.urn" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.transforms.resources.ResourceHint.parse"> |
| <em class="property">classmethod </em><code class="descname">parse</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/resources.html#ResourceHint.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.resources.ResourceHint.parse" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Describes how to parse the hint. |
| Override to specify a custom parsing logic.</p> |
| </dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.transforms.resources.ResourceHint.get_merged_value"> |
| <em class="property">classmethod </em><code class="descname">get_merged_value</code><span class="sig-paren">(</span><em>outer_value</em>, <em>inner_value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/resources.html#ResourceHint.get_merged_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.resources.ResourceHint.get_merged_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Reconciles values of a hint when the hint specified on a transform is |
| also defined in an outer context, for example on a composite transform, or |
| specified in the transform’s execution environment. |
| Override to specify a custom merging logic.</p> |
| </dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="apache_beam.transforms.resources.ResourceHint.get_by_urn"> |
| <em class="property">static </em><code class="descname">get_by_urn</code><span class="sig-paren">(</span><em>urn</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/resources.html#ResourceHint.get_by_urn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.resources.ResourceHint.get_by_urn" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="apache_beam.transforms.resources.ResourceHint.get_by_name"> |
| <em class="property">static </em><code class="descname">get_by_name</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/resources.html#ResourceHint.get_by_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.resources.ResourceHint.get_by_name" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="apache_beam.transforms.resources.ResourceHint.register_resource_hint"> |
| <em class="property">static </em><code class="descname">register_resource_hint</code><span class="sig-paren">(</span><em>hint_name</em>, <em>hint_class</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/resources.html#ResourceHint.register_resource_hint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.resources.ResourceHint.register_resource_hint" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.transforms.resources.AcceleratorHint"> |
| <em class="property">class </em><code class="descclassname">apache_beam.transforms.resources.</code><code class="descname">AcceleratorHint</code><a class="reference internal" href="_modules/apache_beam/transforms/resources.html#AcceleratorHint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.resources.AcceleratorHint" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.resources.ResourceHint" title="apache_beam.transforms.resources.ResourceHint"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.resources.ResourceHint</span></code></a></p> |
| <p>Describes desired hardware accelerators in execution environment.</p> |
| <dl class="attribute"> |
| <dt id="apache_beam.transforms.resources.AcceleratorHint.urn"> |
| <code class="descname">urn</code><em class="property"> = 'beam:resources:accelerator:v1'</em><a class="headerlink" href="#apache_beam.transforms.resources.AcceleratorHint.urn" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.transforms.resources.MinRamHint"> |
| <em class="property">class </em><code class="descclassname">apache_beam.transforms.resources.</code><code class="descname">MinRamHint</code><a class="reference internal" href="_modules/apache_beam/transforms/resources.html#MinRamHint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.resources.MinRamHint" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.resources.ResourceHint" title="apache_beam.transforms.resources.ResourceHint"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.resources.ResourceHint</span></code></a></p> |
| <p>Describes min RAM requirements for transform’s execution environment.</p> |
| <dl class="attribute"> |
| <dt id="apache_beam.transforms.resources.MinRamHint.urn"> |
| <code class="descname">urn</code><em class="property"> = 'beam:resources:min_ram_bytes:v1'</em><a class="headerlink" href="#apache_beam.transforms.resources.MinRamHint.urn" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.transforms.resources.MinRamHint.parse"> |
| <em class="property">classmethod </em><code class="descname">parse</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/resources.html#MinRamHint.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.resources.MinRamHint.parse" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.transforms.resources.MinRamHint.get_merged_value"> |
| <em class="property">classmethod </em><code class="descname">get_merged_value</code><span class="sig-paren">(</span><em>outer_value</em>, <em>inner_value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/resources.html#MinRamHint.get_merged_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.resources.MinRamHint.get_merged_value" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.transforms.resources.parse_resource_hints"> |
| <code class="descclassname">apache_beam.transforms.resources.</code><code class="descname">parse_resource_hints</code><span class="sig-paren">(</span><em>hints</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/resources.html#parse_resource_hints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.resources.parse_resource_hints" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.transforms.resources.resource_hints_from_options"> |
| <code class="descclassname">apache_beam.transforms.resources.</code><code class="descname">resource_hints_from_options</code><span class="sig-paren">(</span><em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/resources.html#resource_hints_from_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.resources.resource_hints_from_options" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.transforms.resources.merge_resource_hints"> |
| <code class="descclassname">apache_beam.transforms.resources.</code><code class="descname">merge_resource_hints</code><span class="sig-paren">(</span><em>outer_hints</em>, <em>inner_hints</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/resources.html#merge_resource_hints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.resources.merge_resource_hints" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.transforms.sideinputs.html" class="btn btn-neutral float-right" title="apache_beam.transforms.sideinputs module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.transforms.ptransform.html" class="btn btn-neutral float-left" title="apache_beam.transforms.ptransform 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> |