| <!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>Apache Singa: singa::Accuracy 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">Apache Singa |
| </div> |
| <div id="projectbrief">A General Distributed Deep Learning Library</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="namespacesinga.html">singa</a></li><li class="navelem"><a class="el" href="classsinga_1_1Accuracy.html">Accuracy</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classsinga_1_1Accuracy-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">singa::Accuracy Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Compute the accuray of the prediction, which is matched against the ground truth labels. |
| <a href="classsinga_1_1Accuracy.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="metric_8h_source.html">metric.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for singa::Accuracy:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classsinga_1_1Accuracy__inherit__graph.png" border="0" usemap="#singa_1_1Accuracy_inherit__map" alt="Inheritance graph"/></div> |
| <!-- MAP 0 --> |
| <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> |
| <div class="dynheader"> |
| Collaboration diagram for singa::Accuracy:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classsinga_1_1Accuracy__coll__graph.png" border="0" usemap="#singa_1_1Accuracy_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 1 --> |
| <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></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:a5151ebab1b0436d6330ad24656b52b3d"><td class="memItemLeft" align="right" valign="top"><a id="a5151ebab1b0436d6330ad24656b52b3d"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Accuracy.html#a5151ebab1b0436d6330ad24656b52b3d">Setup</a> (const MetricConf &conf) override</td></tr> |
| <tr class="memdesc:a5151ebab1b0436d6330ad24656b52b3d"><td class="mdescLeft"> </td><td class="mdescRight">Set meta fields from user configurations. <br /></td></tr> |
| <tr class="separator:a5151ebab1b0436d6330ad24656b52b3d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a70d7d98ad29bc5a4b115a610d382b04f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsinga_1_1Tensor.html">Tensor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Accuracy.html#a70d7d98ad29bc5a4b115a610d382b04f">Forward</a> (const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &prediction, const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &target)</td></tr> |
| <tr class="memdesc:a70d7d98ad29bc5a4b115a610d382b04f"><td class="mdescLeft"> </td><td class="mdescRight">Check the prediction against the target (ground truth) for each data sample. <a href="#a70d7d98ad29bc5a4b115a610d382b04f">More...</a><br /></td></tr> |
| <tr class="separator:a70d7d98ad29bc5a4b115a610d382b04f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classsinga_1_1Metric"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsinga_1_1Metric')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classsinga_1_1Metric.html">singa::Metric</a></td></tr> |
| <tr class="memitem:a62178144c6f4b219bd1f403716862d9b inherit pub_methods_classsinga_1_1Metric"><td class="memItemLeft" align="right" valign="top"><a id="a62178144c6f4b219bd1f403716862d9b"></a> |
| virtual void </td><td class="memItemRight" valign="bottom"><b>ToDevice</b> (std::shared_ptr< <a class="el" href="classsinga_1_1Device.html">Device</a> > device)</td></tr> |
| <tr class="separator:a62178144c6f4b219bd1f403716862d9b inherit pub_methods_classsinga_1_1Metric"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a76de5dfdcaef7166babb1f4a4757dde5 inherit pub_methods_classsinga_1_1Metric"><td class="memItemLeft" align="right" valign="top"><a id="a76de5dfdcaef7166babb1f4a4757dde5"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>Setup</b> (const string &conf)</td></tr> |
| <tr class="separator:a76de5dfdcaef7166babb1f4a4757dde5 inherit pub_methods_classsinga_1_1Metric"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aed1195424d9e3dcbf14517b09733c172 inherit pub_methods_classsinga_1_1Metric"><td class="memItemLeft" align="right" valign="top"><a id="aed1195424d9e3dcbf14517b09733c172"></a> |
| float </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Metric.html#aed1195424d9e3dcbf14517b09733c172">Evaluate</a> (const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &prediction, const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &target)</td></tr> |
| <tr class="memdesc:aed1195424d9e3dcbf14517b09733c172 inherit pub_methods_classsinga_1_1Metric"><td class="mdescLeft"> </td><td class="mdescRight">Comptue the metric value averaged over all samples (in a batch) <br /></td></tr> |
| <tr class="separator:aed1195424d9e3dcbf14517b09733c172 inherit pub_methods_classsinga_1_1Metric"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Compute the accuray of the prediction, which is matched against the ground truth labels. </p> |
| <p>TODO(wangwei) consider multi-label cases. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a70d7d98ad29bc5a4b115a610d382b04f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a70d7d98ad29bc5a4b115a610d382b04f">◆ </a></span>Forward()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classsinga_1_1Tensor.html">Tensor</a> singa::Accuracy::Forward </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> & </td> |
| <td class="paramname"><em>prediction</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> & </td> |
| <td class="paramname"><em>target</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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Check the prediction against the target (ground truth) for each data sample. </p> |
| <p>The returned <a class="el" href="classsinga_1_1Tensor.html" title="A Tensor instance is a multi-dimensional array resident on a Device (default device is the host CPU)...">Tensor</a> has a float value for each sample, 0 for wrong and 1 for correct. Users can call Sum(const Tensor&) / <a class="el" href="classsinga_1_1Tensor.html#a1c38d62986020862905d1307c09972e0" title="Return number of total elements. ">Tensor::Size()</a> to get the accuracy. </p> |
| |
| <p>Implements <a class="el" href="classsinga_1_1Metric.html#a4b054fad66714476b2477248f80faeab">singa::Metric</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/home/moaz/incubator-singa/include/singa/model/<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 Mon Apr 22 2019 12:27:05 for Apache Singa 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> |
