pydoc/2.33.0/apache_beam.io.tfrecordio.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.io.tfrecordio 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 async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>

     <script type="text/javascript" src="_static/js/theme.js"></script>


   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="apache_beam.io.utils module" href="apache_beam.io.utils.html" />
     <link rel="prev" title="apache_beam.io.textio module" href="apache_beam.io.textio.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 current"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="apache_beam.io.html#subpackages">Subpackages</a></li>
 <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.io.html#submodules">Submodules</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.avroio.html">apache_beam.io.avroio module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.concat_source.html">apache_beam.io.concat_source module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.debezium.html">apache_beam.io.debezium module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filebasedsink.html">apache_beam.io.filebasedsink module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filebasedsource.html">apache_beam.io.filebasedsource module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.fileio.html">apache_beam.io.fileio module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystem.html">apache_beam.io.filesystem module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystemio.html">apache_beam.io.filesystemio module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystems.html">apache_beam.io.filesystems module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.hadoopfilesystem.html">apache_beam.io.hadoopfilesystem module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.iobase.html">apache_beam.io.iobase module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.jdbc.html">apache_beam.io.jdbc module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.kafka.html">apache_beam.io.kafka module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.kinesis.html">apache_beam.io.kinesis module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.localfilesystem.html">apache_beam.io.localfilesystem module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.mongodbio.html">apache_beam.io.mongodbio module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.parquetio.html">apache_beam.io.parquetio module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.range_trackers.html">apache_beam.io.range_trackers module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.restriction_trackers.html">apache_beam.io.restriction_trackers module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.snowflake.html">apache_beam.io.snowflake module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.source_test_utils.html">apache_beam.io.source_test_utils module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.textio.html">apache_beam.io.textio module</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.io.tfrecordio module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.utils.html">apache_beam.io.utils module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.watermark_estimators.html">apache_beam.io.watermark_estimators module</a></li>
 </ul>
 </li>
 </ul>
 </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="apache_beam.io.html">apache_beam.io package</a> &raquo;</li>

       <li>apache_beam.io.tfrecordio module</li>


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


             <a href="_sources/apache_beam.io.tfrecordio.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.io.tfrecordio">
 <span id="apache-beam-io-tfrecordio-module"></span><h1>apache_beam.io.tfrecordio module<a class="headerlink" href="#module-apache_beam.io.tfrecordio" title="Permalink to this headline">¶</a></h1>
 <p>TFRecord sources and sinks.</p>
 <dl class="class">
 <dt id="apache_beam.io.tfrecordio.ReadAllFromTFRecord">
 <em class="property">class </em><code class="descclassname">apache_beam.io.tfrecordio.</code><code class="descname">ReadAllFromTFRecord</code><span class="sig-paren">(</span><em>coder=BytesCoder</em>, <em>compression_type='auto'</em>, <em>with_filename=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/tfrecordio.html#ReadAllFromTFRecord"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.tfrecordio.ReadAllFromTFRecord" 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 reading a <code class="docutils literal notranslate"><span class="pre">PCollection</span></code> of TFRecord files.</p>
 <p>Initialize the <code class="docutils literal notranslate"><span class="pre">ReadAllFromTFRecord</span></code> transform.</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>coder</strong> – Coder used to decode each record.</li>
 <li><strong>compression_type</strong> – Used to handle compressed input files. Default value
 is CompressionTypes.AUTO, in which case the file_path’s extension will
 be used to detect the compression.</li>
 <li><strong>with_filename</strong> – If True, returns a Key Value with the key being the file
 name and the value being the actual data. If False, it only returns
 the data.</li>
 </ul>
 </td>
 </tr>
 </tbody>
 </table>
 <dl class="method">
 <dt id="apache_beam.io.tfrecordio.ReadAllFromTFRecord.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/io/tfrecordio.html#ReadAllFromTFRecord.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.tfrecordio.ReadAllFromTFRecord.expand" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.io.tfrecordio.ReadFromTFRecord">
 <em class="property">class </em><code class="descclassname">apache_beam.io.tfrecordio.</code><code class="descname">ReadFromTFRecord</code><span class="sig-paren">(</span><em>file_pattern</em>, <em>coder=BytesCoder</em>, <em>compression_type='auto'</em>, <em>validate=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/tfrecordio.html#ReadFromTFRecord"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.tfrecordio.ReadFromTFRecord" 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>Transform for reading TFRecord sources.</p>
 <p>Initialize a ReadFromTFRecord transform.</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>file_pattern</strong> – A file glob pattern to read TFRecords from.</li>
 <li><strong>coder</strong> – Coder used to decode each record.</li>
 <li><strong>compression_type</strong> – Used to handle compressed input files. Default value
 is CompressionTypes.AUTO, in which case the file_path’s extension will
 be used to detect the compression.</li>
 <li><strong>validate</strong> – Boolean flag to verify that the files exist during the pipeline
 creation time.</li>
 </ul>
 </td>
 </tr>
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A ReadFromTFRecord transform object.</p>
 </td>
 </tr>
 </tbody>
 </table>
 <dl class="method">
 <dt id="apache_beam.io.tfrecordio.ReadFromTFRecord.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/io/tfrecordio.html#ReadFromTFRecord.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.tfrecordio.ReadFromTFRecord.expand" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.io.tfrecordio.WriteToTFRecord">
 <em class="property">class </em><code class="descclassname">apache_beam.io.tfrecordio.</code><code class="descname">WriteToTFRecord</code><span class="sig-paren">(</span><em>file_path_prefix</em>, <em>coder=BytesCoder</em>, <em>file_name_suffix=''</em>, <em>num_shards=0</em>, <em>shard_name_template=None</em>, <em>compression_type='auto'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/tfrecordio.html#WriteToTFRecord"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.tfrecordio.WriteToTFRecord" 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>Transform for writing to TFRecord sinks.</p>
 <p>Initialize WriteToTFRecord transform.</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>file_path_prefix</strong> – The file path to write to. The files written will begin
 with this prefix, followed by a shard identifier (see num_shards), and
 end in a common extension, if given by file_name_suffix.</li>
 <li><strong>coder</strong> – Coder used to encode each record.</li>
 <li><strong>file_name_suffix</strong> – Suffix for the files written.</li>
 <li><strong>num_shards</strong> – The number of files (shards) used for output. If not set, the
 default value will be used.</li>
 <li><strong>shard_name_template</strong> – A template string containing placeholders for
 the shard number and shard count. When constructing a filename for a
 particular shard number, the upper-case letters ‘S’ and ‘N’ are
 replaced with the 0-padded shard number and shard count respectively.
 This argument can be ‘’ in which case it behaves as if num_shards was
 set to 1 and only one file will be generated. The default pattern used
 is ‘-SSSSS-of-NNNNN’ if None is passed as the shard_name_template.</li>
 <li><strong>compression_type</strong> – Used to handle compressed output files. Typical value
 is CompressionTypes.AUTO, in which case the file_path’s extension will
 be used to detect the compression.</li>
 </ul>
 </td>
 </tr>
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A WriteToTFRecord transform object.</p>
 </td>
 </tr>
 </tbody>
 </table>
 <dl class="method">
 <dt id="apache_beam.io.tfrecordio.WriteToTFRecord.expand">
 <code class="descname">expand</code><span class="sig-paren">(</span><em>pcoll</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/tfrecordio.html#WriteToTFRecord.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.tfrecordio.WriteToTFRecord.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.io.utils.html" class="btn btn-neutral float-right" title="apache_beam.io.utils module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


         <a href="apache_beam.io.textio.html" class="btn btn-neutral float-left" title="apache_beam.io.textio 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>


	<!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.io.tfrecordio module — 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 async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>

	<script type="text/javascript" src="_static/js/theme.js"></script>




	<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
	<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
	<link rel="index" title="Index" href="genindex.html" />
	<link rel="search" title="Search" href="search.html" />
	<link rel="next" title="apache_beam.io.utils module" href="apache_beam.io.utils.html" />
	<link rel="prev" title="apache_beam.io.textio module" href="apache_beam.io.textio.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 current"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a><ul class="current">
	<li class="toctree-l2"><a class="reference internal" href="apache_beam.io.html#subpackages">Subpackages</a></li>
	<li class="toctree-l2 current"><a class="reference internal" href="apache_beam.io.html#submodules">Submodules</a><ul class="current">
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.avroio.html">apache_beam.io.avroio module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.concat_source.html">apache_beam.io.concat_source module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.debezium.html">apache_beam.io.debezium module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filebasedsink.html">apache_beam.io.filebasedsink module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filebasedsource.html">apache_beam.io.filebasedsource module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.fileio.html">apache_beam.io.fileio module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystem.html">apache_beam.io.filesystem module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystemio.html">apache_beam.io.filesystemio module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystems.html">apache_beam.io.filesystems module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.hadoopfilesystem.html">apache_beam.io.hadoopfilesystem module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.iobase.html">apache_beam.io.iobase module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.jdbc.html">apache_beam.io.jdbc module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.kafka.html">apache_beam.io.kafka module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.kinesis.html">apache_beam.io.kinesis module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.localfilesystem.html">apache_beam.io.localfilesystem module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.mongodbio.html">apache_beam.io.mongodbio module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.parquetio.html">apache_beam.io.parquetio module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.range_trackers.html">apache_beam.io.range_trackers module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.restriction_trackers.html">apache_beam.io.restriction_trackers module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.snowflake.html">apache_beam.io.snowflake module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.source_test_utils.html">apache_beam.io.source_test_utils module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.textio.html">apache_beam.io.textio module</a></li>
	<li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.io.tfrecordio module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.utils.html">apache_beam.io.utils module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.watermark_estimators.html">apache_beam.io.watermark_estimators module</a></li>
	</ul>
	</li>
	</ul>
	</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> »</li>

	<li><a href="apache_beam.io.html">apache_beam.io package</a> »</li>

	<li>apache_beam.io.tfrecordio module</li>


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


	<a href="_sources/apache_beam.io.tfrecordio.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.io.tfrecordio">
	<span id="apache-beam-io-tfrecordio-module"></span><h1>apache_beam.io.tfrecordio module<a class="headerlink" href="#module-apache_beam.io.tfrecordio" title="Permalink to this headline">¶</a></h1>
	<p>TFRecord sources and sinks.</p>
	<dl class="class">
	<dt id="apache_beam.io.tfrecordio.ReadAllFromTFRecord">
	<em class="property">class </em><code class="descclassname">apache_beam.io.tfrecordio.</code><code class="descname">ReadAllFromTFRecord</code><span class="sig-paren">(</span><em>coder=BytesCoder</em>, <em>compression_type='auto'</em>, <em>with_filename=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/tfrecordio.html#ReadAllFromTFRecord"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.tfrecordio.ReadAllFromTFRecord" 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 reading a <code class="docutils literal notranslate"><span class="pre">PCollection</span></code> of TFRecord files.</p>
	<p>Initialize the <code class="docutils literal notranslate"><span class="pre">ReadAllFromTFRecord</span></code> transform.</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>coder</strong> – Coder used to decode each record.</li>
	<li><strong>compression_type</strong> – Used to handle compressed input files. Default value
	is CompressionTypes.AUTO, in which case the file_path’s extension will
	be used to detect the compression.</li>
	<li><strong>with_filename</strong> – If True, returns a Key Value with the key being the file
	name and the value being the actual data. If False, it only returns
	the data.</li>
	</ul>
	</td>
	</tr>
	</tbody>
	</table>
	<dl class="method">
	<dt id="apache_beam.io.tfrecordio.ReadAllFromTFRecord.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/io/tfrecordio.html#ReadAllFromTFRecord.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.tfrecordio.ReadAllFromTFRecord.expand" title="Permalink to this definition">¶</a></dt>
	<dd></dd></dl>

	</dd></dl>

	<dl class="class">
	<dt id="apache_beam.io.tfrecordio.ReadFromTFRecord">
	<em class="property">class </em><code class="descclassname">apache_beam.io.tfrecordio.</code><code class="descname">ReadFromTFRecord</code><span class="sig-paren">(</span><em>file_pattern</em>, <em>coder=BytesCoder</em>, <em>compression_type='auto'</em>, <em>validate=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/tfrecordio.html#ReadFromTFRecord"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.tfrecordio.ReadFromTFRecord" 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>Transform for reading TFRecord sources.</p>
	<p>Initialize a ReadFromTFRecord transform.</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>file_pattern</strong> – A file glob pattern to read TFRecords from.</li>
	<li><strong>coder</strong> – Coder used to decode each record.</li>
	<li><strong>compression_type</strong> – Used to handle compressed input files. Default value
	is CompressionTypes.AUTO, in which case the file_path’s extension will
	be used to detect the compression.</li>
	<li><strong>validate</strong> – Boolean flag to verify that the files exist during the pipeline
	creation time.</li>
	</ul>
	</td>
	</tr>
	<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A ReadFromTFRecord transform object.</p>
	</td>
	</tr>
	</tbody>
	</table>
	<dl class="method">
	<dt id="apache_beam.io.tfrecordio.ReadFromTFRecord.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/io/tfrecordio.html#ReadFromTFRecord.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.tfrecordio.ReadFromTFRecord.expand" title="Permalink to this definition">¶</a></dt>
	<dd></dd></dl>

	</dd></dl>

	<dl class="class">
	<dt id="apache_beam.io.tfrecordio.WriteToTFRecord">
	<em class="property">class </em><code class="descclassname">apache_beam.io.tfrecordio.</code><code class="descname">WriteToTFRecord</code><span class="sig-paren">(</span><em>file_path_prefix</em>, <em>coder=BytesCoder</em>, <em>file_name_suffix=''</em>, <em>num_shards=0</em>, <em>shard_name_template=None</em>, <em>compression_type='auto'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/tfrecordio.html#WriteToTFRecord"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.tfrecordio.WriteToTFRecord" 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>Transform for writing to TFRecord sinks.</p>
	<p>Initialize WriteToTFRecord transform.</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>file_path_prefix</strong> – The file path to write to. The files written will begin
	with this prefix, followed by a shard identifier (see num_shards), and
	end in a common extension, if given by file_name_suffix.</li>
	<li><strong>coder</strong> – Coder used to encode each record.</li>
	<li><strong>file_name_suffix</strong> – Suffix for the files written.</li>
	<li><strong>num_shards</strong> – The number of files (shards) used for output. If not set, the
	default value will be used.</li>
	<li><strong>shard_name_template</strong> – A template string containing placeholders for
	the shard number and shard count. When constructing a filename for a
	particular shard number, the upper-case letters ‘S’ and ‘N’ are
	replaced with the 0-padded shard number and shard count respectively.
	This argument can be ‘’ in which case it behaves as if num_shards was
	set to 1 and only one file will be generated. The default pattern used
	is ‘-SSSSS-of-NNNNN’ if None is passed as the shard_name_template.</li>
	<li><strong>compression_type</strong> – Used to handle compressed output files. Typical value
	is CompressionTypes.AUTO, in which case the file_path’s extension will
	be used to detect the compression.</li>
	</ul>
	</td>
	</tr>
	<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A WriteToTFRecord transform object.</p>
	</td>
	</tr>
	</tbody>
	</table>
	<dl class="method">
	<dt id="apache_beam.io.tfrecordio.WriteToTFRecord.expand">
	<code class="descname">expand</code><span class="sig-paren">(</span><em>pcoll</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/tfrecordio.html#WriteToTFRecord.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.tfrecordio.WriteToTFRecord.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.io.utils.html" class="btn btn-neutral float-right" title="apache_beam.io.utils module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


	<a href="apache_beam.io.textio.html" class="btn btn-neutral float-left" title="apache_beam.io.textio 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/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>