| <!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: mxnet::cpp::EvalMetric Class 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.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> |
| <!-- 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_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 src="classmxnet_1_1cpp_1_1EvalMetric__inherit__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1EvalMetric_inherit__map" alt="Inheritance graph"/></div> |
| <map name="mxnet_1_1cpp_1_1EvalMetric_inherit__map" id="mxnet_1_1cpp_1_1EvalMetric_inherit__map"> |
| <area shape="rect" id="node2" href="classmxnet_1_1cpp_1_1Accuracy.html" title="{mxnet::cpp::Accuracy\n||+ Accuracy()\l+ Update()\l}" alt="" coords="5,248,168,340"/> |
| <area shape="rect" id="node3" href="classmxnet_1_1cpp_1_1LogLoss.html" title="{mxnet::cpp::LogLoss\n||+ LogLoss()\l+ Update()\l}" alt="" coords="192,248,347,340"/> |
| <area shape="rect" id="node4" href="classmxnet_1_1cpp_1_1MAE.html" title="{mxnet::cpp::MAE\n||+ MAE()\l+ Update()\l}" alt="" coords="371,248,501,340"/> |
| <area shape="rect" id="node5" href="classmxnet_1_1cpp_1_1MSE.html" title="{mxnet::cpp::MSE\n||+ MSE()\l+ Update()\l}" alt="" coords="525,248,656,340"/> |
| <area shape="rect" id="node6" href="classmxnet_1_1cpp_1_1PSNR.html" title="{mxnet::cpp::PSNR\n||+ PSNR()\l+ Update()\l}" alt="" coords="680,248,819,340"/> |
| <area shape="rect" id="node7" href="classmxnet_1_1cpp_1_1RMSE.html" title="{mxnet::cpp::RMSE\n||+ RMSE()\l+ Update()\l}" alt="" coords="843,248,981,340"/> |
| </map> |
| </div> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::cpp::EvalMetric:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmxnet_1_1cpp_1_1EvalMetric__coll__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1EvalMetric_coll__map" alt="Collaboration graph"/></div> |
| <map name="mxnet_1_1cpp_1_1EvalMetric_coll__map" id="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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 id="a1b5a769b85867b135d7493175f81b96d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1b5a769b85867b135d7493175f81b96d">◆ </a></span>EvalMetric()</h2> |
| |
| <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 id="a624ac9ba2f3b6e9ecadc352321f88065"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a624ac9ba2f3b6e9ecadc352321f88065">◆ </a></span>CheckLabelShapes()</h2> |
| |
| <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 id="aec48aecbf724835808fce89db818507c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aec48aecbf724835808fce89db818507c">◆ </a></span>Get()</h2> |
| |
| <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 id="a594eda0005a14a2294ba00f42d6315ee"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a594eda0005a14a2294ba00f42d6315ee">◆ </a></span>GetNameValue()</h2> |
| |
| <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 id="af7ef1b2b082f547e78af7a20b0bfb463"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af7ef1b2b082f547e78af7a20b0bfb463">◆ </a></span>Reset()</h2> |
| |
| <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 id="ade7cc55a3dd2d94e7b468ba16751ef62"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ade7cc55a3dd2d94e7b468ba16751ef62">◆ </a></span>Update()</h2> |
| |
| <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 id="aa6c5fffe252895a404f0d1016897805a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa6c5fffe252895a404f0d1016897805a">◆ </a></span>name</h2> |
| |
| <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 id="aec5f85b4dbf7132efca0755cad5a58d8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aec5f85b4dbf7132efca0755cad5a58d8">◆ </a></span>num</h2> |
| |
| <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 id="a8fe15b123022e22ddadc3ccddd7b4d01"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8fe15b123022e22ddadc3ccddd7b4d01">◆ </a></span>num_inst</h2> |
| |
| <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 id="a04b41a66d3c72e1befaf96205eb3a2d0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a04b41a66d3c72e1befaf96205eb3a2d0">◆ </a></span>sum_metric</h2> |
| |
| <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>/work/mxnet/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 Wed Jun 8 2022 23:30:31 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> |