| <!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/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: Dnnl_api_softmax</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.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <!-- 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 class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">Dnnl_api_softmax<div class="ingroups"><a class="el" href="group__dnnl__api.html">Dnnl_api</a> » <a class="el" href="group__dnnl__api__primitives.html">Dnnl_api_primitives</a></div></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="dynheader"> |
| Collaboration diagram for Dnnl_api_softmax:</div> |
| <div class="dyncontent"> |
| <center><table><tr><td><img src="group__dnnl__api__softmax.png" border="0" alt="" usemap="#group____dnnl____api____softmax"/> |
| <map name="group____dnnl____api____softmax" id="group____dnnl____api____softmax"> |
| <area shape="rect" id="node2" href="group__dnnl__api__primitives.html" title="Dnnl_api_primitives" alt="" coords="5,5,157,32"/> |
| </map> |
| </td></tr></table></center> |
| </div> |
| <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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structdnnl__softmax__desc__t.html">dnnl_softmax_desc_t</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A descriptor of a Softmax operation. <a href="structdnnl__softmax__desc__t.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </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:ga6cf7ee9ca39f755a982d82670a7d7bc5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__softmax.html#ga6cf7ee9ca39f755a982d82670a7d7bc5">dnnl_softmax_forward_desc_init</a> (<a class="el" href="structdnnl__softmax__desc__t.html">dnnl_softmax_desc_t</a> *softmax_desc, <a class="el" href="group__dnnl__api__primitives__common.html#gae3c1f22ae55645782923fbfd8b07d0c4">dnnl_prop_kind_t</a> prop_kind, const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> *data_desc, int softmax_axis)</td></tr> |
| <tr class="separator:ga6cf7ee9ca39f755a982d82670a7d7bc5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga68baa791cd85c9e3ddd3dbc5889ba0ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__softmax.html#ga68baa791cd85c9e3ddd3dbc5889ba0ba">dnnl_softmax_backward_desc_init</a> (<a class="el" href="structdnnl__softmax__desc__t.html">dnnl_softmax_desc_t</a> *softmax_desc, const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> *diff_data_desc, const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> *data_desc, int softmax_axis)</td></tr> |
| <tr class="separator:ga68baa791cd85c9e3ddd3dbc5889ba0ba"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a id="ga68baa791cd85c9e3ddd3dbc5889ba0ba"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga68baa791cd85c9e3ddd3dbc5889ba0ba">◆ </a></span>dnnl_softmax_backward_desc_init()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_softmax_backward_desc_init </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structdnnl__softmax__desc__t.html">dnnl_softmax_desc_t</a> * </td> |
| <td class="paramname"><em>softmax_desc</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> * </td> |
| <td class="paramname"><em>diff_data_desc</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> * </td> |
| <td class="paramname"><em>data_desc</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>softmax_axis</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Initializes a descriptor for softmax backward propagation primitive.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">softmax_desc</td><td>Output descriptor for a softmax primitive. </td></tr> |
| <tr><td class="paramname">diff_data_desc</td><td>Diff source and diff destination memory descriptors. </td></tr> |
| <tr><td class="paramname">data_desc</td><td>Destination memory descriptor. </td></tr> |
| <tr><td class="paramname">softmax_axis</td><td>Axis over which softmax is computed. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga6cf7ee9ca39f755a982d82670a7d7bc5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga6cf7ee9ca39f755a982d82670a7d7bc5">◆ </a></span>dnnl_softmax_forward_desc_init()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_softmax_forward_desc_init </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structdnnl__softmax__desc__t.html">dnnl_softmax_desc_t</a> * </td> |
| <td class="paramname"><em>softmax_desc</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__primitives__common.html#gae3c1f22ae55645782923fbfd8b07d0c4">dnnl_prop_kind_t</a> </td> |
| <td class="paramname"><em>prop_kind</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> * </td> |
| <td class="paramname"><em>data_desc</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>softmax_axis</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Initializes a descriptor for softmax forward propagation primitive.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">softmax_desc</td><td>Output descriptor for a softmax primitive. </td></tr> |
| <tr><td class="paramname">prop_kind</td><td>Propagation kind. Possible values are <a class="el" href="group__dnnl__api__primitives__common.html#ggae3c1f22ae55645782923fbfd8b07d0c4a992e03bebfe623ac876b3636333bbce0">dnnl_forward_training</a> and <a class="el" href="group__dnnl__api__primitives__common.html#ggae3c1f22ae55645782923fbfd8b07d0c4a2f77a568a675dec649eb0450c997856d">dnnl_forward_inference</a>. </td></tr> |
| <tr><td class="paramname">data_desc</td><td>Source and destination memory descriptor. </td></tr> |
| <tr><td class="paramname">softmax_axis</td><td>Axis over which softmax is computed. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Wed Jun 8 2022 23:30:30 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |