Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 7ddbbae7ad3e0000d8e6a76458cac68254dc8048 / . / Documentation / md_tests__model_accuracy_tool-_armnn__r_e_a_d_m_e.html
blob: d09394d6f4c7269ae93f72551b3eef0822c6b315 [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: The ModelAccuracyTool-Armnn</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('md_tests__model_accuracy_tool-_armnn__r_e_a_d_m_e.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">The ModelAccuracyTool-Armnn </div> </div>
85</div><!--header-->
86<div class="contents">
87<div class="textblock"><p>The <code>ModelAccuracyTool-Armnn</code> is a program for measuring the Top 5 accuracy results of a model against an image dataset.</p>
88<p>Prerequisites:</p><ol type="1">
89<li>The model is in .armnn format model file. The <code>ArmnnConverter</code> can be used to convert a model to this format.</li>
90</ol>
91<p>Build option: To build ModelAccuracyTool, pass the following options to Cmake:</p><ul>
92<li>-DFLATC_DIR=/path/to/flatbuffers/x86build/</li>
93<li>-DBUILD_ACCURACY_TOOL=1</li>
94<li>-DBUILD_ARMNN_SERIALIZER=1</li>
95</ul>
96<table class="doxtable">
97<tr>
98<th>Cmd:</th><th></th><th></th></tr>
99<tr>
100<td>-h </td><td>&ndash;help </td><td>Display help messages </td></tr>
101<tr>
102<td>-m </td><td>&ndash;model-path </td><td>Path to armnn format model file </td></tr>
103<tr>
104<td>-f </td><td>&ndash;model-format </td><td>The model format. Supported values: caffe, tensorflow, tflite </td></tr>
105<tr>
106<td>-i </td><td>&ndash;input-name </td><td>Identifier of the input tensors in the network separated by comma </td></tr>
107<tr>
108<td>-o </td><td>&ndash;output-name </td><td>Identifier of the output tensors in the network separated by comma </td></tr>
109<tr>
110<td>-d </td><td>&ndash;data-dir </td><td>Path to directory containing the ImageNet test data </td></tr>
111<tr>
112<td>-p </td><td>&ndash;model-output-labels </td><td>Path to model output labels file. </td></tr>
113<tr>
114<td>-v </td><td>&ndash;validation-labels-path </td><td>Path to ImageNet Validation <a class="el" href="struct_label.html">Label</a> file </td></tr>
115<tr>
116<td>-l </td><td>&ndash;data-layout ] </td><td>Data layout. Supported value: NHWC, NCHW. Default: NHWC </td></tr>
117<tr>
118<td>-c </td><td>&ndash;compute </td><td>Which device to run layers on by default. Possible choices: CpuRef, CpuAcc, GpuAcc. Default: CpuAcc, CpuRef </td></tr>
119<tr>
120<td>-r </td><td>&ndash;validation-range </td><td>The range of the images to be evaluated. Specified in the form &lt;begin index&gt;=""&gt;:&lt;end index&gt;=""&gt;. The index starts at 1 and the range is inclusive. By default the evaluation will be performed on all images. </td></tr>
121<tr>
122<td>-b </td><td>&ndash;blacklist-path </td><td>Path to a blacklist file where each line denotes the index of an image to be excluded from evaluation. </td></tr>
123</table>
124<p>Example usage: <br />
125 <code>./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</code> </p>
126</div></div><!-- contents -->
127</div><!-- doc-content -->
128<!-- start footer part -->
129<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
130 <ul>
131 <li class="footer">Generated on Fri Mar 13 2020 16:07:01 for ArmNN by
132 <a href="http://www.doxygen.org/index.html">
133 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
134 </ul>
135</div>
136</body>
137</html>