Google Git
Sign in
android / platform / external / armnn / d15ee15e / . / Documentation / classarmnn_utils_1_1_model_accuracy_checker.html
blob: 44247da02669c7b8c9834363ad3bf2806a739cca [file] [log] [blame]
<!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>ArmNN: ModelAccuracyChecker 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</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">ArmNN
&#160;<span id="projectnumber">NotReleased</span>
</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 -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classarmnn_utils_1_1_model_accuracy_checker.html','');});
</script>
<div id="doc-content">
<!-- 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="#pub-methods">Public Member Functions</a> &#124;
<a href="classarmnn_utils_1_1_model_accuracy_checker-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ModelAccuracyChecker Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_model_accuracy_checker_8hpp_source.html">ModelAccuracyChecker.hpp</a>&gt;</code></p>
<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:a143dac91f5ef85d672e7bccb0358e3f7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_utils_1_1_model_accuracy_checker.html#a143dac91f5ef85d672e7bccb0358e3f7">ModelAccuracyChecker</a> (const std::map&lt; std::string, std::string &gt; &amp;validationLabelSet, const std::vector&lt; <a class="el" href="namespacearmnn_utils.html#ab175d8bf2482d5a39c2331d1f0ddcece">LabelCategoryNames</a> &gt; &amp;modelOutputLabels)</td></tr>
<tr class="separator:a143dac91f5ef85d672e7bccb0358e3f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6ddd3b77dd12eb33875d58a391b2412"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_utils_1_1_model_accuracy_checker.html#ad6ddd3b77dd12eb33875d58a391b2412">GetAccuracy</a> (unsigned int k)</td></tr>
<tr class="separator:ad6ddd3b77dd12eb33875d58a391b2412"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38d140dac29d228fdd1681e465507c29"><td class="memTemplParams" colspan="2">template&lt;typename TContainer &gt; </td></tr>
<tr class="memitem:a38d140dac29d228fdd1681e465507c29"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarmnn_utils_1_1_model_accuracy_checker.html#a38d140dac29d228fdd1681e465507c29">AddImageResult</a> (const std::string &amp;imageName, std::vector&lt; <a class="el" href="namespacearmnn.html#a9eb69ebdaf4ceb8014e7c8a540266100">TContainer</a> &gt; outputTensor)</td></tr>
<tr class="separator:a38d140dac29d228fdd1681e465507c29"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="_model_accuracy_checker_8hpp_source.html#l00045">45</a> of file <a class="el" href="_model_accuracy_checker_8hpp_source.html">ModelAccuracyChecker.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a143dac91f5ef85d672e7bccb0358e3f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a143dac91f5ef85d672e7bccb0358e3f7">&#9670;&nbsp;</a></span>ModelAccuracyChecker()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarmnn_utils_1_1_model_accuracy_checker.html">ModelAccuracyChecker</a> </td>
<td>(</td>
<td class="paramtype">const std::map&lt; std::string, std::string &gt; &amp;&#160;</td>
<td class="paramname"><em>validationLabelSet</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; <a class="el" href="namespacearmnn_utils.html#ab175d8bf2482d5a39c2331d1f0ddcece">LabelCategoryNames</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>modelOutputLabels</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for a model top k accuracy checker</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">validationLabelSet</td><td>Mapping from names of images to be validated, to category names of their corresponding ground-truth labels. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">modelOutputLabels</td><td>Mapping from output nodes to the category names of their corresponding labels Note that an output node can have multiple category names. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_model_accuracy_checker_8cpp_source.html#l00017">17</a> of file <a class="el" href="_model_accuracy_checker_8cpp_source.html">ModelAccuracyChecker.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; : m_GroundTruthLabelSet(validationLabels)</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; , m_ModelOutputLabels(modelOutputLabels)</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;{}</div></div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a38d140dac29d228fdd1681e465507c29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38d140dac29d228fdd1681e465507c29">&#9670;&nbsp;</a></span>AddImageResult()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void AddImageResult </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>imageName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; <a class="el" href="namespacearmnn.html#a9eb69ebdaf4ceb8014e7c8a540266100">TContainer</a> &gt;&#160;</td>
<td class="paramname"><em>outputTensor</em>&#160;</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Record the prediction result of an image</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">imageName</td><td>Name of the image. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">outputTensor</td><td>Output tensor of the network running <code>imageName</code>. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_model_accuracy_checker_8hpp_source.html#l00073">73</a> of file <a class="el" href="_model_accuracy_checker_8hpp_source.html">ModelAccuracyChecker.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="_model_accuracy_checker_test_8cpp_source.html#l00061">BOOST_FIXTURE_TEST_CASE()</a>.</p>
<div class="fragment"><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; {</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="comment">// Increment the total number of images processed</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; ++m_ImagesProcessed;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; std::map&lt;int, float&gt; confidenceMap;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keyword">auto</span>&amp; output = outputTensor[0];</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="comment">// Create a map of all predictions</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; boost::apply_visitor([&amp;confidenceMap](<span class="keyword">auto</span> &amp;&amp; value)</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keywordtype">int</span> index = 0;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span> &amp; o : value)</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; {</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordflow">if</span> (o &gt; 0)</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; {</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; confidenceMap.insert(std::pair&lt;int, float&gt;(index, static_cast&lt;float&gt;(o)));</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; }</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; ++index;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; }</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; },</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; output);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="comment">// Create a comparator for sorting the map in order of highest probability</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keyword">typedef</span> std::function&lt;bool(std::pair&lt;int, float&gt;, std::pair&lt;int, float&gt;)&gt; Comparator;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; Comparator compFunctor =</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; [](std::pair&lt;int, float&gt; element1, std::pair&lt;int, float&gt; element2)</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; {</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordflow">return</span> element1.second &gt; element2.second;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; };</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="comment">// Do the sorting and store in an ordered set</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; std::set&lt;std::pair&lt;int, float&gt;, Comparator&gt; setOfPredictions(</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; confidenceMap.begin(), confidenceMap.end(), compFunctor);</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keyword">const</span> std::string correctLabel = m_GroundTruthLabelSet.at(imageName);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index = 1;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keywordflow">for</span> (std::pair&lt;int, float&gt; element : setOfPredictions)</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; {</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keywordflow">if</span> (index &gt;= m_TopK.size())</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; {</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keywordflow">break</span>;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; }</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="comment">// Check if the ground truth label value is included in the topi prediction.</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="comment">// Note that a prediction can have multiple prediction labels.</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keyword">const</span> <a class="code" href="namespacearmnn_utils.html#ab175d8bf2482d5a39c2331d1f0ddcece">LabelCategoryNames</a> predictionLabels = m_ModelOutputLabels[<span class="keyword">static_cast&lt;</span><span class="keywordtype">size_t</span><span class="keyword">&gt;</span>(element.first)];</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keywordflow">if</span> (std::find(predictionLabels.begin(), predictionLabels.end(), correctLabel) != predictionLabels.end())</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; {</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; ++m_TopK[index];</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keywordflow">break</span>;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; }</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; ++index;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; }</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; }</div><div class="ttc" id="namespacearmnn_utils_html_ab175d8bf2482d5a39c2331d1f0ddcece"><div class="ttname"><a href="namespacearmnn_utils.html#ab175d8bf2482d5a39c2331d1f0ddcece">armnnUtils::LabelCategoryNames</a></div><div class="ttdeci">std::vector&lt; std::string &gt; LabelCategoryNames</div><div class="ttdef"><b>Definition:</b> <a href="_model_accuracy_checker_8hpp_source.html#l00025">ModelAccuracyChecker.hpp:25</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="ad6ddd3b77dd12eb33875d58a391b2412"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6ddd3b77dd12eb33875d58a391b2412">&#9670;&nbsp;</a></span>GetAccuracy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float GetAccuracy </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>k</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Top K accuracy</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">k</td><td>The number of top predictions to use for validating the ground-truth label. For example, if <code>k</code> is 3, then a prediction is considered correct as long as the ground-truth appears in the top 3 predictions. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The accuracy, according to the top <code>k</code> th predictions. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_model_accuracy_checker_8cpp_source.html#l00023">23</a> of file <a class="el" href="_model_accuracy_checker_8cpp_source.html">ModelAccuracyChecker.cpp</a>.</p>
<p class="reference">References <a class="el" href="_logging_8hpp_source.html#l00163">ARMNN_LOG</a>, and <a class="el" href="namespacearmnn.html#a4dc0adc6737b5944e7671bee71788407a7b83d3f08fa392b79e3f553b585971cd">armnn::warning</a>.</p>
<p class="reference">Referenced by <a class="el" href="_model_accuracy_checker_test_8cpp_source.html#l00061">BOOST_FIXTURE_TEST_CASE()</a>.</p>
<div class="fragment"><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordflow">if</span> (k &gt; 10)</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <a class="code" href="_logging_8hpp.html#a7b6ad073975f437ec38ca7d20154727f">ARMNN_LOG</a>(warning) &lt;&lt; <span class="stringliteral">&quot;Accuracy Tool only supports a maximum of Top 10 Accuracy. &quot;</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="stringliteral">&quot;Printing Top 10 Accuracy result!&quot;</span>;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; k = 10;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; }</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> total = 0;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = k; i &gt; 0; --i)</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; total += m_TopK[i];</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; }</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span><span class="keywordtype">float</span><span class="keyword">&gt;</span>(total * 100) / static_cast&lt;float&gt;(m_ImagesProcessed);</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;}</div><div class="ttc" id="_logging_8hpp_html_a7b6ad073975f437ec38ca7d20154727f"><div class="ttname"><a href="_logging_8hpp.html#a7b6ad073975f437ec38ca7d20154727f">ARMNN_LOG</a></div><div class="ttdeci">#define ARMNN_LOG(severity)</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8hpp_source.html#l00163">Logging.hpp:163</a></div></div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/armnnUtils/<a class="el" href="_model_accuracy_checker_8hpp_source.html">ModelAccuracyChecker.hpp</a></li>
<li>src/armnnUtils/<a class="el" href="_model_accuracy_checker_8cpp_source.html">ModelAccuracyChecker.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacearmnn_utils.html">armnnUtils</a></li><li class="navelem"><a class="el" href="classarmnn_utils_1_1_model_accuracy_checker.html">ModelAccuracyChecker</a></li>
<li class="footer">Generated on Fri Mar 13 2020 16:07:06 for ArmNN by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>