1
0
Fork 0
mirror of https://github.com/tensorflow/haskell.git synced 2024-11-05 18:49:41 +01:00
tensorflow-haskell/docs/haddock/tensorflow-opgen-0.1.0.0/TensorFlow-OpGen-ParsedOp.html

12 lines
23 KiB
HTML
Raw Normal View History

2016-11-23 19:55:35 +01:00
<!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.OpGen.ParsedOp</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-OpGen-ParsedOp.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/TensorFlow-OpGen-ParsedOp.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-opgen-0.1.0.0: Code generation for TensorFlow operations.</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.OpGen.ParsedOp</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module helps parse the proto OpDef into a Haskell type which is more
descriptive of how the attributes and arguments will be used in the
generated code.</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:ParsedOp">ParsedOp</a> = <a href="#v:ParsedOp">ParsedOp</a> {<ul class="subs"><li><a href="#v:parsedOpName">parsedOpName</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:Name">Name</a></li><li><a href="#v:parsedOpSummary">parsedOpSummary</a> :: <a href="../text-1.2.2.1/Data-Text.html#t:Text">Text</a></li><li><a href="#v:parsedOpDescription">parsedOpDescription</a> :: <a href="../text-1.2.2.1/Data-Text.html#t:Text">Text</a></li><li><a href="#v:parsedInputs">parsedInputs</a> :: [<a href="TensorFlow-OpGen-ParsedOp.html#t:ParsedArg">ParsedArg</a>]</li><li><a href="#v:parsedOutputs">parsedOutputs</a> :: [<a href="TensorFlow-OpGen-ParsedOp.html#t:ParsedArg">ParsedArg</a>]</li><li><a href="#v:explicitInputAttrs">explicitInputAttrs</a> :: [<a href="TensorFlow-OpGen-ParsedOp.html#t:Attr">Attr</a> <a href="TensorFlow-OpGen-ParsedOp.html#t:AttrType">AttrType</a>]</li><li><a href="#v:inferredTypeAttrs">inferredTypeAttrs</a> :: [<a href="TensorFlow-OpGen-ParsedOp.html#t:Attr">Attr</a> [<a href="../tensorflow-proto-0.1.0.0/Proto-Tensorflow-Core-Framework-Types.html#t:DataType">DataType</a>]]</li><li><a href="#v:inferredListSizeAttrs">inferredListSizeAttrs</a> :: [<a href="TensorFlow-OpGen-ParsedOp.html#t:Attr">Attr</a> (<a href="../semigroups-0.18.1/Data-List-NonEmpty.html#t:NonEmpty">NonEmpty</a> <a href="TensorFlow-OpGen-ParsedOp.html#t:Name">Name</a>)]</li><li><a href="#v:parsedOpIsMonadic">parsedOpIsMonadic</a> :: <a href="../base-4.8.2.0/Data-Bool.html#t:Bool">Bool</a></li></ul>}</li><li class="src short"><span class="keyword">data</span> <a href="#t:Name">Name</a> = <a href="#v:Name">Name</a> {<ul class="subs"><li><a href="#v:haskellName">haskellName</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:HaskellName">HaskellName</a></li><li><a href="#v:tfName">tfName</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:TFName">TFName</a></li></ul>}</li><li class="src short"><span class="keyword">newtype</span> <a href="#t:HaskellName">HaskellName</a> = <a href="#v:HaskellName">HaskellName</a> {<ul class="subs"><li><a href="#v:unHaskellName">unHaskellName</a> :: <a href="../text-1.2.2.1/Data-Text.html#t:Text">Text</a></li></ul>}</li><li class="src short"><span class="keyword">newtype</span> <a href="#t:TFName">TFName</a> = <a href="#v:TFName">TFName</a> {<ul class="subs"><li><a href="#v:unTFName">unTFName</a> :: <a href="../text-1.2.2.1/Data-Text.html#t:Text">Text</a></li></ul>}</li><li class="src short"><span class="keyword">data</span> <a href="#t:Attr">Attr</a> a = <a href="#v:Attr">Attr</a> {<ul class="subs"><li><a href="#v:attrName">attrName</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:Name">Name</a></li><li><a href="#v:attrDescription">attrDescription</a> :: <a href="../text-1.2.2.1/Data-Text.html#t:Text">Text</a></li><li><a href="#v:attrInfo">attrInfo</a> :: a</li></ul>}</li><li class="src short"><span class="keyword">data</span> <a href="#t:AttrType">AttrType</a><ul class="subs"><li>= <a href="#v:AttrSingle">AttrSingle</a> <a href="TensorFlow-OpGen-ParsedOp.html#t:AttrBaseType">AttrBaseType</a></li><li>| <a href="#v:AttrList">AttrList</a> <a href="TensorFlow-OpGen-ParsedOp.html#t:AttrBaseType">AttrBaseType</a></li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:AttrBaseType">AttrBaseType</a><ul class="subs"><li>= <a href="#v:AttrBytes">AttrBytes</a></li><li>| <a href="#v:AttrInt64">AttrInt64</a></li><li>| <a href="#v:AttrFloat">AttrFloat</a></li><li>| <a href="#v:AttrBool">AttrBool</a></li><li>| <a href="#v:AttrType">AttrType</a></li><li>| <a href="#v:AttrShape">AttrShape</a></li><li>| <a href="#v:AttrTensor">AttrTensor</a></li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:ParsedArg">ParsedArg</a> = <a href="#v:ParsedArg">ParsedArg</a> {<ul class="subs"><li><a href="#v:parsedArgName">parsedArgName</
Associated with the type of the attribute.</p></dd><dt class="src"><a name="v:inferredTypeAttrs" class="def">inferredTypeAttrs</a> :: [<a href="TensorFlow-OpGen-ParsedOp.html#t:Attr">Attr</a> [<a href="../tensorflow-proto-0.1.0.0/Proto-Tensorflow-Core-Framework-Types.html#t:DataType">DataType</a>]]</dt><dd class="doc"><p>Attributes that are type parameters.
Associated with the list of allowed types (see: TensorFlow.Types.OneOf).
If this list is empty, then any type is acceptable.</p></dd><dt class="src"><a name="v:inferredListSizeAttrs" class="def">inferredListSizeAttrs</a> :: [<a href="TensorFlow-OpGen-ParsedOp.html#t:Attr">Attr</a> (<a href="../semigroups-0.18.1/Data-List-NonEmpty.html#t:NonEmpty">NonEmpty</a> <a href="TensorFlow-OpGen-ParsedOp.html#t:Name">Name</a>)]</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:parsedOpIsMonadic" class="def">parsedOpIsMonadic</a> :: <a href="../base-4.8.2.0/Data-Bool.html#t:Bool">Bool</a></dt><dd class="doc"><p>Whether this op is stateful or takes a stateful input. Such ops
should not be CSE'd and must be monadic in our API (i.e., return a
Build action).</p></dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Name" class="def">Name</a> <a href="src/TensorFlow-OpGen-ParsedOp.html#Name" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Name" class="def">Name</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:haskellName" class="def">haskellName</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:HaskellName">HaskellName</a></dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:tfName" class="def">tfName</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:TFName">TFName</a></dt><dd class="doc empty">&nbsp;</dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:HaskellName" class="def">HaskellName</a> <a href="src/TensorFlow-OpGen-ParsedOp.html#HaskellName" class="link">Source</a></p><div class="doc"><p>A name that's appropriate for a variable in a Haskell source file.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:HaskellName" class="def">HaskellName</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:unHaskellName" class="def">unHaskellName</a> :: <a href="../text-1.2.2.1/Data-Text.html#t:Text">Text</a></dt><dd class="doc empty">&nbsp;</dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:TFName" class="def">TFName</a> <a href="src/TensorFlow-OpGen-ParsedOp.html#TFName" class="link">Source</a></p><div class="doc"><p>A raw name as specified in the OpDef proto.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:TFName" class="def">TFName</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:unTFName" class="def">unTFName</a> :: <a href="../text-1.2.2.1/Data-Text.html#t:Text">Text</a></dt><dd class="doc empty">&nbsp;</dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:TFName" class="caption collapser" onclick="toggleSection('i:TFName')">Instances</p><div id="section.i:TFName" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><a href="../base-4.8.2.0/Data-Eq.html#t:Eq">Eq</a> <a href="TensorFlow-OpGen-ParsedOp.html#t:TFName">TFName</a></span> <a href="src/TensorFlow-OpGen-ParsedOp.html#line-85" class="link">Source</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="../base-4.8.2.0/Data-Ord.html#t:Ord">Ord</a> <a href="TensorFlow-OpGen-ParsedOp.html#t:TFName">TFName</a></span> <a href="src/TensorFlow-OpGen-ParsedOp.html#line-85" class="link">Source</a></td><td class="doc empty">&nbsp;</td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Attr" class="def">Attr</a> a <a href="src/TensorFlow-OpGen-ParsedOp.html#Attr" class="link">Source</a></p><div class="doc"><p>A named attribute, associated with some information about it.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Attr" class="def">Attr</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:attrName" class="def">attrName</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:Name">Name</a></dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:attrDescription" class="def">attrDescription</a> :: <a href="../text-1.2.2.1/Data-Text.html#t:Text">Text</a></dt><dd class="doc empty"
TODO(judahjacobson): Implement this.</p></td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:argTypeAttr" class="def">argTypeAttr</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:Name">Name</a></dt><dd class="doc empty">&nbsp;</dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ArgType" class="def">ArgType</a> <a href="src/TensorFlow-OpGen-ParsedOp.html#ArgType" class="link">Source</a></p><div class="doc"><p>The type of an argument.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ArgTypeFixed" class="def">ArgTypeFixed</a> <a href="../tensorflow-proto-0.1.0.0/Proto-Tensorflow-Core-Framework-Types.html#t:DataType">DataType</a></td><td class="doc"><p>A fixed type.</p></td></tr><tr><td class="src"><a name="v:ArgTypeAttr" class="def">ArgTypeAttr</a> <a href="TensorFlow-OpGen-ParsedOp.html#t:Name">Name</a></td><td class="doc"><p>A type that depends on an attribute.</p></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ArgKind" class="def">ArgKind</a> <a href="src/TensorFlow-OpGen-ParsedOp.html#ArgKind" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ArgTensorRef" class="def">ArgTensorRef</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a name="v:ArgTensorValue" class="def">ArgTensorValue</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a name="v:ArgTensorEither" class="def">ArgTensorEither</a> <a href="../text-1.2.2.1/Data-Text.html#t:Text">Text</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a name="v:ArgResource" class="def">ArgResource</a></td><td class="doc empty">&nbsp;</td></tr></table></div></div><div class="top"><p class="src"><a name="v:parseOp" class="def">parseOp</a> :: <a href="../tensorflow-proto-0.1.0.0/Proto-Tensorflow-Core-Framework-OpDef.html#t:OpDef">OpDef</a> -&gt; <a href="TensorFlow-OpGen-ParsedOp.html#t:ParsedOp">ParsedOp</a> <a href="src/TensorFlow-OpGen-ParsedOp.html#parseOp" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:camelCase" class="def">camelCase</a> :: <a href="../text-1.2.2.1/Data-Text.html#t:Text">Text</a> -&gt; <a href="../text-1.2.2.1/Data-Text.html#t:Text">Text</a> <a href="src/TensorFlow-OpGen-ParsedOp.html#camelCase" class="link">Source</a></p></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>