updated doxygen documentation

coincides with 1.0 release

docs/html/annotated_dup.js

@@ -3,8 +3,9 @@ var annotated_dup =
     [ "magmadnn", null, [
       [ "constructor", "md_include_compute__r_e_a_d_m_e.html#autotoc_md0", null ],
       [ "eval", "md_include_compute__r_e_a_d_m_e.html#autotoc_md1", null ],
-      [ "to_string", "md_include_compute__r_e_a_d_m_e.html#autotoc_md2", null ],
-      [ "func", "md_include_compute__r_e_a_d_m_e.html#autotoc_md3", null ],
+      [ "grad", "md_include_compute__r_e_a_d_m_e.html#autotoc_md2", null ],
+      [ "to_string", "md_include_compute__r_e_a_d_m_e.html#autotoc_md3", null ],
+      [ "func", "md_include_compute__r_e_a_d_m_e.html#autotoc_md4", null ],
       [ "dataloader", null, [
         [ "DataLoader", "classmagmadnn_1_1dataloader_1_1_data_loader.html", "classmagmadnn_1_1dataloader_1_1_data_loader" ],
         [ "LinearLoader", "classmagmadnn_1_1dataloader_1_1_linear_loader.html", "classmagmadnn_1_1dataloader_1_1_linear_loader" ]

docs/html/autotoc_md5.html

@@ -5,7 +5,7 @@
 <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>MagmaDNN: Magmadnn</title>
+<title>MagmaDNN: Adding New Layers</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>
@@ -32,7 +32,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">MagmaDNN
-   &#160;<span id="projectnumber">0.1.0</span>
+   &#160;<span id="projectnumber">1.0</span>
    </div>
    <div id="projectbrief">c++NeuralNetworkFramework</div>
   </td>
@@ -91,31 +91,10 @@
 
 <div class="header">
   <div class="headertitle">
-<div class="title">Magmadnn </div>  </div>
+<div class="title">Adding New Layers </div>  </div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><p>A neural network library in c++ aimed at providing a simple, modularized framework for deep learning. This is a Work-In-Progress replacement for <a href="https://bitbucket.org/icl/magmadnn">MagmaDNN</a>.</p>
-<p>===== VERSION 0.1.0 =====</p><ul>
-<li>Currently magmadnn provides a dynamic memory manager, tensor wrapper for the memory manager, and a set of math operations for the tensor.</li>
-<li>As of 0.1.0 it now has support for a full compute graph, gradient computation, forward/backward propagation, and basic NN Layers.</li>
-</ul>
-<p>There are several tutorials in <a href="/docs/tutorials">docs/tutorials</a>. These give an introduction into installing and using the library.</p>
-<p><a class="anchor" id="invalid"></a></p><h5>Dependencies</h5>
-<p>MagmaDNN uses <code>make</code> as its build system, so it must be installed on your system and in your path before you can build the library. The build also requires a c++11 capable compiler.</p>
-<p>If compiling with GPU capabilities, then CUDA and likewise nvcc must be installed and in the proper PATHs. MagmaDNN has only been tested on Ubuntu (&gt;16) and MacOS using CUDA (&gt;9.0), however it is likely to work on most *nix based systems with a recent CUDA install.</p>
-<p>MagmaDNN makes heavy use of BLAS libraries. For CPU only code a C BLAS library must be installed (such as <a href="https://www.openblas.net/">openblas</a>, <a href="http://math-atlas.sourceforge.net/">atlas</a>, intel mkl, etc...). If using the GPU, then <a href="http://icl.cs.utk.edu/magma/">Magma</a> (&gt;=2.5.0) and <a href="https://developer.nvidia.com/cudnn">CuDNN</a> (&gt;=7) must be installed.</p>
-<p><a class="anchor" id="invalid"></a></p><h5>Download</h5>
-<p>First get the repository on your computer with</p>
-<div class="fragment"><div class="line">git clone https://github.com/MagmaDNN/magmadnn</div><div class="line">cd magmadnn</div></div><!-- fragment --><p><a class="anchor" id="invalid"></a></p><h5>Install</h5>
-<p>Next copy the make include settings into the head directory and edit them to your preferences.</p>
-<div class="fragment"><div class="line">cp make.inc-examples/make.inc-standard ./make.inc</div><div class="line">vim make.inc # if you want to edit the settings</div></div><!-- fragment --><p>After this simply run <code>make install</code> to build and install MagmaDNN. If your prefix (install location) has root priviledge access, then you'll need to run with <code>sudo</code>.</p>
-<p>So the entire script looks like:</p>
-<div class="fragment"><div class="line">git clone https://github.com/MagmaDNN/magmadnn</div><div class="line">cd magmadnn</div><div class="line">cp make.inc-examples/make.inc-standard ./make.inc</div><div class="line">sudo make install</div></div><!-- fragment --><p>MagmaDNN comes with some tester files to make sure everything is working properly. You can build them using the same makefile as for installation. Use the following commands to build and run the testers:</p>
-<div class="fragment"><div class="line">make testing</div><div class="line">cd testing</div><div class="line">sh run_tests.sh</div></div><!-- fragment --><p>If you're getting failed testers, then there is something wrong with your installation. See the https://github.com/MagmaDNN/magmadnn/tree/master/docs/troubleshooting.md "troubleshooting section" for more help.</p>
-<p>For examples of what MagmaDNN code looks like see the <a href="https://github.com/MagmaDNN/magmadnn/tree/master/examples">examples/ folder</a>. If MagmaDNN is downloaded and installed, then the examples can be made and run with <code>make examples</code>.</p>
-<p><em>author:</em> Daniel Nichols</p>
-<p><em>co-author:</em> Sedrick Keh </p>
-</div></div><!-- contents -->
+<div class="textblock"></div></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->

docs/html/conv2d_8h.html

@@ -116,30 +116,30 @@
 <div class="dyncontent">
 <div class="center"><img src="conv2d_8h__dep__incl.png" border="0" usemap="#include_2math_2conv2d_8hdep" alt=""/></div>
 <map name="include_2math_2conv2d_8hdep" id="include_2math_2conv2d_8hdep">
-<area shape="rect" id="node2" href="conv2d_8cpp.html" title="src/math/conv2d.cpp" alt="" coords="997,87,1141,114"/>
-<area shape="rect" id="node3" href="conv2dforwardop_8h_source.html" title="include/compute/conv2dforward\l/conv2dforwardop.h" alt="" coords="1165,80,1372,121"/>
-<area shape="rect" id="node4" href="tensor__operations_8h_source.html" title="include/compute/tensor\l_operations.h" alt="" coords="914,169,1071,211"/>
-<area shape="rect" id="node24" href="conv2dlayer_8h.html" title="include/layer/conv2d\l/conv2dlayer.h" alt="" coords="1455,169,1597,211"/>
-<area shape="rect" id="node5" href="activationlayer_8h.html" title="include/layer/activation\l/activationlayer.h" alt="" coords="487,259,642,300"/>
-<area shape="rect" id="node8" href="magmadnn_8h.html" title="include/magmadnn.h" alt="" coords="963,623,1105,650"/>
-<area shape="rect" id="node14" href="dropoutlayer_8h.html" title="include/layer/dropout\l/dropoutlayer.h" alt="" coords="667,259,809,300"/>
-<area shape="rect" id="node16" href="flattenlayer_8h.html" title="include/layer/flatten\l/flattenlayer.h" alt="" coords="833,259,968,300"/>
-<area shape="rect" id="node18" href="fullyconnectedlayer_8h.html" title="include/layer/fullyconnected\l/fullyconnectedlayer.h" alt="" coords="992,259,1175,300"/>
-<area shape="rect" id="node20" href="outputlayer_8h.html" title="include/layer/output\l/outputlayer.h" alt="" coords="1199,259,1333,300"/>
-<area shape="rect" id="node22" href="poolinglayer_8h.html" title="include/layer/pooling\l/poolinglayer.h" alt="" coords="323,259,463,300"/>
-<area shape="rect" id="node6" href="activationlayer_8cpp.html" title="src/layer/activation\l/activationlayer.cpp" alt="" coords="244,348,379,389"/>
-<area shape="rect" id="node7" href="layers_8h.html" title="include/layer/layers.h" alt="" coords="647,355,792,382"/>
-<area shape="rect" id="node9" href="neuralnetwork_8h.html" title="include/model/neuralnetwork\l/neuralnetwork.h" alt="" coords="626,437,813,479"/>
-<area shape="rect" id="node10" href="neuralnetwork_8cpp.html" title="src/model/neuralnetwork\l/neuralnetwork.cpp" alt="" coords="437,527,601,568"/>
-<area shape="rect" id="node11" href="models_8h.html" title="include/model/models.h" alt="" coords="837,534,996,561"/>
-<area shape="rect" id="node12" href="neuralnetwork__utilities_8h.html" title="include/model/neuralnetwork\l/neuralnetwork_utilities.h" alt="" coords="626,527,813,568"/>
-<area shape="rect" id="node13" href="neuralnetwork__utilities_8cpp.html" title="src/model/neuralnetwork\l/neuralnetwork_utilities.cpp" alt="" coords="629,616,809,657"/>
-<area shape="rect" id="node15" href="dropoutlayer_8cpp.html" title="src/layer/dropout/dropoutlayer.cpp" alt="" coords="403,355,622,382"/>
-<area shape="rect" id="node17" href="flattenlayer_8cpp.html" title="src/layer/flatten/flattenlayer.cpp" alt="" coords="817,355,1022,382"/>
-<area shape="rect" id="node19" href="fullyconnectedlayer_8cpp.html" title="src/layer/fullyconnected\l/fullyconnectedlayer.cpp" alt="" coords="1046,348,1209,389"/>
-<area shape="rect" id="node21" href="outputlayer_8cpp.html" title="src/layer/output/outputlayer.cpp" alt="" coords="1233,355,1438,382"/>
-<area shape="rect" id="node23" href="poolinglayer_8cpp.html" title="src/layer/pooling/poolinglayer.cpp" alt="" coords="5,355,220,382"/>
-<area shape="rect" id="node25" href="conv2dlayer_8cpp.html" title="src/layer/conv2d/conv2dlayer.cpp" alt="" coords="1564,266,1781,293"/>
+<area shape="rect" id="node2" href="conv2d_8cpp.html" title="src/math/conv2d.cpp" alt="" coords="617,87,761,114"/>
+<area shape="rect" id="node3" href="conv2dforwardop_8h_source.html" title="include/compute/conv2dforward\l/conv2dforwardop.h" alt="" coords="786,80,993,121"/>
+<area shape="rect" id="node4" href="tensor__operations_8h_source.html" title="include/compute/tensor\l_operations.h" alt="" coords="593,169,751,211"/>
+<area shape="rect" id="node24" href="conv2dlayer_8h.html" title="include/layer/conv2d\l/conv2dlayer.h" alt="" coords="1089,169,1231,211"/>
+<area shape="rect" id="node5" href="activationlayer_8h.html" title="include/layer/activation\l/activationlayer.h" alt="" coords="5,259,160,300"/>
+<area shape="rect" id="node8" href="magmadnn_8h.html" title="include/magmadnn.h" alt="" coords="406,623,549,650"/>
+<area shape="rect" id="node14" href="dropoutlayer_8h.html" title="include/layer/dropout\l/dropoutlayer.h" alt="" coords="346,259,489,300"/>
+<area shape="rect" id="node16" href="flattenlayer_8h.html" title="include/layer/flatten\l/flattenlayer.h" alt="" coords="513,259,647,300"/>
+<area shape="rect" id="node18" href="fullyconnectedlayer_8h.html" title="include/layer/fullyconnected\l/fullyconnectedlayer.h" alt="" coords="671,259,854,300"/>
+<area shape="rect" id="node20" href="outputlayer_8h.html" title="include/layer/output\l/outputlayer.h" alt="" coords="878,259,1013,300"/>
+<area shape="rect" id="node22" href="poolinglayer_8h.html" title="include/layer/pooling\l/poolinglayer.h" alt="" coords="1037,259,1177,300"/>
+<area shape="rect" id="node6" href="activationlayer_8cpp.html" title="src/layer/activation\l/activationlayer.cpp" alt="" coords="15,348,150,389"/>
+<area shape="rect" id="node7" href="layers_8h.html" title="include/layer/layers.h" alt="" coords="707,355,853,382"/>
+<area shape="rect" id="node9" href="neuralnetwork_8h.html" title="include/model/neuralnetwork\l/neuralnetwork.h" alt="" coords="687,437,873,479"/>
+<area shape="rect" id="node10" href="neuralnetwork_8cpp.html" title="src/model/neuralnetwork\l/neuralnetwork.cpp" alt="" coords="698,527,862,568"/>
+<area shape="rect" id="node11" href="models_8h.html" title="include/model/models.h" alt="" coords="515,534,674,561"/>
+<area shape="rect" id="node12" href="neuralnetwork__utilities_8h.html" title="include/model/neuralnetwork\l/neuralnetwork_utilities.h" alt="" coords="887,527,1073,568"/>
+<area shape="rect" id="node13" href="neuralnetwork__utilities_8cpp.html" title="src/model/neuralnetwork\l/neuralnetwork_utilities.cpp" alt="" coords="890,616,1070,657"/>
+<area shape="rect" id="node15" href="dropoutlayer_8cpp.html" title="src/layer/dropout/dropoutlayer.cpp" alt="" coords="235,355,453,382"/>
+<area shape="rect" id="node17" href="flattenlayer_8cpp.html" title="src/layer/flatten/flattenlayer.cpp" alt="" coords="477,355,683,382"/>
+<area shape="rect" id="node19" href="fullyconnectedlayer_8cpp.html" title="src/layer/fullyconnected\l/fullyconnectedlayer.cpp" alt="" coords="877,348,1040,389"/>
+<area shape="rect" id="node21" href="outputlayer_8cpp.html" title="src/layer/output/outputlayer.cpp" alt="" coords="1064,355,1269,382"/>
+<area shape="rect" id="node23" href="poolinglayer_8cpp.html" title="src/layer/pooling/poolinglayer.cpp" alt="" coords="1294,355,1509,382"/>
+<area shape="rect" id="node25" href="conv2dlayer_8cpp.html" title="src/layer/conv2d/conv2dlayer.cpp" alt="" coords="1253,266,1470,293"/>
 </map>
 </div>
 </div>

docs/html/conv2d_8h__dep__incl.map

@@ -1,26 +1,26 @@
 <map id="include/math/conv2d.h" name="include/math/conv2d.h">
-<area shape="rect" id="node2" href="$conv2d_8cpp.html" title="src/math/conv2d.cpp" alt="" coords="997,87,1141,114"/>
-<area shape="rect" id="node3" href="$conv2dforwardop_8h_source.html" title="include/compute/conv2dforward\l/conv2dforwardop.h" alt="" coords="1165,80,1372,121"/>
-<area shape="rect" id="node4" href="$tensor__operations_8h_source.html" title="include/compute/tensor\l_operations.h" alt="" coords="914,169,1071,211"/>
-<area shape="rect" id="node24" href="$conv2dlayer_8h.html" title="include/layer/conv2d\l/conv2dlayer.h" alt="" coords="1455,169,1597,211"/>
-<area shape="rect" id="node5" href="$activationlayer_8h.html" title="include/layer/activation\l/activationlayer.h" alt="" coords="487,259,642,300"/>
-<area shape="rect" id="node8" href="$magmadnn_8h.html" title="include/magmadnn.h" alt="" coords="963,623,1105,650"/>
-<area shape="rect" id="node14" href="$dropoutlayer_8h.html" title="include/layer/dropout\l/dropoutlayer.h" alt="" coords="667,259,809,300"/>
-<area shape="rect" id="node16" href="$flattenlayer_8h.html" title="include/layer/flatten\l/flattenlayer.h" alt="" coords="833,259,968,300"/>
-<area shape="rect" id="node18" href="$fullyconnectedlayer_8h.html" title="include/layer/fullyconnected\l/fullyconnectedlayer.h" alt="" coords="992,259,1175,300"/>
-<area shape="rect" id="node20" href="$outputlayer_8h.html" title="include/layer/output\l/outputlayer.h" alt="" coords="1199,259,1333,300"/>
-<area shape="rect" id="node22" href="$poolinglayer_8h.html" title="include/layer/pooling\l/poolinglayer.h" alt="" coords="323,259,463,300"/>
-<area shape="rect" id="node6" href="$activationlayer_8cpp.html" title="src/layer/activation\l/activationlayer.cpp" alt="" coords="244,348,379,389"/>
-<area shape="rect" id="node7" href="$layers_8h.html" title="include/layer/layers.h" alt="" coords="647,355,792,382"/>
-<area shape="rect" id="node9" href="$neuralnetwork_8h.html" title="include/model/neuralnetwork\l/neuralnetwork.h" alt="" coords="626,437,813,479"/>
-<area shape="rect" id="node10" href="$neuralnetwork_8cpp.html" title="src/model/neuralnetwork\l/neuralnetwork.cpp" alt="" coords="437,527,601,568"/>
-<area shape="rect" id="node11" href="$models_8h.html" title="include/model/models.h" alt="" coords="837,534,996,561"/>
-<area shape="rect" id="node12" href="$neuralnetwork__utilities_8h.html" title="include/model/neuralnetwork\l/neuralnetwork_utilities.h" alt="" coords="626,527,813,568"/>
-<area shape="rect" id="node13" href="$neuralnetwork__utilities_8cpp.html" title="src/model/neuralnetwork\l/neuralnetwork_utilities.cpp" alt="" coords="629,616,809,657"/>
-<area shape="rect" id="node15" href="$dropoutlayer_8cpp.html" title="src/layer/dropout/dropoutlayer.cpp" alt="" coords="403,355,622,382"/>
-<area shape="rect" id="node17" href="$flattenlayer_8cpp.html" title="src/layer/flatten/flattenlayer.cpp" alt="" coords="817,355,1022,382"/>
-<area shape="rect" id="node19" href="$fullyconnectedlayer_8cpp.html" title="src/layer/fullyconnected\l/fullyconnectedlayer.cpp" alt="" coords="1046,348,1209,389"/>
-<area shape="rect" id="node21" href="$outputlayer_8cpp.html" title="src/layer/output/outputlayer.cpp" alt="" coords="1233,355,1438,382"/>
-<area shape="rect" id="node23" href="$poolinglayer_8cpp.html" title="src/layer/pooling/poolinglayer.cpp" alt="" coords="5,355,220,382"/>
-<area shape="rect" id="node25" href="$conv2dlayer_8cpp.html" title="src/layer/conv2d/conv2dlayer.cpp" alt="" coords="1564,266,1781,293"/>
+<area shape="rect" id="node2" href="$conv2d_8cpp.html" title="src/math/conv2d.cpp" alt="" coords="617,87,761,114"/>
+<area shape="rect" id="node3" href="$conv2dforwardop_8h_source.html" title="include/compute/conv2dforward\l/conv2dforwardop.h" alt="" coords="786,80,993,121"/>
+<area shape="rect" id="node4" href="$tensor__operations_8h_source.html" title="include/compute/tensor\l_operations.h" alt="" coords="593,169,751,211"/>
+<area shape="rect" id="node24" href="$conv2dlayer_8h.html" title="include/layer/conv2d\l/conv2dlayer.h" alt="" coords="1089,169,1231,211"/>
+<area shape="rect" id="node5" href="$activationlayer_8h.html" title="include/layer/activation\l/activationlayer.h" alt="" coords="5,259,160,300"/>
+<area shape="rect" id="node8" href="$magmadnn_8h.html" title="include/magmadnn.h" alt="" coords="406,623,549,650"/>
+<area shape="rect" id="node14" href="$dropoutlayer_8h.html" title="include/layer/dropout\l/dropoutlayer.h" alt="" coords="346,259,489,300"/>
+<area shape="rect" id="node16" href="$flattenlayer_8h.html" title="include/layer/flatten\l/flattenlayer.h" alt="" coords="513,259,647,300"/>
+<area shape="rect" id="node18" href="$fullyconnectedlayer_8h.html" title="include/layer/fullyconnected\l/fullyconnectedlayer.h" alt="" coords="671,259,854,300"/>
+<area shape="rect" id="node20" href="$outputlayer_8h.html" title="include/layer/output\l/outputlayer.h" alt="" coords="878,259,1013,300"/>
+<area shape="rect" id="node22" href="$poolinglayer_8h.html" title="include/layer/pooling\l/poolinglayer.h" alt="" coords="1037,259,1177,300"/>
+<area shape="rect" id="node6" href="$activationlayer_8cpp.html" title="src/layer/activation\l/activationlayer.cpp" alt="" coords="15,348,150,389"/>
+<area shape="rect" id="node7" href="$layers_8h.html" title="include/layer/layers.h" alt="" coords="707,355,853,382"/>
+<area shape="rect" id="node9" href="$neuralnetwork_8h.html" title="include/model/neuralnetwork\l/neuralnetwork.h" alt="" coords="687,437,873,479"/>
+<area shape="rect" id="node10" href="$neuralnetwork_8cpp.html" title="src/model/neuralnetwork\l/neuralnetwork.cpp" alt="" coords="698,527,862,568"/>
+<area shape="rect" id="node11" href="$models_8h.html" title="include/model/models.h" alt="" coords="515,534,674,561"/>
+<area shape="rect" id="node12" href="$neuralnetwork__utilities_8h.html" title="include/model/neuralnetwork\l/neuralnetwork_utilities.h" alt="" coords="887,527,1073,568"/>
+<area shape="rect" id="node13" href="$neuralnetwork__utilities_8cpp.html" title="src/model/neuralnetwork\l/neuralnetwork_utilities.cpp" alt="" coords="890,616,1070,657"/>
+<area shape="rect" id="node15" href="$dropoutlayer_8cpp.html" title="src/layer/dropout/dropoutlayer.cpp" alt="" coords="235,355,453,382"/>
+<area shape="rect" id="node17" href="$flattenlayer_8cpp.html" title="src/layer/flatten/flattenlayer.cpp" alt="" coords="477,355,683,382"/>
+<area shape="rect" id="node19" href="$fullyconnectedlayer_8cpp.html" title="src/layer/fullyconnected\l/fullyconnectedlayer.cpp" alt="" coords="877,348,1040,389"/>
+<area shape="rect" id="node21" href="$outputlayer_8cpp.html" title="src/layer/output/outputlayer.cpp" alt="" coords="1064,355,1269,382"/>
+<area shape="rect" id="node23" href="$poolinglayer_8cpp.html" title="src/layer/pooling/poolinglayer.cpp" alt="" coords="1294,355,1509,382"/>
+<area shape="rect" id="node25" href="$conv2dlayer_8cpp.html" title="src/layer/conv2d/conv2dlayer.cpp" alt="" coords="1253,266,1470,293"/>
 </map>

docs/html/conv2d_8h__dep__incl.md5

@@ -1 +1 @@
-b0056266b54b38a103d94be3b543a7aa
+913628a513e173d287abed51bc6dc4fe