| |
| |
| <!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.runners.dask.dask_runner module — Apache Beam 2.47.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.runners.dask.overrides module" href="apache_beam.runners.dask.overrides.html" /> |
| <link rel="prev" title="apache_beam.runners.dask package" href="apache_beam.runners.dask.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.47.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"><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 current"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.runners.html#subpackages">Subpackages</a><ul class="current"> |
| <li class="toctree-l3 current"><a class="reference internal" href="apache_beam.runners.dask.html">apache_beam.runners.dask package</a><ul class="current"> |
| <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.runners.dask.html#submodules">Submodules</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.html">apache_beam.runners.dataflow package</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.html">apache_beam.runners.direct package</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.job.html">apache_beam.runners.job package</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.html#submodules">Submodules</a></li> |
| </ul> |
| </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.runners.html">apache_beam.runners package</a> »</li> |
| |
| <li><a href="apache_beam.runners.dask.html">apache_beam.runners.dask package</a> »</li> |
| |
| <li>apache_beam.runners.dask.dask_runner module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.runners.dask.dask_runner.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.runners.dask.dask_runner"> |
| <span id="apache-beam-runners-dask-dask-runner-module"></span><h1>apache_beam.runners.dask.dask_runner module<a class="headerlink" href="#module-apache_beam.runners.dask.dask_runner" title="Permalink to this headline">¶</a></h1> |
| <p>DaskRunner, executing remote jobs on Dask.distributed.</p> |
| <p>The DaskRunner is a runner implementation that executes a graph of |
| transformations across processes and workers via Dask distributed’s |
| scheduler.</p> |
| <dl class="class"> |
| <dt id="apache_beam.runners.dask.dask_runner.DaskOptions"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.dask.dask_runner.</code><code class="descname">DaskOptions</code><span class="sig-paren">(</span><em>flags=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dask/dask_runner.html#DaskOptions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dask.dask_runner.DaskOptions" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.options.pipeline_options.html#apache_beam.options.pipeline_options.PipelineOptions" title="apache_beam.options.pipeline_options.PipelineOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.options.pipeline_options.PipelineOptions</span></code></a></p> |
| <p>Initialize an options class.</p> |
| <p>The initializer will traverse all subclasses, add all their argparse |
| arguments and then parse the command line specified by flags or by default |
| the one obtained from sys.argv.</p> |
| <p>The subclasses of PipelineOptions do not need to redefine __init__.</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 last simple"> |
| <li><strong>flags</strong> – An iterable of command line arguments to be used. If not specified |
| then sys.argv will be used as input for parsing arguments.</li> |
| <li><strong>**kwargs</strong> – Add overrides for arguments passed in flags. For overrides |
| of arguments, please pass the <cite>option names</cite> instead of |
| flag names. |
| Option names: These are defined as dest in the |
| parser.add_argument() for each flag. Passing flags |
| like {no_use_public_ips: True}, for which the dest is |
| defined to a different flag name in the parser, |
| would be discarded. Instead, pass the dest of |
| the flag (dest of no_use_public_ips is use_public_ips).</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.runners.dask.dask_runner.DaskRunnerResult"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.dask.dask_runner.</code><code class="descname">DaskRunnerResult</code><span class="sig-paren">(</span><em>client: distributed.client.Client, futures: Sequence[distributed.client.Future]</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dask/dask_runner.html#DaskRunnerResult"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dask.dask_runner.DaskRunnerResult" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.runners.runner.html#apache_beam.runners.runner.PipelineResult" title="apache_beam.runners.runner.PipelineResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.runners.runner.PipelineResult</span></code></a></p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.dask.dask_runner.DaskRunnerResult.wait_until_finish"> |
| <code class="descname">wait_until_finish</code><span class="sig-paren">(</span><em>duration=None</em><span class="sig-paren">)</span> → str<a class="reference internal" href="_modules/apache_beam/runners/dask/dask_runner.html#DaskRunnerResult.wait_until_finish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dask.dask_runner.DaskRunnerResult.wait_until_finish" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dask.dask_runner.DaskRunnerResult.cancel"> |
| <code class="descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → str<a class="reference internal" href="_modules/apache_beam/runners/dask/dask_runner.html#DaskRunnerResult.cancel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dask.dask_runner.DaskRunnerResult.cancel" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dask.dask_runner.DaskRunnerResult.metrics"> |
| <code class="descname">metrics</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dask/dask_runner.html#DaskRunnerResult.metrics"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dask.dask_runner.DaskRunnerResult.metrics" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.dask.dask_runner.DaskRunnerResult.distributed"> |
| <code class="descname">distributed</code><em class="property"> = <module 'dask.distributed' from '/usr/local/google/home/jrmccluskey/website_update_dir/python_doc/beam/sdks/python/target/.tox/py38-docs/lib/python3.8/site-packages/dask/distributed.py'></em><a class="headerlink" href="#apache_beam.runners.dask.dask_runner.DaskRunnerResult.distributed" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.runners.dask.dask_runner.DaskRunner"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.dask.dask_runner.</code><code class="descname">DaskRunner</code><a class="reference internal" href="_modules/apache_beam/runners/dask/dask_runner.html#DaskRunner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dask.dask_runner.DaskRunner" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.runners.direct.direct_runner.html#apache_beam.runners.direct.direct_runner.BundleBasedDirectRunner" title="apache_beam.runners.direct.direct_runner.BundleBasedDirectRunner"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.runners.direct.direct_runner.BundleBasedDirectRunner</span></code></a></p> |
| <p>Executes a pipeline on a Dask distributed client.</p> |
| <dl class="staticmethod"> |
| <dt id="apache_beam.runners.dask.dask_runner.DaskRunner.to_dask_bag_visitor"> |
| <em class="property">static </em><code class="descname">to_dask_bag_visitor</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → apache_beam.pipeline.PipelineVisitor<a class="reference internal" href="_modules/apache_beam/runners/dask/dask_runner.html#DaskRunner.to_dask_bag_visitor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dask.dask_runner.DaskRunner.to_dask_bag_visitor" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="apache_beam.runners.dask.dask_runner.DaskRunner.is_fnapi_compatible"> |
| <em class="property">static </em><code class="descname">is_fnapi_compatible</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dask/dask_runner.html#DaskRunner.is_fnapi_compatible"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dask.dask_runner.DaskRunner.is_fnapi_compatible" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dask.dask_runner.DaskRunner.run_pipeline"> |
| <code class="descname">run_pipeline</code><span class="sig-paren">(</span><em>pipeline</em>, <em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dask/dask_runner.html#DaskRunner.run_pipeline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dask.dask_runner.DaskRunner.run_pipeline" 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.runners.dask.overrides.html" class="btn btn-neutral float-right" title="apache_beam.runners.dask.overrides module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.runners.dask.html" class="btn btn-neutral float-left" title="apache_beam.runners.dask package" 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> |
