Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 36eed46563a2a254e674865eb8ede62a1558c997 / . / Documentation / tests_2_model_accuracy_tool-_armnn_2_r_e_a_d_m_e_8md_source.html
blob: e81aabb7b359700e86ea7fa6e478471c9a9a135c [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.13"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>ArmNN: tests/ModelAccuracyTool-Armnn/README.md Source File</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="navtree.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="resize.js"></script>
14<script type="text/javascript" src="navtreedata.js"></script>
15<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<link href="doxygen.css" rel="stylesheet" type="text/css" />
23</head>
24<body>
25<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
26<div id="titlearea">
27<table cellspacing="0" cellpadding="0">
28 <tbody>
29 <tr style="height: 56px;">
30 <td id="projectalign" style="padding-left: 0.5em;">
31 <div id="projectname">ArmNN
32 &#160;<span id="projectnumber">NotReleased</span>
33 </div>
34 </td>
35 </tr>
36 </tbody>
37</table>
38</div>
39<!-- end header part -->
40<!-- Generated by Doxygen 1.8.13 -->
41<script type="text/javascript">
42var searchBox = new SearchBox("searchBox", "search",false,'Search');
43</script>
44<script type="text/javascript" src="menudata.js"></script>
45<script type="text/javascript" src="menu.js"></script>
46<script type="text/javascript">
47$(function() {
48 initMenu('',true,false,'search.php','Search');
49 $(document).ready(function() { init_search(); });
50});
51</script>
52<div id="main-nav"></div>
53</div><!-- top -->
54<div id="side-nav" class="ui-resizable side-nav-resizable">
55 <div id="nav-tree">
56 <div id="nav-tree-contents">
57 <div id="nav-sync" class="sync"></div>
58 </div>
59 </div>
60 <div id="splitbar" style="-moz-user-select:none;"
61 class="ui-resizable-handle">
62 </div>
63</div>
64<script type="text/javascript">
65$(document).ready(function(){initNavTree('tests_2_model_accuracy_tool-_armnn_2_r_e_a_d_m_e_8md.html','');});
66</script>
67<div id="doc-content">
68<!-- window showing the filter options -->
69<div id="MSearchSelectWindow"
70 onmouseover="return searchBox.OnSearchSelectShow()"
71 onmouseout="return searchBox.OnSearchSelectHide()"
72 onkeydown="return searchBox.OnSearchSelectKey(event)">
73</div>
74
75<!-- iframe showing the search results (closed by default) -->
76<div id="MSearchResultsWindow">
77<iframe src="javascript:void(0)" frameborder="0"
78 name="MSearchResults" id="MSearchResults">
79</iframe>
80</div>
81
82<div class="header">
83 <div class="headertitle">
84<div class="title">tests/ModelAccuracyTool-Armnn/README.md</div> </div>
85</div><!--header-->
86<div class="contents">
87<a href="tests_2_model_accuracy_tool-_armnn_2_r_e_a_d_m_e_8md.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;# The ModelAccuracyTool-Armnn</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;The `ModelAccuracyTool-Armnn` is a program for measuring the Top 5 accuracy results of a model against an image dataset.</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;Prerequisites:</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;1. The model is in .armnn format model file. The `ArmnnConverter` can be used to convert a model to this format.</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;Build option:</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;To build ModelAccuracyTool, pass the following options to Cmake:</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;* -DFLATC_DIR=/path/to/flatbuffers/x86build/</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;* -DBUILD_ACCURACY_TOOL=1</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;* -DBUILD_ARMNN_SERIALIZER=1</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;|Cmd:|||</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;| ---|---|---|</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;| -h | --help | Display help messages |</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;| -m | --model-path | Path to armnn format model file |</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;| -f | --model-format | The model format. Supported values: caffe, tensorflow, tflite |</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;| -i | --input-name | Identifier of the input tensors in the network separated by comma |</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;| -o | --output-name | Identifier of the output tensors in the network separated by comma |</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;| -d | --data-dir | Path to directory containing the ImageNet test data |</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;| -p | --model-output-labels | Path to model output labels file.</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;| -v | --validation-labels-path | Path to ImageNet Validation Label file</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;| -l | --data-layout ] | Data layout. Supported value: NHWC, NCHW. Default: NHWC</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;| -c | --compute | Which device to run layers on by default. Possible choices: CpuRef, CpuAcc, GpuAcc. Default: CpuAcc, CpuRef |</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;| -r | --validation-range | The range of the images to be evaluated. Specified in the form &lt;begin index&gt;:&lt;end index&gt;. The index starts at 1 and the range is inclusive. By default the evaluation will be performed on all images. |</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;| -b | --blacklist-path | Path to a blacklist file where each line denotes the index of an image to be excluded from evaluation. |</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;Example usage: &lt;br&gt;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;&lt;code&gt;./ModelAccuracyTool -m /path/to/model/model.armnn -f tflite -i input -o output -d /path/to/test/directory/ -p /path/to/model-output-labels -v /path/to/file/val.txt -c CpuRef -r 1:100&lt;/code&gt;</div></div><!-- fragment --></div><!-- contents -->
88</div><!-- doc-content -->
89<!-- start footer part -->
90<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
91 <ul>
92 <li class="navelem"><a class="el" href="tests_2_model_accuracy_tool-_armnn_2_r_e_a_d_m_e_8md.html">README.md</a></li>
93 <li class="footer">Generated on Fri Mar 13 2020 16:06:55 for ArmNN by
94 <a href="http://www.doxygen.org/index.html">
95 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
96 </ul>
97</div>
98</body>
99</html>