| |
| |
| <!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.tools.utils module — Apache Beam documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
| |
| |
| |
| |
| |
| <link rel="index" title="Index" |
| href="genindex.html"/> |
| <link rel="search" title="Search" href="search.html"/> |
| <link rel="top" title="Apache Beam documentation" href="index.html"/> |
| <link rel="up" title="apache_beam.tools package" href="apache_beam.tools.html"/> |
| <link rel="next" title="apache_beam.transforms package" href="apache_beam.transforms.html"/> |
| <link rel="prev" title="apache_beam.tools.sideinput_microbenchmark module" href="apache_beam.tools.sideinput_microbenchmark.html"/> |
| |
| |
| <script src="_static/js/modernizr.min.js"></script> |
| |
| </head> |
| |
| <body class="wy-body-for-nav" role="document"> |
| |
| |
| <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.internal.html">apache_beam.internal 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.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 current"><a class="reference internal" href="apache_beam.tools.html">apache_beam.tools package</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.tools.html#submodules">Submodules</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.tools.coders_microbenchmark.html">apache_beam.tools.coders_microbenchmark module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.tools.distribution_counter_microbenchmark.html">apache_beam.tools.distribution_counter_microbenchmark module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.tools.fn_api_runner_microbenchmark.html">apache_beam.tools.fn_api_runner_microbenchmark module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.tools.sideinput_microbenchmark.html">apache_beam.tools.sideinput_microbenchmark module</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.tools.utils module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </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> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.version.html">apache_beam.version module</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" role="navigation" 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.tools.html">apache_beam.tools package</a> »</li> |
| |
| <li>apache_beam.tools.utils module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.tools.utils.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.tools.utils"> |
| <span id="apache-beam-tools-utils-module"></span><h1>apache_beam.tools.utils module<a class="headerlink" href="#module-apache_beam.tools.utils" title="Permalink to this headline">¶</a></h1> |
| <p>Utility functions for all microbenchmarks.</p> |
| <dl class="function"> |
| <dt id="apache_beam.tools.utils.check_compiled"> |
| <code class="descclassname">apache_beam.tools.utils.</code><code class="descname">check_compiled</code><span class="sig-paren">(</span><em>module</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/tools/utils.html#check_compiled"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.tools.utils.check_compiled" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Check whether given module has been compiled. |
| :param module: string, module name</p> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.tools.utils.BenchmarkConfig"> |
| <em class="property">class </em><code class="descclassname">apache_beam.tools.utils.</code><code class="descname">BenchmarkConfig</code><a class="reference internal" href="_modules/apache_beam/tools/utils.html#BenchmarkConfig"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.tools.utils.BenchmarkConfig" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.tools.utils.BenchmarkConfig" title="apache_beam.tools.utils.BenchmarkConfig"><code class="xref py py-class docutils literal"><span class="pre">apache_beam.tools.utils.BenchmarkConfig</span></code></a></p> |
| <dl class="attribute"> |
| <dt id="apache_beam.tools.utils.BenchmarkConfig.benchmark"> |
| <code class="descname">benchmark</code><a class="headerlink" href="#apache_beam.tools.utils.BenchmarkConfig.benchmark" title="Permalink to this definition">¶</a></dt> |
| <dd><p>a callable that takes an int argument - benchmark size, |
| and returns a callable. A returned callable must run the code being |
| benchmarked on an input of specified size.</p> |
| <p>For example, one can implement a benchmark as:</p> |
| <dl class="docutils"> |
| <dt>class MyBenchmark(object):</dt> |
| <dd><dl class="first last docutils"> |
| <dt>def __init__(self, size):</dt> |
| <dd>[do necessary initialization]</dd> |
| <dt>def __call__(self):</dt> |
| <dd>[run the code in question]</dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.tools.utils.BenchmarkConfig.size"> |
| <code class="descname">size</code><a class="headerlink" href="#apache_beam.tools.utils.BenchmarkConfig.size" title="Permalink to this definition">¶</a></dt> |
| <dd><p>int, a size of the input. Aggregated per-element metrics |
| are counted based on the size of the input.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.tools.utils.BenchmarkConfig.num_runs"> |
| <code class="descname">num_runs</code><a class="headerlink" href="#apache_beam.tools.utils.BenchmarkConfig.num_runs" title="Permalink to this definition">¶</a></dt> |
| <dd><p>int, number of times to run each benchmark.</p> |
| </dd></dl> |
| |
| <p>Create new instance of BenchmarkConfig(benchmark, size, num_runs)</p> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.tools.utils.LinearRegressionBenchmarkConfig"> |
| <em class="property">class </em><code class="descclassname">apache_beam.tools.utils.</code><code class="descname">LinearRegressionBenchmarkConfig</code><a class="reference internal" href="_modules/apache_beam/tools/utils.html#LinearRegressionBenchmarkConfig"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.tools.utils.LinearRegressionBenchmarkConfig" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.tools.utils.LinearRegressionBenchmarkConfig" title="apache_beam.tools.utils.LinearRegressionBenchmarkConfig"><code class="xref py py-class docutils literal"><span class="pre">apache_beam.tools.utils.LinearRegressionBenchmarkConfig</span></code></a></p> |
| <dl class="attribute"> |
| <dt id="apache_beam.tools.utils.LinearRegressionBenchmarkConfig.benchmark"> |
| <code class="descname">benchmark</code><a class="headerlink" href="#apache_beam.tools.utils.LinearRegressionBenchmarkConfig.benchmark" title="Permalink to this definition">¶</a></dt> |
| <dd><p>a callable that takes an int argument - benchmark size, |
| and returns a callable. A returned callable must run the code being |
| benchmarked on an input of specified size.</p> |
| <p>For example, one can implement a benchmark as:</p> |
| <dl class="docutils"> |
| <dt>class MyBenchmark(object):</dt> |
| <dd><dl class="first last docutils"> |
| <dt>def __init__(self, size):</dt> |
| <dd>[do necessary initialization]</dd> |
| <dt>def __call__(self):</dt> |
| <dd>[run the code in question]</dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.tools.utils.LinearRegressionBenchmarkConfig.starting_point"> |
| <code class="descname">starting_point</code><a class="headerlink" href="#apache_beam.tools.utils.LinearRegressionBenchmarkConfig.starting_point" title="Permalink to this definition">¶</a></dt> |
| <dd><p>int, an initial size of the input. Regression results are |
| calculated based on the input.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.tools.utils.LinearRegressionBenchmarkConfig.increment"> |
| <code class="descname">increment</code><a class="headerlink" href="#apache_beam.tools.utils.LinearRegressionBenchmarkConfig.increment" title="Permalink to this definition">¶</a></dt> |
| <dd><p>int, the rate of growth of the input for each run of the |
| benchmark.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.tools.utils.LinearRegressionBenchmarkConfig.num_runs"> |
| <code class="descname">num_runs</code><a class="headerlink" href="#apache_beam.tools.utils.LinearRegressionBenchmarkConfig.num_runs" title="Permalink to this definition">¶</a></dt> |
| <dd><p>int, number of times to run each benchmark.</p> |
| </dd></dl> |
| |
| <p>Create new instance of LinearRegressionBenchmarkConfig(benchmark, starting_point, increment, num_runs)</p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.tools.utils.run_benchmarks"> |
| <code class="descclassname">apache_beam.tools.utils.</code><code class="descname">run_benchmarks</code><span class="sig-paren">(</span><em>benchmark_suite</em>, <em>verbose=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/tools/utils.html#run_benchmarks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.tools.utils.run_benchmarks" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Runs benchmarks, and collects execution times.</p> |
| <p>A simple instrumentation to run a callable several times, collect and print |
| its execution times.</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>benchmark_suite</strong> – A list of BenchmarkConfig.</li> |
| <li><strong>verbose</strong> – bool, whether to print benchmark results to stdout.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A dictionary of the form string -> list of floats. Keys of the dictionary |
| are benchmark names, values are execution times in seconds for each run.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| <div class="articleComments"> |
| |
| </div> |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.transforms.html" class="btn btn-neutral float-right" title="apache_beam.transforms package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.tools.sideinput_microbenchmark.html" class="btn btn-neutral" title="apache_beam.tools.sideinput_microbenchmark 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/snide/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"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'./', |
| VERSION:'', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt' |
| }; |
| </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/js/theme.js"></script> |
| |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.StickyNav.enable(); |
| }); |
| </script> |
| |
| |
| </body> |
| </html> |
