mirror of
https://github.com/tensorflow/haskell.git
synced 2024-06-26 06:28:34 +02:00
6 lines
5.9 KiB
HTML
6 lines
5.9 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>TensorFlow.Records</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
|
|
window.onload = function () {pageLoad();};
|
|
//]]>
|
|
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/TensorFlow.Records.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">tensorflow-records-0.1.0.0: Encoder and decoder for the TensorFlow \"TFRecords\" format.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">TensorFlow.Records</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Records</a></li><li><a href="#g:2">Implementation</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Encoder and decoder for the TensorFlow "TFRecords" format.</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:putTFRecord">putTFRecord</a> :: <a href="../bytestring-0.10.8.2/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> -> Put</li><li class="src short"><a href="#v:getTFRecord">getTFRecord</a> :: Get <a href="../bytestring-0.10.8.2/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:getTFRecords">getTFRecords</a> :: Get [<a href="../bytestring-0.10.8.2/Data-ByteString-Lazy.html#t:ByteString">ByteString</a>]</li><li class="src short"><a href="#v:getTFRecordLength">getTFRecordLength</a> :: Get <a href="../base-4.10.1.0/Data-Word.html#t:Word64">Word64</a></li><li class="src short"><a href="#v:getTFRecordData">getTFRecordData</a> :: <a href="../base-4.10.1.0/Data-Word.html#t:Word64">Word64</a> -> Get <a href="../bytestring-0.10.8.2/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:putTFRecordLength">putTFRecordLength</a> :: <a href="../base-4.10.1.0/Data-Word.html#t:Word64">Word64</a> -> Put</li><li class="src short"><a href="#v:putTFRecordData">putTFRecordData</a> :: <a href="../bytestring-0.10.8.2/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> -> Put</li></ul></div><div id="interface"><h1 id="g:1">Records</h1><div class="top"><p class="src"><a id="v:putTFRecord" class="def">putTFRecord</a> :: <a href="../bytestring-0.10.8.2/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> -> Put <a href="src/TensorFlow.Records.html#putTFRecord" class="link">Source</a> <a href="#v:putTFRecord" class="selflink">#</a></p><div class="doc"><p>Put one TFRecord with the given contents.</p></div></div><div class="top"><p class="src"><a id="v:getTFRecord" class="def">getTFRecord</a> :: Get <a href="../bytestring-0.10.8.2/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> <a href="src/TensorFlow.Records.html#getTFRecord" class="link">Source</a> <a href="#v:getTFRecord" class="selflink">#</a></p><div class="doc"><p>Parse one TFRecord.</p></div></div><div class="top"><p class="src"><a id="v:getTFRecords" class="def">getTFRecords</a> :: Get [<a href="../bytestring-0.10.8.2/Data-ByteString-Lazy.html#t:ByteString">ByteString</a>] <a href="src/TensorFlow.Records.html#getTFRecords" class="link">Source</a> <a href="#v:getTFRecords" class="selflink">#</a></p><div class="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><h1 id="g:2">Implementation</h1><div class="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><div class="top"><p class="src"><a id="v:getTFRecordLength" class="def">getTFRecordLength</a> :: Get <a href="../base-4.10.1.0/Data-Word.html#t:Word64">Word64</a> <a href="src/TensorFlow.Records.html#getTFRecordLength" class="link">Source</a> <a href="#v:getTFRecordLength" class="selflink">#</a></p><div class="doc"><p>Get a length and verify its checksum.</p></div></div><div class="top"><p class="src"><a id="v:getTFRecordData" class="def">getTFRecordData</a> :: <a href="../base-4.10.1.0/Data-Word.html#t:Word64">Word64</a> -> Get <a href="../bytestring-0.10.8.2/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> <a href="src/TensorFlow.Records.html#getTFRecordData" class="link">Source</a> <a href="#v:getTFRecordData" class="selflink">#</a></p><div class="doc"><p>Get a record payload and verify its checksum.</p></div></div><div class="top"><p class="src"><a id="v:putTFRecordLength" class="def">putTFRecordLength</a> :: <a href="../base-4.10.1.0/Data-Word.html#t:Word64">Word64</a> -> Put <a href="src/TensorFlow.Records.html#putTFRecordLength" class="link">Source</a> <a href="#v:putTFRecordLength" class="selflink">#</a></p><div class="doc"><p>Put a record length and its checksum.</p></div></div><div class="top"><p class="src"><a id="v:putTFRecordData" class="def">putTFRecordData</a> :: <a href="../bytestring-0.10.8.2/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> -> Put <a href="src/TensorFlow.Records.html#putTFRecordData" class="link">Source</a> <a href="#v:putTFRecordData" class="selflink">#</a></p><div class="doc"><p>Put a record payload and its checksum.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.18.1</p></div></body></html> |