IVGCVSW-3726 Upload ArmNN Doxygen files
* Upload current ArmNN Doxygen files
Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com>
Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285
diff --git a/Documentation/src_2dynamic_2_r_e_a_d_m_e_8md_source.html b/Documentation/src_2dynamic_2_r_e_a_d_m_e_8md_source.html
new file mode 100644
index 0000000..2c8db22
--- /dev/null
+++ b/Documentation/src_2dynamic_2_r_e_a_d_m_e_8md_source.html
@@ -0,0 +1,99 @@
+<!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: src/dynamic/README.md 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="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
+  <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('src_2dynamic_2_r_e_a_d_m_e_8md.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="headertitle">
+<div class="title">src/dynamic/README.md</div> </div>
+</div><!--header-->
+<div class="contents">
+<a href="src_2dynamic_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> # Standalone dynamic backend developer guide</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> Arm NN allows adding new dynamic backends. Dynamic Backends can be compiled as standalone against Arm NN</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> and can be loaded by Arm NN dynamically at runtime.</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> To be properly loaded and used, the backend instances must comply to the standard interface for dynamic backends </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> and to the versioning rules that enforce ABI compatibility.</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> The details of how to add dynamic backends can be found in [src/backends/README.md](../backends/README.md).</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> ## Standalone dynamic backend example</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> The source code includes an example that is used to generate a simple dynamic backend and is provided at</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> [SampleDynamicBackend.hpp](./sample/SampleDynamicBackend.hpp)</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> [SampleDynamicBackend.cpp](./sample/SampleDynamicBackend.cpp)</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> The details of how to create backends can be found in [src/backends/README.md](../backends/README.md).</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> The makefile used for building the standalone reference dynamic backend is also provided:</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> [CMakeLists.txt](./sample/CMakeLists.txt)</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> ### Standalone dynamic backend build</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> The easiest way to build a standalone sample dynamic backend is to build using environment configured compiler</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> and specify the Arm NN path and Boost path to the CMake command:</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> ```shell</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> cd ${DYNAMIC_BACKEND_DIR}</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> mkdir build</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> cd build</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> cmake -DBOOST_ROOT=${BOOST_PATH} \</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  -DBoost_SYSTEM_LIBRARY=${BOOST_PATH}/lib/libboost_system.a \</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  -DBoost_FILESYSTEM_LIBRARY=${BOOST_PATH}/lib/libboost_filesystem.a \</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  -DARMNN_PATH=${ARMNN_PATH}/libarmnn.so ..</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> ```</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> Then run the build</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> ```shell</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> make</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="l00044"></a><span class="lineno"> 44</span> The library will be created in ${DYNAMIC_BACKEND_DIR}/build.</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> ## Dynamic backend loading paths</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> During the creation of the Runtime, Arm NN will scan a given set of paths searching for suitable dynamic backend objects to load.</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> A list of (absolute) paths can be specified at compile-time by setting a define named ```DYNAMIC_BACKEND_PATHS```</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  in the form of a colon-separated list of strings.</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> ```shell</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> -DDYNAMIC_BACKEND_PATHS="PATH_1:PATH_2...:PATH_N"</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> ```</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> Example for setting the path to the sample standalone dynamic backend built from the previous step:</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> ```shell</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> -DDYNAMIC_BACKEND_PATHS=${DYNAMIC_BACKEND_DIR}/build</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> ```</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> The paths will be processed in the same order as they are indicated in the macro.</div></div><!-- fragment --></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="src_2dynamic_2_r_e_a_d_m_e_8md.html">README.md</a></li>
+ <li class="footer">Generated on Fri Mar 13 2020 16:06:55 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>