blob: f2626de0fe51afdd6d6e854795565f17f19ff587 [file] [log] [blame]
<!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.sdf_utils module &mdash; 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 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.testing package" href="apache_beam.testing.html" />
<link rel="prev" title="apache_beam.runners.runner module" href="apache_beam.runners.runner.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.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.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"><a class="reference internal" href="apache_beam.runners.html#subpackages">Subpackages</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="apache_beam.runners.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.pipeline_context.html">apache_beam.runners.pipeline_context module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.runner.html">apache_beam.runners.runner module</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.runners.sdf_utils module</a></li>
</ul>
</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.tools.html">apache_beam.tools 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>
<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" 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> &raquo;</li>
<li><a href="apache_beam.runners.html">apache_beam.runners package</a> &raquo;</li>
<li>apache_beam.runners.sdf_utils module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.runners.sdf_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.runners.sdf_utils">
<span id="apache-beam-runners-sdf-utils-module"></span><h1>apache_beam.runners.sdf_utils module<a class="headerlink" href="#module-apache_beam.runners.sdf_utils" title="Permalink to this headline"></a></h1>
<p>Common utility class to help SDK harness to execute an SDF.</p>
<dl class="class">
<dt id="apache_beam.runners.sdf_utils.SplitResultPrimary">
<em class="property">class </em><code class="descclassname">apache_beam.runners.sdf_utils.</code><code class="descname">SplitResultPrimary</code><span class="sig-paren">(</span><em>primary_value</em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.runners.sdf_utils.SplitResultPrimary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
<p>Create new instance of SplitResultPrimary(primary_value,)</p>
<dl class="attribute">
<dt id="apache_beam.runners.sdf_utils.SplitResultPrimary.primary_value">
<code class="descname">primary_value</code><a class="headerlink" href="#apache_beam.runners.sdf_utils.SplitResultPrimary.primary_value" title="Permalink to this definition"></a></dt>
<dd><p>Alias for field number 0</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.sdf_utils.SplitResultResidual">
<em class="property">class </em><code class="descclassname">apache_beam.runners.sdf_utils.</code><code class="descname">SplitResultResidual</code><span class="sig-paren">(</span><em>residual_value</em>, <em>current_watermark</em>, <em>deferred_timestamp</em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.runners.sdf_utils.SplitResultResidual" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
<p>Create new instance of SplitResultResidual(residual_value, current_watermark, deferred_timestamp)</p>
<dl class="attribute">
<dt id="apache_beam.runners.sdf_utils.SplitResultResidual.current_watermark">
<code class="descname">current_watermark</code><a class="headerlink" href="#apache_beam.runners.sdf_utils.SplitResultResidual.current_watermark" title="Permalink to this definition"></a></dt>
<dd><p>Alias for field number 1</p>
</dd></dl>
<dl class="attribute">
<dt id="apache_beam.runners.sdf_utils.SplitResultResidual.deferred_timestamp">
<code class="descname">deferred_timestamp</code><a class="headerlink" href="#apache_beam.runners.sdf_utils.SplitResultResidual.deferred_timestamp" title="Permalink to this definition"></a></dt>
<dd><p>Alias for field number 2</p>
</dd></dl>
<dl class="attribute">
<dt id="apache_beam.runners.sdf_utils.SplitResultResidual.residual_value">
<code class="descname">residual_value</code><a class="headerlink" href="#apache_beam.runners.sdf_utils.SplitResultResidual.residual_value" title="Permalink to this definition"></a></dt>
<dd><p>Alias for field number 0</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker">
<em class="property">class </em><code class="descclassname">apache_beam.runners.sdf_utils.</code><code class="descname">ThreadsafeRestrictionTracker</code><span class="sig-paren">(</span><em>restriction_tracker</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeRestrictionTracker"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker" 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.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>A thread-safe wrapper which wraps a <cite>RestritionTracker</cite>.</p>
<p>This wrapper guarantees synchronization of modifying restrictions across
multi-thread.</p>
<dl class="method">
<dt id="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.current_restriction">
<code class="descname">current_restriction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeRestrictionTracker.current_restriction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.current_restriction" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.try_claim">
<code class="descname">try_claim</code><span class="sig-paren">(</span><em>position</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeRestrictionTracker.try_claim"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.try_claim" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.defer_remainder">
<code class="descname">defer_remainder</code><span class="sig-paren">(</span><em>deferred_time=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeRestrictionTracker.defer_remainder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.defer_remainder" title="Permalink to this definition"></a></dt>
<dd><p>Performs self-checkpoint on current processing restriction with an
expected resuming time.</p>
<p>Self-checkpoint could happen during processing elements. When executing an
DoFn.process(), you may want to stop processing an element and resuming
later if current element has been processed quit a long time or you also
want to have some outputs from other elements. <code class="docutils literal notranslate"><span class="pre">defer_remainder()</span></code> can be
called on per element if needed.</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"><strong>deferred_time</strong> – A relative <code class="docutils literal notranslate"><span class="pre">Duration</span></code> that indicates the ideal time gap
between now and resuming, or an absolute <code class="docutils literal notranslate"><span class="pre">Timestamp</span></code> for resuming
execution time. If the time_delay is None, the deferred work will be
executed as soon as possible.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.check_done">
<code class="descname">check_done</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeRestrictionTracker.check_done"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.check_done" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.current_progress">
<code class="descname">current_progress</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeRestrictionTracker.current_progress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.current_progress" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.try_split">
<code class="descname">try_split</code><span class="sig-paren">(</span><em>fraction_of_remainder</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeRestrictionTracker.try_split"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.try_split" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.deferred_status">
<code class="descname">deferred_status</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeRestrictionTracker.deferred_status"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.deferred_status" title="Permalink to this definition"></a></dt>
<dd><p>Returns deferred work which is produced by <code class="docutils literal notranslate"><span class="pre">defer_remainder()</span></code>.</p>
<p>When there is a self-checkpoint performed, the system needs to fulfill the
DelayedBundleApplication with deferred_work for a ProcessBundleResponse.
The system calls this API to get deferred_residual with watermark together
to help the runner to schedule a future work.</p>
<p>Returns: (deferred_residual, time_delay) if having any residual, else None.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.sdf_utils.RestrictionTrackerView">
<em class="property">class </em><code class="descclassname">apache_beam.runners.sdf_utils.</code><code class="descname">RestrictionTrackerView</code><span class="sig-paren">(</span><em>threadsafe_restriction_tracker</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#RestrictionTrackerView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.RestrictionTrackerView" 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.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>A DoFn view of thread-safe RestrictionTracker.</p>
<p>The RestrictionTrackerView wraps a ThreadsafeRestrictionTracker and only
exposes APIs that will be called by a <code class="docutils literal notranslate"><span class="pre">DoFn.process()</span></code>. During execution
time, the RestrictionTrackerView will be fed into the <code class="docutils literal notranslate"><span class="pre">DoFn.process</span></code> as a
restriction_tracker.</p>
<dl class="method">
<dt id="apache_beam.runners.sdf_utils.RestrictionTrackerView.current_restriction">
<code class="descname">current_restriction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#RestrictionTrackerView.current_restriction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.RestrictionTrackerView.current_restriction" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.sdf_utils.RestrictionTrackerView.try_claim">
<code class="descname">try_claim</code><span class="sig-paren">(</span><em>position</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#RestrictionTrackerView.try_claim"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.RestrictionTrackerView.try_claim" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.sdf_utils.RestrictionTrackerView.defer_remainder">
<code class="descname">defer_remainder</code><span class="sig-paren">(</span><em>deferred_time=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#RestrictionTrackerView.defer_remainder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.RestrictionTrackerView.defer_remainder" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator">
<em class="property">class </em><code class="descclassname">apache_beam.runners.sdf_utils.</code><code class="descname">ThreadsafeWatermarkEstimator</code><span class="sig-paren">(</span><em>watermark_estimator</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeWatermarkEstimator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator" 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.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>A threadsafe wrapper which wraps a WatermarkEstimator with locking
mechanism to guarantee multi-thread safety.</p>
<dl class="method">
<dt id="apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator.get_estimator_state">
<code class="descname">get_estimator_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeWatermarkEstimator.get_estimator_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator.get_estimator_state" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator.current_watermark">
<code class="descname">current_watermark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeWatermarkEstimator.current_watermark"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator.current_watermark" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator.observe_timestamp">
<code class="descname">observe_timestamp</code><span class="sig-paren">(</span><em>timestamp</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeWatermarkEstimator.observe_timestamp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator.observe_timestamp" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.sdf_utils.NoOpWatermarkEstimatorProvider">
<em class="property">class </em><code class="descclassname">apache_beam.runners.sdf_utils.</code><code class="descname">NoOpWatermarkEstimatorProvider</code><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#NoOpWatermarkEstimatorProvider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.NoOpWatermarkEstimatorProvider" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.WatermarkEstimatorProvider" title="apache_beam.transforms.core.WatermarkEstimatorProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.core.WatermarkEstimatorProvider</span></code></a></p>
<p>A WatermarkEstimatorProvider which creates NoOpWatermarkEstimator for the
framework.</p>
<dl class="method">
<dt id="apache_beam.runners.sdf_utils.NoOpWatermarkEstimatorProvider.initial_estimator_state">
<code class="descname">initial_estimator_state</code><span class="sig-paren">(</span><em>element</em>, <em>restriction</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#NoOpWatermarkEstimatorProvider.initial_estimator_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.NoOpWatermarkEstimatorProvider.initial_estimator_state" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.sdf_utils.NoOpWatermarkEstimatorProvider.create_watermark_estimator">
<code class="descname">create_watermark_estimator</code><span class="sig-paren">(</span><em>estimator_state</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#NoOpWatermarkEstimatorProvider.create_watermark_estimator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.NoOpWatermarkEstimatorProvider.create_watermark_estimator" 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.testing.html" class="btn btn-neutral float-right" title="apache_beam.testing package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.runners.runner.html" class="btn btn-neutral float-left" title="apache_beam.runners.runner module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; 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>