<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><htmlxmlns="http://www.w3.org/1999/xhtml"><head><metahttp-equiv="Content-Type"content="text/html; charset=UTF-8"/><title>TensorFlow.Records</title><linkhref="ocean.css"rel="stylesheet"type="text/css"title="Ocean"/><scriptsrc="haddock-util.js"type="text/javascript"></script><scriptsrc="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"type="text/javascript"></script><scripttype="text/javascript">//<![CDATA[
</script></head><body><divid="package-header"><ulclass="links"id="page-menu"><li><ahref="src/TensorFlow.Records.html">Source</a></li><li><ahref="index.html">Contents</a></li><li><ahref="doc-index.html">Index</a></li></ul><pclass="caption">tensorflow-records-0.1.0.0: Encoder and decoder for the TensorFlow \"TFRecords\" format.</p></div><divid="content"><divid="module-header"><tableclass="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><pclass="caption">TensorFlow.Records</p></div><divid="table-of-contents"><pclass="caption">Contents</p><ul><li><ahref="#g:1">Records</a></li><li><ahref="#g:2">Implementation</a></li></ul></div><divid="description"><pclass="caption">Description</p><divclass="doc"><p>Encoder and decoder for the TensorFlow "TFRecords" format.</p></div></div><divid="synopsis"><pid="control.syn"class="caption expander"onclick="toggleSection('syn')">Synopsis</p><ulid="section.syn"class="hide"onclick="toggleSection('syn')"><liclass="src short"><ahref="#v:putTFRecord">putTFRecord</a> :: <ahref="../bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> -> Put</li><liclass="src short"><ahref="#v:getTFRecord">getTFRecord</a> :: Get <ahref="../bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></li><liclass="src short"><ahref="#v:getTFRecords">getTFRecords</a> :: Get [<ahref="../bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a>]</li><liclass="src short"><ahref="#v:getTFRecordLength">getTFRecordLength</a> :: Get <ahref="../base-4.9.1.0/Data-Word.html#t:Word64">Word64</a></li><liclass="src short"><ahref="#v:getTFRecordData">getTFRecordData</a> :: <ahref="../base-4.9.1.0/Data-Word.html#t:Word64">Word64</a> -> Get <ahref="../bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></li><liclass="src short"><ahref="#v:putTFRecordLength">putTFRecordLength</a> :: <ahref="../base-4.9.1.0/Data-Word.html#t:Word64">Word64</a> -> Put</li><liclass="src short"><ahref="#v:putTFRecordData">putTFRecordData</a> :: <ahref="../bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> -> Put</li></ul></div><divid="interface"><h1id="g:1">Records</h1><divclass="top"><pclass="src"><aid="v:putTFRecord"class="def">putTFRecord</a> :: <ahref="../bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> -> Put <ahref="src/TensorFlow.Records.html#putTFRecord"class="link">Source</a><ahref="#v:putTFRecord"class="selflink">#</a></p><divclass="doc"><p>Put one TFRecord with the given contents.</p></div></div><divclass="top"><pclass="src"><aid="v:getTFRecord"class="def">getTFRecord</a> :: Get <ahref="../bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a><ahref="src/TensorFlow.Records.html#getTFRecord"class="link">Source</a><ahref="#v:getTFRecord"class="selflink">#</a></p><divclass="doc"><p>Parse one TFRecord.</p></div></div><divclass="top"><pclass="src"><aid="v:getTFRecords"class="def">getTFRecords</a> :: Get [<ahref="../bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a>] <ahref="src/TensorFlow.Records.html#getTFRecords"class="link">Source</a><ahref="#v:getTFRecords"class="selflink">#</a></p><divclass="doc"><p>Parse many TFRecords as a list. Note you probably want streaming instead
as provided by the tensorflow-records-conduit package.</p></div></div><h1id="g:2">Implementation</h1><divclass="doc"><p>These may be useful for encoding or decoding to types other than
<code>ByteString</code> that have their own Cereal codecs.</p></div><divclass="top"><pclass="src"><aid="v:getTFRecordLength"class="def">getTFRecordLength</a> :: Get <ahref="../base-4.9.1.0/Data-Word.html#t:Word64">Word64</a><ahref="src/TensorFlow.Records.html#getTFRecordLength"class="link">Source</a><ahref="#v:getTFRecordLength"class="selflink">#</a></p><divclass="doc"><p>Get a length and verify its checksum.</p></div></div><divclass="top"><pclass="src"><aid="v:getTFRecordData"class="def">getTFRecordData</a> :: <ahref="../base-4.9.1.0/Data-Word.html#t:Word64">Word64</a> -> Get <ahref="../bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a><ahref="src/TensorFlow.Records.html#getTFRecordData"class="link">Source</a><ahref="#v:getTFRecordData"class="selflink">#</a></p><divclass="doc"><p>Get a record payload and verify its checksum.</p></div></div><divclass="top"><pclass="src"><aid="v:putTFRecordLength"class="def">putTFRecordLength</a> :: <ahref="../base-4.9.1.0/Data-Word.html#t:Word64">Word64</a> -> Put <ahref="src/TensorFlow.Records.html#putTFRecordLength"class="link">Source</a><ahref="#v:putTFRecordLength"class="selflink">#</a></p><divclass="doc"><p>Put a record length and its checksum.</p></div></div><divclass="top"><pclass="src"><aid="v:putTFRecordData"class="def">putTFRecordData</a> :: <ahref="../bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> -> Put <ahref="src/TensorFlow.Records.html#putTFRecordData"class="link">Source</a><ahref="#v:putTFRecordData"class="selflink">#</a></p><divclass="doc"><p>Put a record payload and its checksum.</p></div></div></div></div><divid="footer"><p>Produced by <ahref="http://www.haskell.org/haddock/">Haddock</a> version 2.17.3</p></div></body></html>