1
0
mirror of https://github.com/tensorflow/haskell.git synced 2024-06-02 02:53:35 +02:00
tensorflow-haskell/docs/haddock/tensorflow-opgen-0.3.0.0/TensorFlow-OpGen-ParsedOp.html

7 lines
37 KiB
HTML
Raw Permalink Normal View History

<!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.OpGen.ParsedOp</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-opgen-0.3.0.0: Code generation for TensorFlow operations.</span><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></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"><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: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" title="TensorFlow.OpGen.ParsedOp">Name</a></li><li><a href="#v:parsedOpSummary">parsedOpSummary</a> :: <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a></li><li><a href="#v:parsedOpDescription">parsedOpDescription</a> :: <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a></li><li><a href="#v:parsedInputs">parsedInputs</a> :: [<a href="TensorFlow-OpGen-ParsedOp.html#t:ParsedArg" title="TensorFlow.OpGen.ParsedOp">ParsedArg</a>]</li><li><a href="#v:parsedOutputs">parsedOutputs</a> :: [<a href="TensorFlow-OpGen-ParsedOp.html#t:ParsedArg" title="TensorFlow.OpGen.ParsedOp">ParsedArg</a>]</li><li><a href="#v:explicitInputAttrs">explicitInputAttrs</a> :: [<a href="TensorFlow-OpGen-ParsedOp.html#t:Attr" title="TensorFlow.OpGen.ParsedOp">Attr</a> <a href="TensorFlow-OpGen-ParsedOp.html#t:AttrType" title="TensorFlow.OpGen.ParsedOp">AttrType</a>]</li><li><a href="#v:inferredTypeAttrs">inferredTypeAttrs</a> :: [<a href="TensorFlow-OpGen-ParsedOp.html#t:Attr" title="TensorFlow.OpGen.ParsedOp">Attr</a> <a href="TensorFlow-OpGen-ParsedOp.html#t:TypeParam" title="TensorFlow.OpGen.ParsedOp">TypeParam</a>]</li><li><a href="#v:inferredListSizeAttrs">inferredListSizeAttrs</a> :: [<a href="TensorFlow-OpGen-ParsedOp.html#t:Attr" title="TensorFlow.OpGen.ParsedOp">Attr</a> (<a href="../base-4.13.0.0/Data-List-NonEmpty.html#t:NonEmpty" title="Data.List.NonEmpty">NonEmpty</a> <a href="TensorFlow-OpGen-ParsedOp.html#t:Name" title="TensorFlow.OpGen.ParsedOp">Name</a>)]</li><li><a href="#v:parsedOpIsMonadic">parsedOpIsMonadic</a> :: <a href="../base-4.13.0.0/Data-Bool.html#t:Bool" title="Data.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" title="TensorFlow.OpGen.ParsedOp">HaskellName</a></li><li><a href="#v:tfName">tfName</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:TFName" title="TensorFlow.OpGen.ParsedOp">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.4.0/Data-Text.html#t:Text" title="Data.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.4.0/Data-Text.html#t:Text" title="Data.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" title="TensorFlow.OpGen.ParsedOp">Name</a></li><li><a href="#v:attrDescription">attrDescription</a> :: <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.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" title="TensorFlow.OpGen.ParsedOp">AttrBaseType</a></li><li>| <a href="#v:AttrList">AttrList</a> <a href="TensorFlow-OpGen-ParsedOp.html#t:AttrBaseType" title="TensorFlow.OpGen.ParsedOp">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:AttrBy
Associated with the type of the attribute.</p></div></li><li><dfn class="src"><a id="v:inferredTypeAttrs" class="def">inferredTypeAttrs</a> :: [<a href="TensorFlow-OpGen-ParsedOp.html#t:Attr" title="TensorFlow.OpGen.ParsedOp">Attr</a> <a href="TensorFlow-OpGen-ParsedOp.html#t:TypeParam" title="TensorFlow.OpGen.ParsedOp">TypeParam</a>]</dfn><div class="doc"><p>Attributes that are type parameters.</p></div></li><li><dfn class="src"><a id="v:inferredListSizeAttrs" class="def">inferredListSizeAttrs</a> :: [<a href="TensorFlow-OpGen-ParsedOp.html#t:Attr" title="TensorFlow.OpGen.ParsedOp">Attr</a> (<a href="../base-4.13.0.0/Data-List-NonEmpty.html#t:NonEmpty" title="Data.List.NonEmpty">NonEmpty</a> <a href="TensorFlow-OpGen-ParsedOp.html#t:Name" title="TensorFlow.OpGen.ParsedOp">Name</a>)]</dfn><div class="doc empty">&nbsp;</div></li><li><dfn class="src"><a id="v:parsedOpIsMonadic" class="def">parsedOpIsMonadic</a> :: <a href="../base-4.13.0.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a></dfn><div 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></div></li></ul></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:Name" class="def">Name</a> <a href="src/TensorFlow.OpGen.ParsedOp.html#Name" class="link">Source</a> <a href="#t:Name" class="selflink">#</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="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><ul><li><dfn class="src"><a id="v:haskellName" class="def">haskellName</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:HaskellName" title="TensorFlow.OpGen.ParsedOp">HaskellName</a></dfn><div class="doc empty">&nbsp;</div></li><li><dfn class="src"><a id="v:tfName" class="def">tfName</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:TFName" title="TensorFlow.OpGen.ParsedOp">TFName</a></dfn><div class="doc empty">&nbsp;</div></li></ul></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">newtype</span> <a id="t:HaskellName" class="def">HaskellName</a> <a href="src/TensorFlow.OpGen.ParsedOp.html#HaskellName" class="link">Source</a> <a href="#t:HaskellName" class="selflink">#</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 id="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><ul><li><dfn class="src"><a id="v:unHaskellName" class="def">unHaskellName</a> :: <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a></dfn><div class="doc empty">&nbsp;</div></li></ul></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">newtype</span> <a id="t:TFName" class="def">TFName</a> <a href="src/TensorFlow.OpGen.ParsedOp.html#TFName" class="link">Source</a> <a href="#t:TFName" class="selflink">#</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 id="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><ul><li><dfn class="src"><a id="v:unTFName" class="def">unTFName</a> :: <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a></dfn><div class="doc empty">&nbsp;</div></li></ul></div></td></tr></table></div><div class="subs instances"><h4 class="instances details-toggle-control details-toggle" data-details-id="i:TFName">Instances</h4><details id="i:TFName" open="open"><summary class="hide-when-js-enabled">Instances details</summary><table><tr><td class="src clearfix"><span class="inst-left"><span class="instance details-toggle-control details-toggle" data-details-id="i:id:TFName:Eq:1"></span> <a href="../base-4.13.0.0/Data-Eq.html#t:Eq" title="Data.Eq">Eq</a> <a href="TensorFlow-OpGen-ParsedOp.html#t:TFName" title="TensorFlow.OpGen.ParsedOp">TFName</a></span> <a href="src/TensorFlow.OpGen.ParsedOp.html#line-86" class="link">Source</a> <a href="#t:TFName" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><details id="i:id:TFName:Eq:1"><summary class="hide-when-js-enabled">Instance details</summary><p>Defined in <a href="TensorFlow-OpGen-ParsedOp.html">TensorFlow.OpGen.ParsedOp</a></p> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:-61--61-">(==)</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:TFName" title="TensorFlow.OpGen.ParsedOp">TFName</a> -&gt; <a href="TensorFlow-OpGen-ParsedOp.html#t:TFName" title="TensorFlow.OpGen.ParsedOp">TFName</a> -&gt; <a href="../base-4.13.0.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="#v:-61--61-" class="selflink">#</a></p><p class="src"><a href="#v:-47--61-">(/=)</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:TFName
If <code><a href="../base-4.13.0.0/Data-Maybe.html#v:Nothing" title="Data.Maybe">Nothing</a></code>, then any type is acceptable.</p></div></li></ul></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:ParsedArg" class="def">ParsedArg</a> <a href="src/TensorFlow.OpGen.ParsedOp.html#ParsedArg" class="link">Source</a> <a href="#t:ParsedArg" class="selflink">#</a></p><div class="doc"><p>An input or output argument (Tensor) for an op.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:ParsedArg" class="def">ParsedArg</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:parsedArgName" class="def">parsedArgName</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:Name" title="TensorFlow.OpGen.ParsedOp">Name</a></dfn><div class="doc empty">&nbsp;</div></li><li><dfn class="src"><a id="v:parsedArgDescription" class="def">parsedArgDescription</a> :: <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a></dfn><div class="doc empty">&nbsp;</div></li><li><dfn class="src"><a id="v:parsedArgCase" class="def">parsedArgCase</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:ParsedArgCase" title="TensorFlow.OpGen.ParsedOp">ParsedArgCase</a></dfn><div class="doc empty">&nbsp;</div></li></ul></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:ParsedArgCase" class="def">ParsedArgCase</a> <a href="src/TensorFlow.OpGen.ParsedOp.html#ParsedArgCase" class="link">Source</a> <a href="#t:ParsedArgCase" class="selflink">#</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:SimpleArg" class="def">SimpleArg</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:argType" class="def">argType</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:ArgType" title="TensorFlow.OpGen.ParsedOp">ArgType</a></dfn><div class="doc empty">&nbsp;</div></li><li><dfn class="src"><a id="v:argKind" class="def">argKind</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:ArgKind" title="TensorFlow.OpGen.ParsedOp">ArgKind</a></dfn><div class="doc empty">&nbsp;</div></li></ul></div></td></tr><tr><td class="src"><a id="v:ListArg" class="def">ListArg</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:argLength" class="def">argLength</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:Name" title="TensorFlow.OpGen.ParsedOp">Name</a></dfn><div class="doc"><p>The attribute that specifies this list's length.</p></div></li><li><dfn class="src"><a id="v:argType" class="def">argType</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:ArgType" title="TensorFlow.OpGen.ParsedOp">ArgType</a></dfn><div class="doc empty">&nbsp;</div></li><li><dfn class="src"><a id="v:argKind" class="def">argKind</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:ArgKind" title="TensorFlow.OpGen.ParsedOp">ArgKind</a></dfn><div class="doc empty">&nbsp;</div></li></ul></div></td></tr><tr><td class="src"><a id="v:MixedListArg" class="def">MixedListArg</a></td><td class="doc"><p>A heterogeneous list.</p></td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><ul><li><dfn class="src"><a id="v:argTypeAttr" class="def">argTypeAttr</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:Name" title="TensorFlow.OpGen.ParsedOp">Name</a></dfn><div class="doc empty">&nbsp;</div></li><li><dfn class="src"><a id="v:argKind" class="def">argKind</a> :: <a href="TensorFlow-OpGen-ParsedOp.html#t:ArgKind" title="TensorFlow.OpGen.ParsedOp">ArgKind</a></dfn><div class="doc empty">&nbsp;</div></li></ul></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:ArgType" class="def">ArgType</a> <a href="src/TensorFlow.OpGen.ParsedOp.