| <!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: /home/moaz/incubator-singa/include/singa/model/metric.h Source File</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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_14a988756d30161f7e1f48b05d03905d.html">singa</a></li><li class="navelem"><a class="el" href="dir_1ed15e94f94d348ba7de93ac6315cc91.html">model</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">metric.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef SINGA_MODEL_METRIC_H_</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define SINGA_MODEL_METRIC_H_</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "singa/core/tensor.h"</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "singa/proto/model.pb.h"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span><a class="code" href="namespacesinga.html">singa</a> {</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// template <typename T = Tensor></span></div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classsinga_1_1Metric.html"> 32</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1Metric.html">Metric</a> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="comment">// TODO(wangwei) call Setup using a default MetricConf.</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <a class="code" href="classsinga_1_1Metric.html">Metric</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">virtual</span> ~<a class="code" href="classsinga_1_1Metric.html">Metric</a>() {}</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> ToDevice(std::shared_ptr<Device> device) {}</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">void</span> Setup(<span class="keyword">const</span> <span class="keywordtype">string</span>& conf) {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  MetricConf metric;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  metric.ParseFromString(conf);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  Setup(metric);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  }</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classsinga_1_1Metric.html#a0d5f2debebaedd389a59a2ee18068175"> 45</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Metric.html#a0d5f2debebaedd389a59a2ee18068175">Setup</a>(<span class="keyword">const</span> MetricConf& conf) {}</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">virtual</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> <a class="code" href="classsinga_1_1Metric.html#a4b054fad66714476b2477248f80faeab">Forward</a>(<span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& prediction, <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& target) = 0;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classsinga_1_1Metric.html#aed1195424d9e3dcbf14517b09733c172"> 51</a></span>  <span class="keywordtype">float</span> <a class="code" href="classsinga_1_1Metric.html#aed1195424d9e3dcbf14517b09733c172">Evaluate</a>(<span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& prediction, <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& target) {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> metric = <a class="code" href="classsinga_1_1Metric.html#a4b054fad66714476b2477248f80faeab">Forward</a>(prediction, target);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">return</span> Sum<float>(metric) / (1.0f * metric.<a class="code" href="classsinga_1_1Tensor.html#a1c38d62986020862905d1307c09972e0">Size</a>());</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  }</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> };</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classsinga_1_1Accuracy.html"> 59</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1Accuracy.html">Accuracy</a> : <span class="keyword">public</span> <a class="code" href="classsinga_1_1Metric.html">Metric</a> {</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classsinga_1_1Accuracy.html#a5151ebab1b0436d6330ad24656b52b3d"> 62</a></span>  <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Accuracy.html#a5151ebab1b0436d6330ad24656b52b3d">Setup</a>(<span class="keyword">const</span> MetricConf& conf)<span class="keyword"> override </span>{ top_k_ = conf.top_k(); }</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> <a class="code" href="classsinga_1_1Metric.html#a4b054fad66714476b2477248f80faeab">Forward</a>(<span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& prediction, <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& target);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> Match(<span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& prediction, <span class="keyword">const</span> vector<int>& target);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">size_t</span> top_k_ = 1;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> };</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> } <span class="comment">// namespace singa</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#endif // SINGA_MODEL_METRIC_H_</span></div><div class="ttc" id="classsinga_1_1Accuracy_html_a5151ebab1b0436d6330ad24656b52b3d"><div class="ttname"><a href="classsinga_1_1Accuracy.html#a5151ebab1b0436d6330ad24656b52b3d">singa::Accuracy::Setup</a></div><div class="ttdeci">void Setup(const MetricConf &conf) override</div><div class="ttdoc">Set meta fields from user configurations. </div><div class="ttdef"><b>Definition:</b> metric.h:62</div></div> |
| <div class="ttc" id="classsinga_1_1Metric_html_aed1195424d9e3dcbf14517b09733c172"><div class="ttname"><a href="classsinga_1_1Metric.html#aed1195424d9e3dcbf14517b09733c172">singa::Metric::Evaluate</a></div><div class="ttdeci">float Evaluate(const Tensor &prediction, const Tensor &target)</div><div class="ttdoc">Comptue the metric value averaged over all samples (in a batch) </div><div class="ttdef"><b>Definition:</b> metric.h:51</div></div> |
| <div class="ttc" id="classsinga_1_1Metric_html_a0d5f2debebaedd389a59a2ee18068175"><div class="ttname"><a href="classsinga_1_1Metric.html#a0d5f2debebaedd389a59a2ee18068175">singa::Metric::Setup</a></div><div class="ttdeci">virtual void Setup(const MetricConf &conf)</div><div class="ttdoc">Set meta fields from user configurations. </div><div class="ttdef"><b>Definition:</b> metric.h:45</div></div> |
| <div class="ttc" id="classsinga_1_1Tensor_html"><div class="ttname"><a href="classsinga_1_1Tensor.html">singa::Tensor</a></div><div class="ttdoc">A Tensor instance is a multi-dimensional array resident on a Device (default device is the host CPU)...</div><div class="ttdef"><b>Definition:</b> tensor.h:56</div></div> |
| <div class="ttc" id="classsinga_1_1Metric_html_a4b054fad66714476b2477248f80faeab"><div class="ttname"><a href="classsinga_1_1Metric.html#a4b054fad66714476b2477248f80faeab">singa::Metric::Forward</a></div><div class="ttdeci">virtual Tensor Forward(const Tensor &prediction, const Tensor &target)=0</div><div class="ttdoc">Compute the metric for each data sample. </div></div> |
| <div class="ttc" id="classsinga_1_1Accuracy_html"><div class="ttname"><a href="classsinga_1_1Accuracy.html">singa::Accuracy</a></div><div class="ttdoc">Compute the accuray of the prediction, which is matched against the ground truth labels. </div><div class="ttdef"><b>Definition:</b> metric.h:59</div></div> |
| <div class="ttc" id="classsinga_1_1Metric_html"><div class="ttname"><a href="classsinga_1_1Metric.html">singa::Metric</a></div><div class="ttdoc">The base metric class, which declares the APIs for computing the performance evaluation metrics given...</div><div class="ttdef"><b>Definition:</b> metric.h:32</div></div> |
| <div class="ttc" id="namespacesinga_html"><div class="ttname"><a href="namespacesinga.html">singa</a></div><div class="ttdoc">Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements...</div><div class="ttdef"><b>Definition:</b> common.h:48</div></div> |
| <div class="ttc" id="classsinga_1_1Tensor_html_a1c38d62986020862905d1307c09972e0"><div class="ttname"><a href="classsinga_1_1Tensor.html#a1c38d62986020862905d1307c09972e0">singa::Tensor::Size</a></div><div class="ttdeci">size_t Size() const</div><div class="ttdoc">Return number of total elements. </div><div class="ttdef"><b>Definition:</b> tensor.h:128</div></div> |
| </div><!-- fragment --></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> |
