Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / api / cpp / docs / api / namespacemxnet_1_1alm.html
blob: 7fbf0269dc5adf5b47d1de290d353a1f890b7115 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: mxnet::alm Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="namespacemxnet_1_1alm.html">alm</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">mxnet::alm Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1alm_1_1ALMParams.html">ALMParams</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A singleton flag, set and read by MXSetOptimizeLayout and MXGetOptimizeLayout. <a href="structmxnet_1_1alm_1_1ALMParams.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a80e5ee70df5882f2a2dfcd8e8390087a"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> = std::vector&lt; size_t &gt;</td></tr>
<tr class="memdesc:a80e5ee70df5882f2a2dfcd8e8390087a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transpose, represented by permutation of axes. <a href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">More...</a><br /></td></tr>
<tr class="separator:a80e5ee70df5882f2a2dfcd8e8390087a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae211ddf7e2c24386b3448adfeff79489"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1alm.html#ae211ddf7e2c24386b3448adfeff79489">FChangeLayout</a> = std::function&lt; bool(<a class="el" href="structnnvm_1_1NodeAttrs.html">nnvm::NodeAttrs</a> *, <a class="el" href="namespacemshadow.html#abbe2dc827052234b64ab2d40a5b2fdb4">mshadow::LayoutFlag</a> target_layout, std::vector&lt; <a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> &gt; *in_axes, std::vector&lt; <a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> &gt; *out_axes)&gt;</td></tr>
<tr class="memdesc:ae211ddf7e2c24386b3448adfeff79489"><td class="mdescLeft">&#160;</td><td class="mdescRight">May change operator's layout. Used in LayoutOptimization. <a href="namespacemxnet_1_1alm.html#ae211ddf7e2c24386b3448adfeff79489">More...</a><br /></td></tr>
<tr class="separator:ae211ddf7e2c24386b3448adfeff79489"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0285a1d2140fc552177e85d43154660c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Graph.html">nnvm::Graph</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1alm.html#a0285a1d2140fc552177e85d43154660c">OptimizeLayout</a> (<a class="el" href="classnnvm_1_1Graph.html">nnvm::Graph</a> &amp;&amp;g)</td></tr>
<tr class="separator:a0285a1d2140fc552177e85d43154660c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b6e013efdb80a318767cd11481a6541"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1alm.html#a2b6e013efdb80a318767cd11481a6541">IsIdentity</a> (const <a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> &amp;t)</td></tr>
<tr class="separator:a2b6e013efdb80a318767cd11481a6541"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1dcd10f7b9ef7846a9ede64377a3e1a1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1alm.html#a1dcd10f7b9ef7846a9ede64377a3e1a1">Reverse</a> (const <a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> &amp;axes)</td></tr>
<tr class="separator:a1dcd10f7b9ef7846a9ede64377a3e1a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a827d6472363f78002b7eaefa3400a178"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1alm.html#a827d6472363f78002b7eaefa3400a178">Compose</a> (const <a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> &amp;lhs, const <a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> &amp;rhs)</td></tr>
<tr class="separator:a827d6472363f78002b7eaefa3400a178"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66e4116f2f04e1d3cba842cec2832ac3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemshadow.html#abbe2dc827052234b64ab2d40a5b2fdb4">mshadow::LayoutFlag</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1alm.html#a66e4116f2f04e1d3cba842cec2832ac3">ApplyTranspose</a> (<a class="el" href="namespacemshadow.html#abbe2dc827052234b64ab2d40a5b2fdb4">mshadow::LayoutFlag</a> layout, const <a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> &amp;axes)</td></tr>
<tr class="separator:a66e4116f2f04e1d3cba842cec2832ac3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a589ef5977b6485f1f4df646798bd035d"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1alm.html#a589ef5977b6485f1f4df646798bd035d">ApplyTranspose</a> (const std::string &amp;layout, const <a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> &amp;axes)</td></tr>
<tr class="separator:a589ef5977b6485f1f4df646798bd035d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a1641eaa941d0598ddc550f18253e2f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1alm.html#a9a1641eaa941d0598ddc550f18253e2f">FromTShape</a> (const <a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a> &amp;s)</td></tr>
<tr class="separator:a9a1641eaa941d0598ddc550f18253e2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca0a3adbbf2a7a7e761ef9d367fa86d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1alm.html#aca0a3adbbf2a7a7e761ef9d367fa86d6">FactorCommonTranspose</a> (std::vector&lt; <a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> &gt; *axes)</td></tr>
<tr class="memdesc:aca0a3adbbf2a7a7e761ef9d367fa86d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Factors out and returns a common transpose, or default-constructed Transpose if all axes (in/out parameter) are empty. <a href="namespacemxnet_1_1alm.html#aca0a3adbbf2a7a7e761ef9d367fa86d6">More...</a><br /></td></tr>
<tr class="separator:aca0a3adbbf2a7a7e761ef9d367fa86d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ae211ddf7e2c24386b3448adfeff79489"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae211ddf7e2c24386b3448adfeff79489">&#9670;&nbsp;</a></span>FChangeLayout</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="namespacemxnet_1_1alm.html#ae211ddf7e2c24386b3448adfeff79489">mxnet::alm::FChangeLayout</a> = typedef std::function&lt;bool(<a class="el" href="structnnvm_1_1NodeAttrs.html">nnvm::NodeAttrs</a>*, <a class="el" href="namespacemshadow.html#abbe2dc827052234b64ab2d40a5b2fdb4">mshadow::LayoutFlag</a> target_layout, std::vector&lt;<a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a>&gt;* in_axes, std::vector&lt;<a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a>&gt;* out_axes)&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>May change operator's layout. Used in LayoutOptimization. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">target_layout</td><td>The target layout to change to, or kUNKNOWN. In the latter case the target layout is calculated based on in_axes, with a goal to cancel them out (at least some, ideally - all). </td></tr>
<tr><td class="paramname">in_axes</td><td>(in/out) On input - pending inputs' transposes. On output - inputs' transposes, required by the new layout. </td></tr>
<tr><td class="paramname">out_axes</td><td>(out) Outputs' transposes, required to convert to the original layouts. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if attrs changed and params need to be reparsed. </dd></dl>
</div>
</div>
<a id="a80e5ee70df5882f2a2dfcd8e8390087a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80e5ee70df5882f2a2dfcd8e8390087a">&#9670;&nbsp;</a></span>Transpose</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">mxnet::alm::Transpose</a> = typedef std::vector&lt;size_t&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Transpose, represented by permutation of axes. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a589ef5977b6485f1f4df646798bd035d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a589ef5977b6485f1f4df646798bd035d">&#9670;&nbsp;</a></span>ApplyTranspose() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string mxnet::alm::ApplyTranspose </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>layout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> &amp;&#160;</td>
<td class="paramname"><em>axes</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a66e4116f2f04e1d3cba842cec2832ac3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66e4116f2f04e1d3cba842cec2832ac3">&#9670;&nbsp;</a></span>ApplyTranspose() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacemshadow.html#abbe2dc827052234b64ab2d40a5b2fdb4">mshadow::LayoutFlag</a> mxnet::alm::ApplyTranspose </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacemshadow.html#abbe2dc827052234b64ab2d40a5b2fdb4">mshadow::LayoutFlag</a>&#160;</td>
<td class="paramname"><em>layout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> &amp;&#160;</td>
<td class="paramname"><em>axes</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a827d6472363f78002b7eaefa3400a178"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a827d6472363f78002b7eaefa3400a178">&#9670;&nbsp;</a></span>Compose()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> mxnet::alm::Compose </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> &amp;&#160;</td>
<td class="paramname"><em>lhs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>\bried Compose 2 transposes. Not commutative: a * b means b is applied first, then a. </p>
</div>
</div>
<a id="aca0a3adbbf2a7a7e761ef9d367fa86d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca0a3adbbf2a7a7e761ef9d367fa86d6">&#9670;&nbsp;</a></span>FactorCommonTranspose()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> mxnet::alm::FactorCommonTranspose </td>
<td>(</td>
<td class="paramtype">std::vector&lt; <a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> &gt; *&#160;</td>
<td class="paramname"><em>axes</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Factors out and returns a common transpose, or default-constructed Transpose if all axes (in/out parameter) are empty. </p>
</div>
</div>
<a id="a9a1641eaa941d0598ddc550f18253e2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a1641eaa941d0598ddc550f18253e2f">&#9670;&nbsp;</a></span>FromTShape()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> mxnet::alm::FromTShape </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a> &amp;&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2b6e013efdb80a318767cd11481a6541"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b6e013efdb80a318767cd11481a6541">&#9670;&nbsp;</a></span>IsIdentity()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mxnet::alm::IsIdentity </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> &amp;&#160;</td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0285a1d2140fc552177e85d43154660c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0285a1d2140fc552177e85d43154660c">&#9670;&nbsp;</a></span>OptimizeLayout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnnvm_1_1Graph.html">nnvm::Graph</a> mxnet::alm::OptimizeLayout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classnnvm_1_1Graph.html">nnvm::Graph</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>g</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>\bried Top-level function to run layout optimization. </p>
</div>
</div>
<a id="a1dcd10f7b9ef7846a9ede64377a3e1a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1dcd10f7b9ef7846a9ede64377a3e1a1">&#9670;&nbsp;</a></span>Reverse()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> mxnet::alm::Reverse </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacemxnet_1_1alm.html#a80e5ee70df5882f2a2dfcd8e8390087a">Transpose</a> &amp;&#160;</td>
<td class="paramname"><em>axes</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 03:47:41 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>