1
0
Fork 0
mirror of https://github.com/tensorflow/haskell.git synced 2024-12-26 19:49:46 +01:00
tensorflow-haskell/docs/haddock/tensorflow-queue-0.1.0.0/TensorFlow-Queue.html
Greg Steuck ea8b62e47b Haddock (#3)
* Trivial script for regenerating haddocks: exclude .haddock files.

* Haddock regen
2016-10-25 12:43:06 -07:00

9 lines
No EOL
7 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.Queue</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_TensorFlow-Queue.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/TensorFlow-Queue.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-queue-0.1.0.0: Basic access to TensorFlow queues.</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.Queue</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Queues in TensorFlow graph. Very limited support for now.</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"><span class="keyword">data</span> <a href="#t:Queue2">Queue2</a> a b</li><li class="src short"><a href="#v:makeQueue2">makeQueue2</a> :: <span class="keyword">forall</span> a b. (<a href="../tensorflow-0.1.0.0/TensorFlow-Types.html#t:TensorType">TensorType</a> a, <a href="../tensorflow-0.1.0.0/TensorFlow-Types.html#t:TensorType">TensorType</a> b) =&gt; <a href="../base-4.8.2.0/Data-Int.html#t:Int64">Int64</a> -&gt; <a href="../bytestring-0.10.6.0/Data-ByteString.html#t:ByteString">ByteString</a> -&gt; <a href="../tensorflow-0.1.0.0/TensorFlow-Build.html#t:Build">Build</a> (<a href="TensorFlow-Queue.html#t:Queue2">Queue2</a> a b)</li><li class="src short"><a href="#v:enqueue">enqueue</a> :: <span class="keyword">forall</span> a b v1 v2. (<a href="../tensorflow-0.1.0.0/TensorFlow-Types.html#t:TensorType">TensorType</a> a, <a href="../tensorflow-0.1.0.0/TensorFlow-Types.html#t:TensorType">TensorType</a> b) =&gt; <a href="TensorFlow-Queue.html#t:Queue2">Queue2</a> a b -&gt; <a href="../tensorflow-0.1.0.0/TensorFlow-Tensor.html#t:Tensor">Tensor</a> v1 a -&gt; <a href="../tensorflow-0.1.0.0/TensorFlow-Tensor.html#t:Tensor">Tensor</a> v2 b -&gt; <a href="../tensorflow-0.1.0.0/TensorFlow-Build.html#t:Build">Build</a> <a href="../tensorflow-0.1.0.0/TensorFlow-Output.html#t:ControlNode">ControlNode</a></li><li class="src short"><a href="#v:dequeue">dequeue</a> :: <span class="keyword">forall</span> a b. (<a href="../tensorflow-0.1.0.0/TensorFlow-Types.html#t:TensorType">TensorType</a> a, <a href="../tensorflow-0.1.0.0/TensorFlow-Types.html#t:TensorType">TensorType</a> b) =&gt; <a href="TensorFlow-Queue.html#t:Queue2">Queue2</a> a b -&gt; <a href="../tensorflow-0.1.0.0/TensorFlow-Build.html#t:Build">Build</a> (<a href="../tensorflow-0.1.0.0/TensorFlow-Tensor.html#t:Tensor">Tensor</a> <a href="../tensorflow-0.1.0.0/TensorFlow-Tensor.html#t:Ref">Ref</a> a, <a href="../tensorflow-0.1.0.0/TensorFlow-Tensor.html#t:Tensor">Tensor</a> <a href="../tensorflow-0.1.0.0/TensorFlow-Tensor.html#t:Ref">Ref</a> b)</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Queue2" class="def">Queue2</a> a b <a href="src/TensorFlow-Queue.html#Queue2" class="link">Source</a></p><div class="doc"><p>A queue carrying tuples. The underlying structure is more
versatile and can be made to support arbitrary tuples.</p></div></div><div class="top"><p class="src"><a name="v:makeQueue2" class="def">makeQueue2</a> <a href="src/TensorFlow-Queue.html#makeQueue2" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="../tensorflow-0.1.0.0/TensorFlow-Types.html#t:TensorType">TensorType</a> a, <a href="../tensorflow-0.1.0.0/TensorFlow-Types.html#t:TensorType">TensorType</a> b)</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">=&gt; <a href="../base-4.8.2.0/Data-Int.html#t:Int64">Int64</a></td><td class="doc"><p>The upper bound on the number of elements in
this queue. Negative numbers mean no limit.</p></td></tr><tr><td class="src">-&gt; <a href="../bytestring-0.10.6.0/Data-ByteString.html#t:ByteString">ByteString</a></td><td class="doc"><p>If non-empty, this queue will be shared
under the given name across multiple sessions.</p></td></tr><tr><td class="src">-&gt; <a href="../tensorflow-0.1.0.0/TensorFlow-Build.html#t:Build">Build</a> (<a href="TensorFlow-Queue.html#t:Queue2">Queue2</a> a b)</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Creates a new queue with the given capacity and shared name.</p></div></div><div class="top"><p class="src"><a name="v:enqueue" class="def">enqueue</a> :: <span class="keyword">forall</span> a b v1 v2. (<a href="../tensorflow-0.1.0.0/TensorFlow-Types.html#t:TensorType">TensorType</a> a, <a href="../tensorflow-0.1.0.0/TensorFlow-Types.html#t:TensorType">TensorType</a> b) =&gt; <a href="TensorFlow-Queue.html#t:Queue2">Queue2</a> a b -&gt; <a href="../tensorflow-0.1.0.0/TensorFlow-Tensor.html#t:Tensor">Tensor</a> v1 a -&gt; <a href="../tensorflow-0.1.0.0/TensorFlow-Tensor.html#t:Tensor">Tensor</a> v2 b -&gt; <a href="../tensorflow-0.1.0.0/TensorFlow-Build.html#t:Build">Build</a> <a href="../tensorflow-0.1.0.0/TensorFlow-Output.html#t:ControlNode">ControlNode</a> <a href="src/TensorFlow-Queue.html#enqueue" class="link">Source</a></p><div class="doc"><p>Adds the given values to the queue.</p></div></div><div class="top"><p class="src"><a name="v:dequeue" class="def">dequeue</a> <a href="src/TensorFlow-Queue.html#dequeue" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="../tensorflow-0.1.0.0/TensorFlow-Types.html#t:TensorType">TensorType</a> a, <a href="../tensorflow-0.1.0.0/TensorFlow-Types.html#t:TensorType">TensorType</a> b)</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">=&gt; <a href="TensorFlow-Queue.html#t:Queue2">Queue2</a> a b</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">-&gt; <a href="../tensorflow-0.1.0.0/TensorFlow-Build.html#t:Build">Build</a> (<a href="../tensorflow-0.1.0.0/TensorFlow-Tensor.html#t:Tensor">Tensor</a> <a href="../tensorflow-0.1.0.0/TensorFlow-Tensor.html#t:Ref">Ref</a> a, <a href="../tensorflow-0.1.0.0/TensorFlow-Tensor.html#t:Tensor">Tensor</a> <a href="../tensorflow-0.1.0.0/TensorFlow-Tensor.html#t:Ref">Ref</a> b)</td><td class="doc"><p>Dequeued tensors. They are paired in a sense
that values appear together, even if they are
not consumed together.</p></td></tr></table></div><div class="doc"><p>Retrieves the values from the queue.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.16.1</p></div></body></html>