| <!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 content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/> |
| <meta content="IE=9" http-equiv="X-UA-Compatible"/> |
| <meta content="Doxygen 1.8.11" name="generator"/> |
| <title>mxnet: mxnet::cpp::EvalMetric Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script src="jquery.js" type="text/javascript"></script> |
| <script src="dynsections.js" type="text/javascript"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script src="search/searchdata.js" type="text/javascript"></script> |
| <script src="search/search.js" type="text/javascript"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { init_search(); }); |
| </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 cellpadding="0" cellspacing="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.11 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div class="tabs" id="navrow1"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div class="MSearchBoxInactive" id="MSearchBox"> |
| <span class="left"> |
| <img alt="" id="MSearchSelect" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()" src="search/mag_sel.png"/> |
| <input accesskey="S" id="MSearchField" onblur="searchBox.OnSearchFieldFocus(false)" onfocus="searchBox.OnSearchFieldFocus(true)" onkeyup="searchBox.OnSearchFieldChange(event)" type="text" value="Search"/> |
| </span><span class="right"> |
| <a href="javascript:searchBox.CloseResultsWindow()" id="MSearchClose"><img alt="" border="0" id="MSearchCloseImg" src="search/close.png"/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="tabs2" id="navrow2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()"> |
| </div> |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)"> |
| </iframe> |
| </div> |
| <div class="navpath" id="nav-path"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="namespacemxnet_1_1cpp.html">cpp</a></li><li class="navelem"><a class="el" href="classmxnet_1_1cpp_1_1EvalMetric.html">EvalMetric</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-static-methods">Static Protected Member Functions</a> | |
| <a href="#pro-attribs">Protected Attributes</a> | |
| <a href="classmxnet_1_1cpp_1_1EvalMetric-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::cpp::EvalMetric Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <p><code>#include <<a class="el" href="metric_8h_source.html">metric.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for mxnet::cpp::EvalMetric:</div> |
| <div class="dyncontent"> |
| <div class="center"><img alt="Inheritance graph" border="0" src="classmxnet_1_1cpp_1_1EvalMetric__inherit__graph.png" usemap="#mxnet_1_1cpp_1_1EvalMetric_inherit__map"/></div> |
| <map id="mxnet_1_1cpp_1_1EvalMetric_inherit__map" name="mxnet_1_1cpp_1_1EvalMetric_inherit__map"> |
| <area alt="" coords="5,248,165,340" href="classmxnet_1_1cpp_1_1Accuracy.html" id="node2" shape="rect" title="{mxnet::cpp::Accuracy\n||+ Accuracy()\l+ Update()\l}"/> |
| <area alt="" coords="189,248,344,340" href="classmxnet_1_1cpp_1_1LogLoss.html" id="node3" shape="rect" title="{mxnet::cpp::LogLoss\n||+ LogLoss()\l+ Update()\l}"/> |
| <area alt="" coords="368,248,499,340" href="classmxnet_1_1cpp_1_1MAE.html" id="node4" shape="rect" title="{mxnet::cpp::MAE\n||+ MAE()\l+ Update()\l}"/> |
| <area alt="" coords="523,248,653,340" href="classmxnet_1_1cpp_1_1MSE.html" id="node5" shape="rect" title="{mxnet::cpp::MSE\n||+ MSE()\l+ Update()\l}"/> |
| <area alt="" coords="678,248,815,340" href="classmxnet_1_1cpp_1_1PSNR.html" id="node6" shape="rect" title="{mxnet::cpp::PSNR\n||+ PSNR()\l+ Update()\l}"/> |
| <area alt="" coords="840,248,979,340" href="classmxnet_1_1cpp_1_1RMSE.html" id="node7" shape="rect" title="{mxnet::cpp::RMSE\n||+ RMSE()\l+ Update()\l}"/> |
| </map> |
| </div> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::cpp::EvalMetric:</div> |
| <div class="dyncontent"> |
| <div class="center"><img alt="Collaboration graph" border="0" src="classmxnet_1_1cpp_1_1EvalMetric__coll__graph.png" usemap="#mxnet_1_1cpp_1_1EvalMetric_coll__map"/></div> |
| <map id="mxnet_1_1cpp_1_1EvalMetric_coll__map" name="mxnet_1_1cpp_1_1EvalMetric_coll__map"> |
| </map> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a1b5a769b85867b135d7493175f81b96d"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1EvalMetric.html#a1b5a769b85867b135d7493175f81b96d">EvalMetric</a> (const std::string &<a class="el" href="classmxnet_1_1cpp_1_1EvalMetric.html#aa6c5fffe252895a404f0d1016897805a">name</a>, int <a class="el" href="classmxnet_1_1cpp_1_1EvalMetric.html#aec5f85b4dbf7132efca0755cad5a58d8">num</a>=0)</td></tr> |
| <tr class="separator:a1b5a769b85867b135d7493175f81b96d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ade7cc55a3dd2d94e7b468ba16751ef62"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1EvalMetric.html#ade7cc55a3dd2d94e7b468ba16751ef62">Update</a> (<a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> labels, <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> preds)=0</td></tr> |
| <tr class="separator:ade7cc55a3dd2d94e7b468ba16751ef62"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af7ef1b2b082f547e78af7a20b0bfb463"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1EvalMetric.html#af7ef1b2b082f547e78af7a20b0bfb463">Reset</a> ()</td></tr> |
| <tr class="separator:af7ef1b2b082f547e78af7a20b0bfb463"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aec48aecbf724835808fce89db818507c"><td align="right" class="memItemLeft" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1EvalMetric.html#aec48aecbf724835808fce89db818507c">Get</a> ()</td></tr> |
| <tr class="separator:aec48aecbf724835808fce89db818507c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a594eda0005a14a2294ba00f42d6315ee"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1EvalMetric.html#a594eda0005a14a2294ba00f42d6315ee">GetNameValue</a> ()</td></tr> |
| <tr class="separator:a594eda0005a14a2294ba00f42d6315ee"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a> |
| Static Protected Member Functions</h2></td></tr> |
| <tr class="memitem:a624ac9ba2f3b6e9ecadc352321f88065"><td align="right" class="memItemLeft" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1EvalMetric.html#a624ac9ba2f3b6e9ecadc352321f88065">CheckLabelShapes</a> (<a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> labels, <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> preds, bool strict=false)</td></tr> |
| <tr class="separator:a624ac9ba2f3b6e9ecadc352321f88065"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> |
| Protected Attributes</h2></td></tr> |
| <tr class="memitem:aa6c5fffe252895a404f0d1016897805a"><td align="right" class="memItemLeft" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1EvalMetric.html#aa6c5fffe252895a404f0d1016897805a">name</a></td></tr> |
| <tr class="separator:aa6c5fffe252895a404f0d1016897805a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aec5f85b4dbf7132efca0755cad5a58d8"><td align="right" class="memItemLeft" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1EvalMetric.html#aec5f85b4dbf7132efca0755cad5a58d8">num</a></td></tr> |
| <tr class="separator:aec5f85b4dbf7132efca0755cad5a58d8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a04b41a66d3c72e1befaf96205eb3a2d0"><td align="right" class="memItemLeft" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1EvalMetric.html#a04b41a66d3c72e1befaf96205eb3a2d0">sum_metric</a> = 0.0f</td></tr> |
| <tr class="separator:a04b41a66d3c72e1befaf96205eb3a2d0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8fe15b123022e22ddadc3ccddd7b4d01"><td align="right" class="memItemLeft" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1EvalMetric.html#a8fe15b123022e22ddadc3ccddd7b4d01">num_inst</a> = 0</td></tr> |
| <tr class="separator:a8fe15b123022e22ddadc3ccddd7b4d01"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a1b5a769b85867b135d7493175f81b96d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mxnet::cpp::EvalMetric::EvalMetric </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>num</em> = <code>0</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a624ac9ba2f3b6e9ecadc352321f88065"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static void mxnet::cpp::EvalMetric::CheckLabelShapes </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> </td> |
| <td class="paramname"><em>labels</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> </td> |
| <td class="paramname"><em>preds</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>strict</em> = <code>false</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="aec48aecbf724835808fce89db818507c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">float mxnet::cpp::EvalMetric::Get </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="a594eda0005a14a2294ba00f42d6315ee"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mxnet::cpp::EvalMetric::GetNameValue </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="af7ef1b2b082f547e78af7a20b0bfb463"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mxnet::cpp::EvalMetric::Reset </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="ade7cc55a3dd2d94e7b468ba16751ef62"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void mxnet::cpp::EvalMetric::Update </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> </td> |
| <td class="paramname"><em>labels</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> </td> |
| <td class="paramname"><em>preds</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Implemented in <a class="el" href="classmxnet_1_1cpp_1_1PSNR.html#a864bbff414993c2972e28383acf6fc9e">mxnet::cpp::PSNR</a>, <a class="el" href="classmxnet_1_1cpp_1_1RMSE.html#aedc9d28f514faba77ad99182f5dbb63b">mxnet::cpp::RMSE</a>, <a class="el" href="classmxnet_1_1cpp_1_1MSE.html#a3381768d558f36abbf157be1f2f0b18f">mxnet::cpp::MSE</a>, <a class="el" href="classmxnet_1_1cpp_1_1MAE.html#a52ed42c6c91d64cc0d39c800631f9a3c">mxnet::cpp::MAE</a>, <a class="el" href="classmxnet_1_1cpp_1_1LogLoss.html#a988259bdb3a115a226034b90d1b6603e">mxnet::cpp::LogLoss</a>, and <a class="el" href="classmxnet_1_1cpp_1_1Accuracy.html#a6759699d8fc376bb8065d3cd20e8b81b">mxnet::cpp::Accuracy</a>.</p> |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="aa6c5fffe252895a404f0d1016897805a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string mxnet::cpp::EvalMetric::name</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="aec5f85b4dbf7132efca0755cad5a58d8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int mxnet::cpp::EvalMetric::num</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="a8fe15b123022e22ddadc3ccddd7b4d01"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int mxnet::cpp::EvalMetric::num_inst = 0</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="a04b41a66d3c72e1befaf96205eb3a2d0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">float mxnet::cpp::EvalMetric::sum_metric = 0.0f</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>cpp-package/include/mxnet-cpp/<a class="el" href="metric_8h_source.html">metric.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Sep 19 2019 12:37:33 for mxnet by <a href="http://www.doxygen.org/index.html"> |
| <img alt="doxygen" class="footer" src="doxygen.png"/> |
| </a> 1.8.11 |
| </small></address> |
| </body> |
| </html> |
