1
0
mirror of https://github.com/tensorflow/haskell.git synced 2024-06-26 14:38:34 +02:00
tensorflow-haskell/docs/haddock/tensorflow-0.2.0.0/TensorFlow-Internal-FFI.html
2018-08-13 21:05:49 -07:00

8 lines
19 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.Internal.FFI</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.Internal.FFI.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-0.2.0.0: TensorFlow bindings.</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.Internal.FFI</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Internal helper.</a></li></ul></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:TensorFlowException">TensorFlowException</a> = <a href="#v:TensorFlowException">TensorFlowException</a> Code Text</li><li class="src short"><span class="keyword">data</span> <a href="#t:Session">Session</a></li><li class="src short"><a href="#v:withSession">withSession</a> :: (<a href="../base-4.10.1.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m, MonadMask m) =&gt; (SessionOptions -&gt; <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> ()) -&gt; ((<a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> () -&gt; <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> ()) -&gt; <a href="TensorFlow-Internal-FFI.html#t:Session">Session</a> -&gt; m a) -&gt; m a</li><li class="src short"><a href="#v:extendGraph">extendGraph</a> :: <a href="TensorFlow-Internal-FFI.html#t:Session">Session</a> -&gt; <a href="../tensorflow-proto-0.2.0.0/Proto-Tensorflow-Core-Framework-Graph.html#t:GraphDef">GraphDef</a> -&gt; <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:run">run</a> :: <a href="TensorFlow-Internal-FFI.html#t:Session">Session</a> -&gt; [(<a href="../bytestring-0.10.8.2/Data-ByteString.html#t:ByteString">ByteString</a>, <a href="TensorFlow-Internal-FFI.html#t:TensorData">TensorData</a>)] -&gt; [<a href="../bytestring-0.10.8.2/Data-ByteString.html#t:ByteString">ByteString</a>] -&gt; [<a href="../bytestring-0.10.8.2/Data-ByteString.html#t:ByteString">ByteString</a>] -&gt; <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> [<a href="TensorFlow-Internal-FFI.html#t:TensorData">TensorData</a>]</li><li class="src short"><span class="keyword">data</span> <a href="#t:TensorData">TensorData</a> = <a href="#v:TensorData">TensorData</a> {<ul class="subs"><li><a href="#v:tensorDataDimensions">tensorDataDimensions</a> :: [<a href="../base-4.10.1.0/Data-Int.html#t:Int64">Int64</a>]</li><li><a href="#v:tensorDataType">tensorDataType</a> :: !<a href="TensorFlow-Types.html#t:DataType">DataType</a></li><li><a href="#v:tensorDataBytes">tensorDataBytes</a> :: !(Vector <a href="../base-4.10.1.0/Data-Word.html#t:Word8">Word8</a>)</li></ul>}</li><li class="src short"><a href="#v:setSessionConfig">setSessionConfig</a> :: <a href="../tensorflow-proto-0.2.0.0/Proto-Tensorflow-Core-Protobuf-Config.html#t:ConfigProto">ConfigProto</a> -&gt; SessionOptions -&gt; <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:setSessionTarget">setSessionTarget</a> :: <a href="../bytestring-0.10.8.2/Data-ByteString.html#t:ByteString">ByteString</a> -&gt; SessionOptions -&gt; <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:getAllOpList">getAllOpList</a> :: <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> <a href="../bytestring-0.10.8.2/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:useProtoAsVoidPtrLen">useProtoAsVoidPtrLen</a> :: (Message msg, <a href="../base-4.10.1.0/Prelude.html#t:Integral">Integral</a> c, <a href="../base-4.10.1.0/Text-Show.html#t:Show">Show</a> c, <a href="../base-4.10.1.0/Data-Bits.html#t:Bits">Bits</a> c) =&gt; msg -&gt; (<a href="../base-4.10.1.0/Foreign-Ptr.html#t:Ptr">Ptr</a> b -&gt; c -&gt; <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> a) -&gt; <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> a</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:TensorFlowException" class="def">TensorFlowException</a> <a href="src/TensorFlow.Internal.FFI.html#TensorFlowException" class="link">Source</a> <a href="#t:TensorFlowException" class="selflink">#</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:TensorFlowException" class="def">TensorFlowException</a> Code Text</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="subs instances"><p id="control.i:TensorFlowException" class="caption collapser" onclick="toggleSection('i:TensorFlowException')">Instances</p><div id="section.i:TensorFlowException" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:TensorFlowException:Eq:1" class="instance expander" onclick="toggleSection('i:id:TensorFlowException:Eq:1')"></span> <a href="../base-4.10.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="TensorFlow-Internal-FFI.html#t:TensorFlowException">TensorFlowException</a></span> <a href="src/TensorFlow.Internal.FFI.html#line-65" class="link">Source</a> <a href="#t:TensorFlowException" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div id="section.i:id:TensorFlowException:Eq:1" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:-61--61-">(==)</a> :: <a href="TensorFlow-Internal-FFI.html#t:TensorFlowException">TensorFlowException</a> -&gt; <a href="TensorFlow-Internal-FFI.html#t:TensorFlowException">TensorFlowException</a> -&gt; <a href="../base-4.10.1.0/Data-Bool.html#t:Bool">Bool</a> <a href="#v:-61--61-" class="selflink">#</a></p><p class="src"><a href="#v:-47--61-">(/=)</a> :: <a href="TensorFlow-Internal-FFI.html#t:TensorFlowException">TensorFlowException</a> -&gt; <a href="TensorFlow-Internal-FFI.html#t:TensorFlowException">TensorFlowException</a> -&gt; <a href="../base-4.10.1.0/Data-Bool.html#t:Bool">Bool</a> <a href="#v:-47--61-" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:TensorFlowException:Show:2" class="instance expander" onclick="toggleSection('i:id:TensorFlowException:Show:2')"></span> <a href="../base-4.10.1.0/Text-Show.html#t:Show">Show</a> <a href="TensorFlow-Internal-FFI.html#t:TensorFlowException">TensorFlowException</a></span> <a href="src/TensorFlow.Internal.FFI.html#line-65" class="link">Source</a> <a href="#t:TensorFlowException" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div id="section.i:id:TensorFlowException:Show:2" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:showsPrec">showsPrec</a> :: <a href="../base-4.10.1.0/Data-Int.html#t:Int">Int</a> -&gt; <a href="TensorFlow-Internal-FFI.html#t:TensorFlowException">TensorFlowException</a> -&gt; <a href="../base-4.10.1.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showsPrec" class="selflink">#</a></p><p class="src"><a href="#v:show">show</a> :: <a href="TensorFlow-Internal-FFI.html#t:TensorFlowException">TensorFlowException</a> -&gt; <a href="../base-4.10.1.0/Data-String.html#t:String">String</a> <a href="#v:show" class="selflink">#</a></p><p class="src"><a href="#v:showList">showList</a> :: [<a href="TensorFlow-Internal-FFI.html#t:TensorFlowException">TensorFlowException</a>] -&gt; <a href="../base-4.10.1.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showList" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:TensorFlowException:Exception:3" class="instance expander" onclick="toggleSection('i:id:TensorFlowException:Exception:3')"></span> <a href="../base-4.10.1.0/Control-Exception-Base.html#t:Exception">Exception</a> <a href="TensorFlow-Internal-FFI.html#t:TensorFlowException">TensorFlowException</a></span> <a href="src/TensorFlow.Internal.FFI.html#line-67" class="link">Source</a> <a href="#t:TensorFlowException" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div id="section.i:id:TensorFlowException:Exception:3" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:toException">toException</a> :: <a href="TensorFlow-Internal-FFI.html#t:TensorFlowException">TensorFlowException</a> -&gt; <a href="../base-4.10.1.0/Control-Exception-Base.html#t:SomeException">SomeException</a> <a href="#v:toException" class="selflink">#</a></p><p class="src"><a href="#v:fromException">fromException</a> :: <a href="../base-4.10.1.0/Control-Exception-Base.html#t:SomeException">SomeException</a> -&gt; <a href="../base-4.10.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="TensorFlow-Internal-FFI.html#t:TensorFlowException">TensorFlowException</a> <a href="#v:fromException" class="selflink">#</a></p><p class="src"><a href="#v:displayException">displayException</a> :: <a href="TensorFlow-Internal-FFI.html#t:TensorFlowException">TensorFlowException</a> -&gt; <a href="../base-4.10.1.0/Data-String.html#t:String">String</a> <a href="#v:displayException" class="selflink">#</a></p></div></div></td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:Session" class="def">Session</a> <a href="src/TensorFlow.Internal.Raw.html#Session" class="link">Source</a> <a href="#t:Session" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:withSession" class="def">withSession</a> <a href="src/TensorFlow.Internal.FFI.html#withSession" class="link">Source</a> <a href="#v:withSession" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="../base-4.10.1.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m, MonadMask m)</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">=&gt; (SessionOptions -&gt; <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> ())</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">-&gt; ((<a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> () -&gt; <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> ()) -&gt; <a href="TensorFlow-Internal-FFI.html#t:Session">Session</a> -&gt; m a)</td><td class="doc"><p>The action can spawn concurrent tasks which will
be canceled before withSession returns.</p></td></tr><tr><td class="src">-&gt; m a</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Runs the given action after creating a session with options
populated by the given optionSetter.</p></div></div><div class="top"><p class="src"><a id="v:extendGraph" class="def">extendGraph</a> :: <a href="TensorFlow-Internal-FFI.html#t:Session">Session</a> -&gt; <a href="../tensorflow-proto-0.2.0.0/Proto-Tensorflow-Core-Framework-Graph.html#t:GraphDef">GraphDef</a> -&gt; <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> () <a href="src/TensorFlow.Internal.FFI.html#extendGraph" class="link">Source</a> <a href="#v:extendGraph" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:run" class="def">run</a> <a href="src/TensorFlow.Internal.FFI.html#run" class="link">Source</a> <a href="#v:run" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="TensorFlow-Internal-FFI.html#t:Session">Session</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">-&gt; [(<a href="../bytestring-0.10.8.2/Data-ByteString.html#t:ByteString">ByteString</a>, <a href="TensorFlow-Internal-FFI.html#t:TensorData">TensorData</a>)]</td><td class="doc"><p>Feeds.</p></td></tr><tr><td class="src">-&gt; [<a href="../bytestring-0.10.8.2/Data-ByteString.html#t:ByteString">ByteString</a>]</td><td class="doc"><p>Fetches.</p></td></tr><tr><td class="src">-&gt; [<a href="../bytestring-0.10.8.2/Data-ByteString.html#t:ByteString">ByteString</a>]</td><td class="doc"><p>Targets.</p></td></tr><tr><td class="src">-&gt; <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> [<a href="TensorFlow-Internal-FFI.html#t:TensorData">TensorData</a>]</td><td class="doc empty">&nbsp;</td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:TensorData" class="def">TensorData</a> <a href="src/TensorFlow.Internal.FFI.html#TensorData" class="link">Source</a> <a href="#t:TensorData" class="selflink">#</a></p><div class="doc"><p>All of the data needed to represent a tensor.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:TensorData" class="def">TensorData</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><ul><li><dfn class="src"><a id="v:tensorDataDimensions" class="def">tensorDataDimensions</a> :: [<a href="../base-4.10.1.0/Data-Int.html#t:Int64">Int64</a>]</dfn><div class="doc empty">&nbsp;</div></li><li><dfn class="src"><a id="v:tensorDataType" class="def">tensorDataType</a> :: !<a href="TensorFlow-Types.html#t:DataType">DataType</a></dfn><div class="doc empty">&nbsp;</div></li><li><dfn class="src"><a id="v:tensorDataBytes" class="def">tensorDataBytes</a> :: !(Vector <a href="../base-4.10.1.0/Data-Word.html#t:Word8">Word8</a>)</dfn><div class="doc empty">&nbsp;</div></li></ul></div></td></tr></table></div><div class="subs instances"><p id="control.i:TensorData" class="caption collapser" onclick="toggleSection('i:TensorData')">Instances</p><div id="section.i:TensorData" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:TensorData:Eq:1" class="instance expander" onclick="toggleSection('i:id:TensorData:Eq:1')"></span> <a href="../base-4.10.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="TensorFlow-Internal-FFI.html#t:TensorData">TensorData</a></span> <a href="src/TensorFlow.Internal.FFI.html#line-75" class="link">Source</a> <a href="#t:TensorData" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div id="section.i:id:TensorData:Eq:1" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:-61--61-">(==)</a> :: <a href="TensorFlow-Internal-FFI.html#t:TensorData">TensorData</a> -&gt; <a href="TensorFlow-Internal-FFI.html#t:TensorData">TensorData</a> -&gt; <a href="../base-4.10.1.0/Data-Bool.html#t:Bool">Bool</a> <a href="#v:-61--61-" class="selflink">#</a></p><p class="src"><a href="#v:-47--61-">(/=)</a> :: <a href="TensorFlow-Internal-FFI.html#t:TensorData">TensorData</a> -&gt; <a href="TensorFlow-Internal-FFI.html#t:TensorData">TensorData</a> -&gt; <a href="../base-4.10.1.0/Data-Bool.html#t:Bool">Bool</a> <a href="#v:-47--61-" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:TensorData:Show:2" class="instance expander" onclick="toggleSection('i:id:TensorData:Show:2')"></span> <a href="../base-4.10.1.0/Text-Show.html#t:Show">Show</a> <a href="TensorFlow-Internal-FFI.html#t:TensorData">TensorData</a></span> <a href="src/TensorFlow.Internal.FFI.html#line-75" class="link">Source</a> <a href="#t:TensorData" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div id="section.i:id:TensorData:Show:2" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:showsPrec">showsPrec</a> :: <a href="../base-4.10.1.0/Data-Int.html#t:Int">Int</a> -&gt; <a href="TensorFlow-Internal-FFI.html#t:TensorData">TensorData</a> -&gt; <a href="../base-4.10.1.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showsPrec" class="selflink">#</a></p><p class="src"><a href="#v:show">show</a> :: <a href="TensorFlow-Internal-FFI.html#t:TensorData">TensorData</a> -&gt; <a href="../base-4.10.1.0/Data-String.html#t:String">String</a> <a href="#v:show" class="selflink">#</a></p><p class="src"><a href="#v:showList">showList</a> :: [<a href="TensorFlow-Internal-FFI.html#t:TensorData">TensorData</a>] -&gt; <a href="../base-4.10.1.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showList" class="selflink">#</a></p></div></div></td></tr></table></div></div></div><div class="top"><p class="src"><a id="v:setSessionConfig" class="def">setSessionConfig</a> :: <a href="../tensorflow-proto-0.2.0.0/Proto-Tensorflow-Core-Protobuf-Config.html#t:ConfigProto">ConfigProto</a> -&gt; SessionOptions -&gt; <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> () <a href="src/TensorFlow.Internal.FFI.html#setSessionConfig" class="link">Source</a> <a href="#v:setSessionConfig" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:setSessionTarget" class="def">setSessionTarget</a> :: <a href="../bytestring-0.10.8.2/Data-ByteString.html#t:ByteString">ByteString</a> -&gt; SessionOptions -&gt; <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> () <a href="src/TensorFlow.Internal.FFI.html#setSessionTarget" class="link">Source</a> <a href="#v:setSessionTarget" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:getAllOpList" class="def">getAllOpList</a> :: <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> <a href="../bytestring-0.10.8.2/Data-ByteString.html#t:ByteString">ByteString</a> <a href="src/TensorFlow.Internal.FFI.html#getAllOpList" class="link">Source</a> <a href="#v:getAllOpList" class="selflink">#</a></p><div class="doc"><p>Returns the serialized OpList of all OpDefs defined in this
address space.</p></div></div><h1 id="g:1">Internal helper.</h1><div class="top"><p class="src"><a id="v:useProtoAsVoidPtrLen" class="def">useProtoAsVoidPtrLen</a> :: (Message msg, <a href="../base-4.10.1.0/Prelude.html#t:Integral">Integral</a> c, <a href="../base-4.10.1.0/Text-Show.html#t:Show">Show</a> c, <a href="../base-4.10.1.0/Data-Bits.html#t:Bits">Bits</a> c) =&gt; msg -&gt; (<a href="../base-4.10.1.0/Foreign-Ptr.html#t:Ptr">Ptr</a> b -&gt; c -&gt; <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> a) -&gt; <a href="../base-4.10.1.0/System-IO.html#t:IO">IO</a> a <a href="src/TensorFlow.Internal.FFI.html#useProtoAsVoidPtrLen" class="link">Source</a> <a href="#v:useProtoAsVoidPtrLen" class="selflink">#</a></p><div class="doc"><p>Serializes the given msg and provides it as (ptr,len) argument
to the given action.</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>