pydoc/2.38.0/_modules/apache_beam/ml/gcp/visionml.html - beam-site - Git at Google



 <!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 &mdash; Apache Beam 2.38.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" />
 </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.38.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>
 <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"><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>
 </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="../../../index.html">Module code</a> &raquo;</li>

       <li>apache_beam.ml.gcp.visionml</li>


       <li class="wy-breadcrumbs-aside">

       </li>

   </ul>


   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">

   <h1>Source code for apache_beam.ml.gcp.visionml</h1><div class="highlight"><pre>
 <span></span><span class="c1"># pylint: skip-file</span>
 <span class="c1">#</span>
 <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
 <span class="c1"># contributor license agreements.  See the NOTICE file distributed with</span>
 <span class="c1"># this work for additional information regarding copyright ownership.</span>
 <span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
 <span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
 <span class="c1"># the License.  You may obtain a copy of the License at</span>
 <span class="c1">#</span>
 <span class="c1">#    http://www.apache.org/licenses/LICENSE-2.0</span>
 <span class="c1">#</span>
 <span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
 <span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
 <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
 <span class="c1"># See the License for the specific language governing permissions and</span>
 <span class="c1"># limitations under the License.</span>
 <span class="c1">#</span>

 <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">A connector for sending API requests to the GCP Vision API.</span>
 <span class="sd">&quot;&quot;&quot;</span>

 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Tuple</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Union</span>

 <span class="kn">from</span> <span class="nn">apache_beam</span> <span class="kn">import</span> <span class="n">typehints</span>
 <span class="kn">from</span> <span class="nn">apache_beam.metrics</span> <span class="kn">import</span> <span class="n">Metrics</span>
 <span class="kn">from</span> <span class="nn">apache_beam.transforms</span> <span class="kn">import</span> <span class="n">DoFn</span>
 <span class="kn">from</span> <span class="nn">apache_beam.transforms</span> <span class="kn">import</span> <span class="n">FlatMap</span>
 <span class="kn">from</span> <span class="nn">apache_beam.transforms</span> <span class="kn">import</span> <span class="n">ParDo</span>
 <span class="kn">from</span> <span class="nn">apache_beam.transforms</span> <span class="kn">import</span> <span class="n">PTransform</span>
 <span class="kn">from</span> <span class="nn">apache_beam.transforms</span> <span class="kn">import</span> <span class="n">util</span>
 <span class="kn">from</span> <span class="nn">cachetools.func</span> <span class="kn">import</span> <span class="n">ttl_cache</span>

 <span class="k">try</span><span class="p">:</span>
   <span class="kn">from</span> <span class="nn">google.cloud</span> <span class="kn">import</span> <span class="n">vision</span>
 <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
   <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span>
       <span class="s1">&#39;Google Cloud Vision not supported for this execution environment &#39;</span>
       <span class="s1">&#39;(could not import google.cloud.vision).&#39;</span><span class="p">)</span>

 <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
     <span class="s1">&#39;AnnotateImage&#39;</span><span class="p">,</span>
     <span class="s1">&#39;AnnotateImageWithContext&#39;</span><span class="p">,</span>
 <span class="p">]</span>


 <span class="nd">@ttl_cache</span><span class="p">(</span><span class="n">maxsize</span><span class="o">=</span><span class="mi">128</span><span class="p">,</span> <span class="n">ttl</span><span class="o">=</span><span class="mi">3600</span><span class="p">)</span>
 <span class="k">def</span> <span class="nf">get_vision_client</span><span class="p">(</span><span class="n">client_options</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
   <span class="sd">&quot;&quot;&quot;Returns a Cloud Vision API client.&quot;&quot;&quot;</span>
   <span class="n">_client</span> <span class="o">=</span> <span class="n">vision</span><span class="o">.</span><span class="n">ImageAnnotatorClient</span><span class="p">(</span><span class="n">client_options</span><span class="o">=</span><span class="n">client_options</span><span class="p">)</span>
   <span class="k">return</span> <span class="n">_client</span>


 <div class="viewcode-block" id="AnnotateImage"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.visionml.html#apache_beam.ml.gcp.visionml.AnnotateImage">[docs]</a><span class="k">class</span> <span class="nc">AnnotateImage</span><span class="p">(</span><span class="n">PTransform</span><span class="p">):</span>
   <span class="sd">&quot;&quot;&quot;A ``PTransform`` for annotating images using the GCP Vision API.</span>
 <span class="sd">  ref: https://cloud.google.com/vision/docs/</span>

 <span class="sd">  Batches elements together using ``util.BatchElements`` PTransform and sends</span>
 <span class="sd">  each batch of elements to the GCP Vision API.</span>
 <span class="sd">  Element is a Union[str, bytes] of either an URI (e.g. a GCS URI)</span>
 <span class="sd">  or bytes base64-encoded image data.</span>
 <span class="sd">  Accepts an `AsDict` side input that maps each image to an image context.</span>
 <span class="sd">  &quot;&quot;&quot;</span>

   <span class="n">MAX_BATCH_SIZE</span> <span class="o">=</span> <span class="mi">5</span>
   <span class="n">MIN_BATCH_SIZE</span> <span class="o">=</span> <span class="mi">1</span>

   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
       <span class="bp">self</span><span class="p">,</span>
       <span class="n">features</span><span class="p">,</span>
       <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">timeout</span><span class="o">=</span><span class="mi">120</span><span class="p">,</span>
       <span class="n">max_batch_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">min_batch_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">client_options</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">context_side_input</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Args:</span>
 <span class="sd">      features: (List[``vision.types.Feature.enums.Feature``]) Required.</span>
 <span class="sd">        The Vision API features to detect</span>
 <span class="sd">      retry: (google.api_core.retry.Retry) Optional.</span>
 <span class="sd">        A retry object used to retry requests.</span>
 <span class="sd">        If None is specified (default), requests will not be retried.</span>
 <span class="sd">      timeout: (float) Optional.</span>
 <span class="sd">        The time in seconds to wait for the response from the Vision API.</span>
 <span class="sd">        Default is 120.</span>
 <span class="sd">      max_batch_size: (int) Optional.</span>
 <span class="sd">        Maximum number of images to batch in the same request to the Vision API.</span>
 <span class="sd">        Default is 5 (which is also the Vision API max).</span>
 <span class="sd">        This parameter is primarily intended for testing.</span>
 <span class="sd">      min_batch_size: (int) Optional.</span>
 <span class="sd">        Minimum number of images to batch in the same request to the Vision API.</span>
 <span class="sd">        Default is None. This parameter is primarily intended for testing.</span>
 <span class="sd">      client_options:</span>
 <span class="sd">        (Union[dict, google.api_core.client_options.ClientOptions]) Optional.</span>
 <span class="sd">        Client options used to set user options on the client.</span>
 <span class="sd">        API Endpoint should be set through client_options.</span>
 <span class="sd">      context_side_input: (beam.pvalue.AsDict) Optional.</span>
 <span class="sd">        An ``AsDict`` of a PCollection to be passed to the</span>
 <span class="sd">        _ImageAnnotateFn as the image context mapping containing additional</span>
 <span class="sd">        image context and/or feature-specific parameters.</span>
 <span class="sd">        Example usage::</span>

 <span class="sd">          image_contexts =</span>
 <span class="sd">            [(&#39;&#39;gs://cloud-samples-data/vision/ocr/sign.jpg&#39;&#39;, Union[dict,</span>
 <span class="sd">            ``vision.types.ImageContext()``]),</span>
 <span class="sd">            (&#39;&#39;gs://cloud-samples-data/vision/ocr/sign.jpg&#39;&#39;, Union[dict,</span>
 <span class="sd">            ``vision.types.ImageContext()``]),]</span>

 <span class="sd">          context_side_input =</span>
 <span class="sd">            (</span>
 <span class="sd">              p</span>
 <span class="sd">              | &quot;Image contexts&quot; &gt;&gt; beam.Create(image_contexts)</span>
 <span class="sd">            )</span>

 <span class="sd">          visionml.AnnotateImage(features,</span>
 <span class="sd">            context_side_input=beam.pvalue.AsDict(context_side_input)))</span>
 <span class="sd">      metadata: (Optional[Sequence[Tuple[str, str]]]): Optional.</span>
 <span class="sd">        Additional metadata that is provided to the method.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">features</span> <span class="o">=</span> <span class="n">features</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">max_batch_size</span> <span class="o">=</span> <span class="n">max_batch_size</span> <span class="ow">or</span> <span class="n">AnnotateImage</span><span class="o">.</span><span class="n">MAX_BATCH_SIZE</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_batch_size</span> <span class="o">&gt;</span> <span class="n">AnnotateImage</span><span class="o">.</span><span class="n">MAX_BATCH_SIZE</span><span class="p">:</span>
       <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
           <span class="s1">&#39;Max batch_size exceeded. &#39;</span>
           <span class="s1">&#39;Batch size needs to be smaller than </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
               <span class="n">AnnotateImage</span><span class="o">.</span><span class="n">MAX_BATCH_SIZE</span><span class="p">))</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">min_batch_size</span> <span class="o">=</span> <span class="n">min_batch_size</span> <span class="ow">or</span> <span class="n">AnnotateImage</span><span class="o">.</span><span class="n">MIN_BATCH_SIZE</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">client_options</span> <span class="o">=</span> <span class="n">client_options</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">context_side_input</span> <span class="o">=</span> <span class="n">context_side_input</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span>

 <div class="viewcode-block" id="AnnotateImage.expand"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.visionml.html#apache_beam.ml.gcp.visionml.AnnotateImage.expand">[docs]</a>  <span class="k">def</span> <span class="nf">expand</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pvalue</span><span class="p">):</span>
     <span class="k">return</span> <span class="p">(</span>
         <span class="n">pvalue</span>
         <span class="o">|</span> <span class="n">FlatMap</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_create_image_annotation_pairs</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">context_side_input</span><span class="p">)</span>
         <span class="o">|</span> <span class="n">util</span><span class="o">.</span><span class="n">BatchElements</span><span class="p">(</span>
             <span class="n">min_batch_size</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">min_batch_size</span><span class="p">,</span>
             <span class="n">max_batch_size</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">max_batch_size</span><span class="p">)</span>
         <span class="o">|</span> <span class="n">ParDo</span><span class="p">(</span>
             <span class="n">_ImageAnnotateFn</span><span class="p">(</span>
                 <span class="n">features</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">features</span><span class="p">,</span>
                 <span class="n">retry</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">retry</span><span class="p">,</span>
                 <span class="n">timeout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">,</span>
                 <span class="n">client_options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">client_options</span><span class="p">,</span>
                 <span class="n">metadata</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">)))</span></div>

   <span class="nd">@typehints</span><span class="o">.</span><span class="n">with_input_types</span><span class="p">(</span>
       <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">],</span> <span class="n">Optional</span><span class="p">[</span><span class="n">vision</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">ImageContext</span><span class="p">])</span>
   <span class="nd">@typehints</span><span class="o">.</span><span class="n">with_output_types</span><span class="p">(</span><span class="n">List</span><span class="p">[</span><span class="n">vision</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">AnnotateImageRequest</span><span class="p">])</span>
   <span class="k">def</span> <span class="nf">_create_image_annotation_pairs</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">,</span> <span class="n">context_side_input</span><span class="p">):</span>
     <span class="k">if</span> <span class="n">context_side_input</span><span class="p">:</span>  <span class="c1"># If we have a side input image context, use that</span>
       <span class="n">image_context</span> <span class="o">=</span> <span class="n">context_side_input</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">element</span><span class="p">)</span>
     <span class="k">else</span><span class="p">:</span>
       <span class="n">image_context</span> <span class="o">=</span> <span class="kc">None</span>

     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">element</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
       <span class="n">image</span> <span class="o">=</span> <span class="n">vision</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Image</span><span class="p">(</span>
           <span class="n">source</span><span class="o">=</span><span class="n">vision</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">ImageSource</span><span class="p">(</span><span class="n">image_uri</span><span class="o">=</span><span class="n">element</span><span class="p">))</span>
     <span class="k">else</span><span class="p">:</span>  <span class="c1"># Typehint checks only allows str or bytes</span>
       <span class="n">image</span> <span class="o">=</span> <span class="n">vision</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Image</span><span class="p">(</span><span class="n">content</span><span class="o">=</span><span class="n">element</span><span class="p">)</span>

     <span class="n">request</span> <span class="o">=</span> <span class="n">vision</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">AnnotateImageRequest</span><span class="p">(</span>
         <span class="n">image</span><span class="o">=</span><span class="n">image</span><span class="p">,</span> <span class="n">features</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">features</span><span class="p">,</span> <span class="n">image_context</span><span class="o">=</span><span class="n">image_context</span><span class="p">)</span>
     <span class="k">yield</span> <span class="n">request</span></div>


 <div class="viewcode-block" id="AnnotateImageWithContext"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.visionml.html#apache_beam.ml.gcp.visionml.AnnotateImageWithContext">[docs]</a><span class="k">class</span> <span class="nc">AnnotateImageWithContext</span><span class="p">(</span><span class="n">AnnotateImage</span><span class="p">):</span>
   <span class="sd">&quot;&quot;&quot;A ``PTransform`` for annotating images using the GCP Vision API.</span>
 <span class="sd">  ref: https://cloud.google.com/vision/docs/</span>
 <span class="sd">  Batches elements together using ``util.BatchElements`` PTransform and sends</span>
 <span class="sd">  each batch of elements to the GCP Vision API.</span>

 <span class="sd">  Element is a tuple of::</span>

 <span class="sd">    (Union[str, bytes],</span>
 <span class="sd">    Optional[``vision.types.ImageContext``])</span>

 <span class="sd">  where the former is either an URI (e.g. a GCS URI) or bytes</span>
 <span class="sd">  base64-encoded image data.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
       <span class="bp">self</span><span class="p">,</span>
       <span class="n">features</span><span class="p">,</span>
       <span class="n">retry</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">timeout</span><span class="o">=</span><span class="mi">120</span><span class="p">,</span>
       <span class="n">max_batch_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">min_batch_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">client_options</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Args:</span>
 <span class="sd">      features: (List[``vision.types.Feature.enums.Feature``]) Required.</span>
 <span class="sd">        The Vision API features to detect</span>
 <span class="sd">      retry: (google.api_core.retry.Retry) Optional.</span>
 <span class="sd">        A retry object used to retry requests.</span>
 <span class="sd">        If None is specified (default), requests will not be retried.</span>
 <span class="sd">      timeout: (float) Optional.</span>
 <span class="sd">        The time in seconds to wait for the response from the Vision API.</span>
 <span class="sd">        Default is 120.</span>
 <span class="sd">      max_batch_size: (int) Optional.</span>
 <span class="sd">        Maximum number of images to batch in the same request to the Vision API.</span>
 <span class="sd">        Default is 5 (which is also the Vision API max).</span>
 <span class="sd">        This parameter is primarily intended for testing.</span>
 <span class="sd">      min_batch_size: (int) Optional.</span>
 <span class="sd">        Minimum number of images to batch in the same request to the Vision API.</span>
 <span class="sd">        Default is None. This parameter is primarily intended for testing.</span>
 <span class="sd">      client_options:</span>
 <span class="sd">        (Union[dict, google.api_core.client_options.ClientOptions]) Optional.</span>
 <span class="sd">        Client options used to set user options on the client.</span>
 <span class="sd">        API Endpoint should be set through client_options.</span>
 <span class="sd">      metadata: (Optional[Sequence[Tuple[str, str]]]): Optional.</span>
 <span class="sd">        Additional metadata that is provided to the method.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span>
         <span class="n">features</span><span class="o">=</span><span class="n">features</span><span class="p">,</span>
         <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span>
         <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span>
         <span class="n">max_batch_size</span><span class="o">=</span><span class="n">max_batch_size</span><span class="p">,</span>
         <span class="n">min_batch_size</span><span class="o">=</span><span class="n">min_batch_size</span><span class="p">,</span>
         <span class="n">client_options</span><span class="o">=</span><span class="n">client_options</span><span class="p">,</span>
         <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">)</span>

 <div class="viewcode-block" id="AnnotateImageWithContext.expand"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.visionml.html#apache_beam.ml.gcp.visionml.AnnotateImageWithContext.expand">[docs]</a>  <span class="k">def</span> <span class="nf">expand</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pvalue</span><span class="p">):</span>
     <span class="k">return</span> <span class="p">(</span>
         <span class="n">pvalue</span>
         <span class="o">|</span> <span class="n">FlatMap</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_create_image_annotation_pairs</span><span class="p">)</span>
         <span class="o">|</span> <span class="n">util</span><span class="o">.</span><span class="n">BatchElements</span><span class="p">(</span>
             <span class="n">min_batch_size</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">min_batch_size</span><span class="p">,</span>
             <span class="n">max_batch_size</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">max_batch_size</span><span class="p">)</span>
         <span class="o">|</span> <span class="n">ParDo</span><span class="p">(</span>
             <span class="n">_ImageAnnotateFn</span><span class="p">(</span>
                 <span class="n">features</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">features</span><span class="p">,</span>
                 <span class="n">retry</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">retry</span><span class="p">,</span>
                 <span class="n">timeout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">,</span>
                 <span class="n">client_options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">client_options</span><span class="p">,</span>
                 <span class="n">metadata</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">)))</span></div>

   <span class="nd">@typehints</span><span class="o">.</span><span class="n">with_input_types</span><span class="p">(</span>
       <span class="n">Tuple</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">],</span> <span class="n">Optional</span><span class="p">[</span><span class="n">vision</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">ImageContext</span><span class="p">]])</span>
   <span class="nd">@typehints</span><span class="o">.</span><span class="n">with_output_types</span><span class="p">(</span><span class="n">List</span><span class="p">[</span><span class="n">vision</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">AnnotateImageRequest</span><span class="p">])</span>
   <span class="k">def</span> <span class="nf">_create_image_annotation_pairs</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
     <span class="n">element</span><span class="p">,</span> <span class="n">image_context</span> <span class="o">=</span> <span class="n">element</span>  <span class="c1"># Unpack (image, image_context) tuple</span>
     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">element</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
       <span class="n">image</span> <span class="o">=</span> <span class="n">vision</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Image</span><span class="p">(</span>
           <span class="n">source</span><span class="o">=</span><span class="n">vision</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">ImageSource</span><span class="p">(</span><span class="n">image_uri</span><span class="o">=</span><span class="n">element</span><span class="p">))</span>
     <span class="k">else</span><span class="p">:</span>  <span class="c1"># Typehint checks only allows str or bytes</span>
       <span class="n">image</span> <span class="o">=</span> <span class="n">vision</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Image</span><span class="p">(</span><span class="n">content</span><span class="o">=</span><span class="n">element</span><span class="p">)</span>

     <span class="n">request</span> <span class="o">=</span> <span class="n">vision</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">AnnotateImageRequest</span><span class="p">(</span>
         <span class="n">image</span><span class="o">=</span><span class="n">image</span><span class="p">,</span> <span class="n">features</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">features</span><span class="p">,</span> <span class="n">image_context</span><span class="o">=</span><span class="n">image_context</span><span class="p">)</span>
     <span class="k">yield</span> <span class="n">request</span></div>


 <span class="nd">@typehints</span><span class="o">.</span><span class="n">with_input_types</span><span class="p">(</span><span class="n">List</span><span class="p">[</span><span class="n">vision</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">AnnotateImageRequest</span><span class="p">])</span>
 <span class="k">class</span> <span class="nc">_ImageAnnotateFn</span><span class="p">(</span><span class="n">DoFn</span><span class="p">):</span>
   <span class="sd">&quot;&quot;&quot;A DoFn that sends each input element to the GCP Vision API.</span>
 <span class="sd">  Returns ``google.cloud.vision.types.BatchAnnotateImagesResponse``.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">features</span><span class="p">,</span> <span class="n">retry</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">client_options</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
     <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="kc">None</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">features</span> <span class="o">=</span> <span class="n">features</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">client_options</span> <span class="o">=</span> <span class="n">client_options</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">counter</span> <span class="o">=</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">counter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="p">,</span> <span class="s2">&quot;API Calls&quot;</span><span class="p">)</span>

   <span class="k">def</span> <span class="nf">setup</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">get_vision_client</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">client_options</span><span class="p">)</span>

   <span class="k">def</span> <span class="nf">process</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
     <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">batch_annotate_images</span><span class="p">(</span>
         <span class="n">requests</span><span class="o">=</span><span class="n">element</span><span class="p">,</span>
         <span class="n">retry</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">retry</span><span class="p">,</span>
         <span class="n">timeout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">,</span>
         <span class="n">metadata</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">counter</span><span class="o">.</span><span class="n">inc</span><span class="p">()</span>
     <span class="k">yield</span> <span class="n">response</span>
 </pre></div>

            </div>

           </div>
           <footer>


   <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>