blob: 19f31eed353038d046dd479c3bc64233ce07895c [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.ml.gcp.visionml 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.ml.gcp.visionml_test_it module" href="apache_beam.ml.gcp.visionml_test_it.html" />
<link rel="prev" title="apache_beam.ml.gcp.videointelligenceml_test_it module" href="apache_beam.ml.gcp.videointelligenceml_test_it.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 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 current"><a class="reference internal" href="apache_beam.ml.gcp.html">apache_beam.ml.gcp package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="apache_beam.ml.gcp.html#submodules">Submodules</a></li>
</ul>
</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.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.ml.html">apache_beam.ml package</a> &raquo;</li>
<li><a href="apache_beam.ml.gcp.html">apache_beam.ml.gcp package</a> &raquo;</li>
<li>apache_beam.ml.gcp.visionml module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.ml.gcp.visionml.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.gcp.visionml">
<span id="apache-beam-ml-gcp-visionml-module"></span><h1>apache_beam.ml.gcp.visionml module<a class="headerlink" href="#module-apache_beam.ml.gcp.visionml" title="Permalink to this headline"></a></h1>
<p>A connector for sending API requests to the GCP Vision API.</p>
<dl class="class">
<dt id="apache_beam.ml.gcp.visionml.AnnotateImage">
<em class="property">class </em><code class="descclassname">apache_beam.ml.gcp.visionml.</code><code class="descname">AnnotateImage</code><span class="sig-paren">(</span><em>features</em>, <em>retry=None</em>, <em>timeout=120</em>, <em>max_batch_size=None</em>, <em>min_batch_size=None</em>, <em>client_options=None</em>, <em>context_side_input=None</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/visionml.html#AnnotateImage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.visionml.AnnotateImage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p>
<p>A <code class="docutils literal notranslate"><span class="pre">PTransform</span></code> for annotating images using the GCP Vision API.
ref: <a class="reference external" href="https://cloud.google.com/vision/docs/">https://cloud.google.com/vision/docs/</a></p>
<p>Batches elements together using <code class="docutils literal notranslate"><span class="pre">util.BatchElements</span></code> PTransform and sends
each batch of elements to the GCP Vision API.
Element is a Union[text_type, binary_type] of either an URI (e.g. a GCS URI)
or binary_type base64-encoded image data.
Accepts an <cite>AsDict</cite> side input that maps each image to an image context.</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>features</strong> – (List[<code class="docutils literal notranslate"><span class="pre">vision.types.Feature.enums.Feature</span></code>]) Required.
The Vision API features to detect</li>
<li><strong>retry</strong> – (google.api_core.retry.Retry) Optional.
A retry object used to retry requests.
If None is specified (default), requests will not be retried.</li>
<li><strong>timeout</strong> – (float) Optional.
The time in seconds to wait for the response from the Vision API.
Default is 120.</li>
<li><strong>max_batch_size</strong> – (int) Optional.
Maximum number of images to batch in the same request to the Vision API.
Default is 5 (which is also the Vision API max).
This parameter is primarily intended for testing.</li>
<li><strong>min_batch_size</strong> – (int) Optional.
Minimum number of images to batch in the same request to the Vision API.
Default is None. This parameter is primarily intended for testing.</li>
<li><strong>client_options</strong> – (Union[dict, google.api_core.client_options.ClientOptions]) Optional.
Client options used to set user options on the client.
API Endpoint should be set through client_options.</li>
<li><strong>context_side_input</strong><p>(beam.pvalue.AsDict) Optional.
An <code class="docutils literal notranslate"><span class="pre">AsDict</span></code> of a PCollection to be passed to the
_ImageAnnotateFn as the image context mapping containing additional
image context and/or feature-specific parameters.
Example usage:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>image_contexts =
[(&#39;&#39;gs://cloud-samples-data/vision/ocr/sign.jpg&#39;&#39;, Union[dict,
``vision.types.ImageContext()``]),
(&#39;&#39;gs://cloud-samples-data/vision/ocr/sign.jpg&#39;&#39;, Union[dict,
``vision.types.ImageContext()``]),]
context_side_input =
(
p
| &quot;Image contexts&quot; &gt;&gt; beam.Create(image_contexts)
)
visionml.AnnotateImage(features,
context_side_input=beam.pvalue.AsDict(context_side_input)))
</pre></div>
</div>
</li>
<li><strong>metadata</strong> – (Optional[Sequence[Tuple[str, str]]]): Optional.
Additional metadata that is provided to the method.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="apache_beam.ml.gcp.visionml.AnnotateImage.MAX_BATCH_SIZE">
<code class="descname">MAX_BATCH_SIZE</code><em class="property"> = 5</em><a class="headerlink" href="#apache_beam.ml.gcp.visionml.AnnotateImage.MAX_BATCH_SIZE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.ml.gcp.visionml.AnnotateImage.MIN_BATCH_SIZE">
<code class="descname">MIN_BATCH_SIZE</code><em class="property"> = 1</em><a class="headerlink" href="#apache_beam.ml.gcp.visionml.AnnotateImage.MIN_BATCH_SIZE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.ml.gcp.visionml.AnnotateImage.expand">
<code class="descname">expand</code><span class="sig-paren">(</span><em>pvalue</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/visionml.html#AnnotateImage.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.visionml.AnnotateImage.expand" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.ml.gcp.visionml.AnnotateImageWithContext">
<em class="property">class </em><code class="descclassname">apache_beam.ml.gcp.visionml.</code><code class="descname">AnnotateImageWithContext</code><span class="sig-paren">(</span><em>features</em>, <em>retry=None</em>, <em>timeout=120</em>, <em>max_batch_size=None</em>, <em>min_batch_size=None</em>, <em>client_options=None</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/visionml.html#AnnotateImageWithContext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.visionml.AnnotateImageWithContext" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.ml.gcp.visionml.AnnotateImage" title="apache_beam.ml.gcp.visionml.AnnotateImage"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.ml.gcp.visionml.AnnotateImage</span></code></a></p>
<p>A <code class="docutils literal notranslate"><span class="pre">PTransform</span></code> for annotating images using the GCP Vision API.
ref: <a class="reference external" href="https://cloud.google.com/vision/docs/">https://cloud.google.com/vision/docs/</a>
Batches elements together using <code class="docutils literal notranslate"><span class="pre">util.BatchElements</span></code> PTransform and sends
each batch of elements to the GCP Vision API.</p>
<p>Element is a tuple of:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>(Union[text_type, binary_type],
Optional[``vision.types.ImageContext``])
</pre></div>
</div>
<p>where the former is either an URI (e.g. a GCS URI) or binary_type
base64-encoded image data.</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>features</strong> – (List[<code class="docutils literal notranslate"><span class="pre">vision.types.Feature.enums.Feature</span></code>]) Required.
The Vision API features to detect</li>
<li><strong>retry</strong> – (google.api_core.retry.Retry) Optional.
A retry object used to retry requests.
If None is specified (default), requests will not be retried.</li>
<li><strong>timeout</strong> – (float) Optional.
The time in seconds to wait for the response from the Vision API.
Default is 120.</li>
<li><strong>max_batch_size</strong> – (int) Optional.
Maximum number of images to batch in the same request to the Vision API.
Default is 5 (which is also the Vision API max).
This parameter is primarily intended for testing.</li>
<li><strong>min_batch_size</strong> – (int) Optional.
Minimum number of images to batch in the same request to the Vision API.
Default is None. This parameter is primarily intended for testing.</li>
<li><strong>client_options</strong> – (Union[dict, google.api_core.client_options.ClientOptions]) Optional.
Client options used to set user options on the client.
API Endpoint should be set through client_options.</li>
<li><strong>metadata</strong> – (Optional[Sequence[Tuple[str, str]]]): Optional.
Additional metadata that is provided to the method.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="apache_beam.ml.gcp.visionml.AnnotateImageWithContext.expand">
<code class="descname">expand</code><span class="sig-paren">(</span><em>pvalue</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/visionml.html#AnnotateImageWithContext.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.visionml.AnnotateImageWithContext.expand" 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.gcp.visionml_test_it.html" class="btn btn-neutral float-right" title="apache_beam.ml.gcp.visionml_test_it module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.ml.gcp.videointelligenceml_test_it.html" class="btn btn-neutral float-left" title="apache_beam.ml.gcp.videointelligenceml_test_it 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>