mirror of
https://github.com/tensorflow/haskell.git
synced 2024-12-28 12:39:46 +01:00
6b19e54722
* Update README to refer to 2.3.0-gpu. * Remove old package documentation from haddock directory.
5 lines
No EOL
7.4 KiB
HTML
5 lines
No EOL
7.4 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" /><meta name="viewport" content="width=device-width, initial-scale=1" /><title>TensorFlow.Queue</title><link href="linuwial.css" rel="stylesheet" type="text/css" title="Linuwial" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=PT+Sans:400,400i,700" /><script src="haddock-bundle.min.js" async="async" type="text/javascript"></script><script type="text/x-mathjax-config">MathJax.Hub.Config({ tex2jax: { processClass: "mathjax", ignoreClass: ".*" } });</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script></head><body><div id="package-header"><span class="caption">tensorflow-ops-0.3.0.0: Friendly layer around TensorFlow bindings.</span><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></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"><details id="syn"><summary>Synopsis</summary><ul class="details-toggle" data-details-id="syn"><li class="src short"><span class="keyword">data</span> <a href="#t:Queue">Queue</a> (as :: [*])</li><li class="src short"><a href="#v:makeQueue">makeQueue</a> :: <span class="keyword">forall</span> as m. (<a href="../tensorflow-0.3.0.0/TensorFlow-Build.html#t:MonadBuild" title="TensorFlow.Build">MonadBuild</a> m, <a href="../tensorflow-0.3.0.0/TensorFlow-Types.html#t:TensorTypes" title="TensorFlow.Types">TensorTypes</a> as) => <a href="../base-4.13.0.0/Data-Int.html#t:Int64" title="Data.Int">Int64</a> -> <a href="../bytestring-0.10.10.1/Data-ByteString.html#t:ByteString" title="Data.ByteString">ByteString</a> -> m (<a href="TensorFlow-Queue.html#t:Queue" title="TensorFlow.Queue">Queue</a> as)</li><li class="src short"><a href="#v:enqueue">enqueue</a> :: <span class="keyword">forall</span> as v m. (<a href="../tensorflow-0.3.0.0/TensorFlow-Build.html#t:MonadBuild" title="TensorFlow.Build">MonadBuild</a> m, <a href="../tensorflow-0.3.0.0/TensorFlow-Types.html#t:TensorTypes" title="TensorFlow.Types">TensorTypes</a> as) => <a href="TensorFlow-Queue.html#t:Queue" title="TensorFlow.Queue">Queue</a> as -> <a href="../tensorflow-0.3.0.0/TensorFlow-Tensor.html#t:TensorList" title="TensorFlow.Tensor">TensorList</a> v as -> m <a href="../tensorflow-0.3.0.0/TensorFlow-Output.html#t:ControlNode" title="TensorFlow.Output">ControlNode</a></li><li class="src short"><a href="#v:dequeue">dequeue</a> :: <span class="keyword">forall</span> as m. (<a href="../tensorflow-0.3.0.0/TensorFlow-Build.html#t:MonadBuild" title="TensorFlow.Build">MonadBuild</a> m, <a href="../tensorflow-0.3.0.0/TensorFlow-Types.html#t:TensorTypes" title="TensorFlow.Types">TensorTypes</a> as) => <a href="TensorFlow-Queue.html#t:Queue" title="TensorFlow.Queue">Queue</a> as -> m (<a href="../tensorflow-0.3.0.0/TensorFlow-Tensor.html#t:TensorList" title="TensorFlow.Tensor">TensorList</a> <a href="../tensorflow-0.3.0.0/TensorFlow-Tensor.html#t:Value" title="TensorFlow.Tensor">Value</a> as)</li></ul></details></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:Queue" class="def">Queue</a> (as :: [*]) <a href="src/TensorFlow.Queue.html#Queue" class="link">Source</a> <a href="#t:Queue" class="selflink">#</a></p><div class="doc"><p>A queue carrying tuples.</p></div></div><div class="top"><p class="src"><a id="v:makeQueue" class="def">makeQueue</a> <a href="src/TensorFlow.Queue.html#makeQueue" class="link">Source</a> <a href="#v:makeQueue" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <span class="keyword">forall</span> as m. (<a href="../tensorflow-0.3.0.0/TensorFlow-Build.html#t:MonadBuild" title="TensorFlow.Build">MonadBuild</a> m, <a href="../tensorflow-0.3.0.0/TensorFlow-Types.html#t:TensorTypes" title="TensorFlow.Types">TensorTypes</a> as)</td><td class="doc empty"> </td></tr><tr><td class="src">=> <a href="../base-4.13.0.0/Data-Int.html#t:Int64" title="Data.Int">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">-> <a href="../bytestring-0.10.10.1/Data-ByteString.html#t:ByteString" title="Data.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">-> m (<a href="TensorFlow-Queue.html#t:Queue" title="TensorFlow.Queue">Queue</a> as)</td><td class="doc empty"> </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 id="v:enqueue" class="def">enqueue</a> :: <span class="keyword">forall</span> as v m. (<a href="../tensorflow-0.3.0.0/TensorFlow-Build.html#t:MonadBuild" title="TensorFlow.Build">MonadBuild</a> m, <a href="../tensorflow-0.3.0.0/TensorFlow-Types.html#t:TensorTypes" title="TensorFlow.Types">TensorTypes</a> as) => <a href="TensorFlow-Queue.html#t:Queue" title="TensorFlow.Queue">Queue</a> as -> <a href="../tensorflow-0.3.0.0/TensorFlow-Tensor.html#t:TensorList" title="TensorFlow.Tensor">TensorList</a> v as -> m <a href="../tensorflow-0.3.0.0/TensorFlow-Output.html#t:ControlNode" title="TensorFlow.Output">ControlNode</a> <a href="src/TensorFlow.Queue.html#enqueue" class="link">Source</a> <a href="#v:enqueue" class="selflink">#</a></p><div class="doc"><p>Adds the given values to the queue.</p></div></div><div class="top"><p class="src"><a id="v:dequeue" class="def">dequeue</a> <a href="src/TensorFlow.Queue.html#dequeue" class="link">Source</a> <a href="#v:dequeue" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <span class="keyword">forall</span> as m. (<a href="../tensorflow-0.3.0.0/TensorFlow-Build.html#t:MonadBuild" title="TensorFlow.Build">MonadBuild</a> m, <a href="../tensorflow-0.3.0.0/TensorFlow-Types.html#t:TensorTypes" title="TensorFlow.Types">TensorTypes</a> as)</td><td class="doc empty"> </td></tr><tr><td class="src">=> <a href="TensorFlow-Queue.html#t:Queue" title="TensorFlow.Queue">Queue</a> as</td><td class="doc empty"> </td></tr><tr><td class="src">-> m (<a href="../tensorflow-0.3.0.0/TensorFlow-Tensor.html#t:TensorList" title="TensorFlow.Tensor">TensorList</a> <a href="../tensorflow-0.3.0.0/TensorFlow-Tensor.html#t:Value" title="TensorFlow.Tensor">Value</a> as)</td><td class="doc"><p>Dequeued tensors. They are coupled 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.23.0</p></div></body></html> |