Modified: incubator/singa/site/trunk/en/docs/image_tool.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/image_tool.html?rev=1862313&r1=1862312&r2=1862313&view=diff ============================================================================== --- incubator/singa/site/trunk/en/docs/image_tool.html (original) +++ incubator/singa/site/trunk/en/docs/image_tool.html Sat Jun 29 14:42:24 2019 @@ -18,21 +18,15 @@ - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> + + - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - + - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -50,16 +44,21 @@ } </style> + + + <script src="../_static/js/modernizr.min.js"></script> + </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > + <div class="wy-side-nav-search"> @@ -104,7 +103,6 @@ <li class="toctree-l1 current"><a class="reference internal" href="index.html">Documentation</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l2"><a class="reference internal" href="software_stack.html">Software Stack</a></li> -<li class="toctree-l2"><a class="reference internal" href="benchmark.html">Benchmark for Distributed training</a></li> <li class="toctree-l2"><a class="reference internal" href="device.html">Device</a></li> <li class="toctree-l2"><a class="reference internal" href="tensor.html">Tensor</a></li> <li class="toctree-l2"><a class="reference internal" href="layer.html">Layer</a></li> @@ -231,14 +229,18 @@ phases.</p> <dt id="singa.image_tool.ImageTool.color_cast"> <code class="descname">color_cast</code><span class="sig-paren">(</span><em>offset=20</em>, <em>inplace=True</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.image_tool.ImageTool.color_cast" title="Permalink to this definition">¶</a></dt> <dd><p>Add a random value from [-offset, offset] to each channel</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters</dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>offset</strong> â cast offset, >0 and <255</p></li> -<li><p><strong>inplace</strong> â inplace imgs or not ( return new_imgs)</p></li> -</ul> -</dd> -</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>offset</strong> â cast offset, >0 and <255</li> +<li><strong>inplace</strong> â inplace imgs or not ( return new_imgs)</li> +</ul> +</td> +</tr> +</tbody> +</table> </dd></dl> <dl class="method"> @@ -248,15 +250,19 @@ phases.</p> scale it into given size.</p> <p>According to img size, crop position could be either (left, center, right) or (top, middle, bottom).</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters</dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>patch</strong> (<em>tuple</em>) â the width and height the output image</p></li> -<li><p><strong>num_case</strong> â num of cases, must be in [1,3]</p></li> -<li><p><strong>inplace</strong> â inplace imgs or not ( return new_imgs)</p></li> -</ul> -</dd> -</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>patch</strong> (<em>tuple</em>) â the width and height the output image</li> +<li><strong>num_case</strong> â num of cases, must be in [1,3]</li> +<li><strong>inplace</strong> â inplace imgs or not ( return new_imgs)</li> +</ul> +</td> +</tr> +</tbody> +</table> </dd></dl> <dl class="method"> @@ -264,15 +270,19 @@ scale it into given size.</p> <code class="descname">crop5</code><span class="sig-paren">(</span><em>patch</em>, <em>num_case=1</em>, <em>inplace=True</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.image_tool.ImageTool.crop5" title="Permalink to this definition">¶</a></dt> <dd><p>Crop at positions from [left_top, left_bottom, right_top, right_bottom, and center].</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters</dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>patch</strong> (<em>tuple</em>) â width and height of the result image.</p></li> -<li><p><strong>num_case</strong> â num of cases, must be in [1,5]</p></li> -<li><p><strong>inplace</strong> â inplace imgs or not ( return new_imgs)</p></li> -</ul> -</dd> -</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>patch</strong> (<em>tuple</em>) â width and height of the result image.</li> +<li><strong>num_case</strong> â num of cases, must be in [1,5]</li> +<li><strong>inplace</strong> â inplace imgs or not ( return new_imgs)</li> +</ul> +</td> +</tr> +</tbody> +</table> </dd></dl> <dl class="method"> @@ -286,29 +296,37 @@ right_bottom, and center].</p> <dt id="singa.image_tool.ImageTool.enhance"> <code class="descname">enhance</code><span class="sig-paren">(</span><em>scale=0.2</em>, <em>inplace=True</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.image_tool.ImageTool.enhance" title="Permalink to this definition">¶</a></dt> <dd><p>Apply random enhancement for Color,Contrast,Brightness,Sharpness.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters</dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>scale</strong> (<em>float</em>) â enhancement degree is from [1-scale, 1+scale]</p></li> -<li><p><strong>inplace</strong> â inplace imgs or not ( return new_imgs)</p></li> -</ul> -</dd> -</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>scale</strong> (<em>float</em>) â enhancement degree is from [1-scale, 1+scale]</li> +<li><strong>inplace</strong> â inplace imgs or not ( return new_imgs)</li> +</ul> +</td> +</tr> +</tbody> +</table> </dd></dl> <dl class="method"> <dt id="singa.image_tool.ImageTool.flip"> <code class="descname">flip</code><span class="sig-paren">(</span><em>num_case=1</em>, <em>inplace=True</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.image_tool.ImageTool.flip" title="Permalink to this definition">¶</a></dt> <dd><p>Randomly flip a img left to right.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters</dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>num_case</strong> â num of cases, must be in {1,2}; if 2, then add the orignal -and flipped img</p></li> -<li><p><strong>inplace</strong> â inplace imgs or not (return new_imgs)</p></li> -</ul> -</dd> -</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>num_case</strong> â num of cases, must be in {1,2}; if 2, then add the orignal +and flipped img</li> +<li><strong>inplace</strong> â inplace imgs or not (return new_imgs)</li> +</ul> +</td> +</tr> +</tbody> +</table> </dd></dl> <dl class="method"> @@ -317,13 +335,15 @@ and flipped img</p></li> <dd><p>Randomly flip a img top to bottom. :param num_case: num of cases, must be in {1,2}; if 2, then add the orignal</p> <blockquote> -<div><p>and flip_down img</p> -</div></blockquote> -<dl class="field-list simple"> -<dt class="field-odd">Parameters</dt> -<dd class="field-odd"><p><strong>inplace</strong> â inplace imgs or not (return new_imgs)</p> -</dd> -</dl> +<div>and flip_down img</div></blockquote> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>inplace</strong> â inplace imgs or not (return new_imgs)</td> +</tr> +</tbody> +</table> </dd></dl> <dl class="method"> @@ -336,86 +356,110 @@ and flipped img</p></li> <dt id="singa.image_tool.ImageTool.random_crop"> <code class="descname">random_crop</code><span class="sig-paren">(</span><em>patch</em>, <em>inplace=True</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.image_tool.ImageTool.random_crop" title="Permalink to this definition">¶</a></dt> <dd><p>Crop the image at random offset to get a patch of the given size.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters</dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>patch</strong> (<em>tuple</em>) â width and height of the patch</p></li> -<li><p><strong>inplace</strong> (<em>Boolean</em>) â replace the internal images list with the patches -if True; otherwise, return the patches.</p></li> -</ul> -</dd> -</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>patch</strong> (<em>tuple</em>) â width and height of the patch</li> +<li><strong>inplace</strong> (<em>Boolean</em>) â replace the internal images list with the patches +if True; otherwise, return the patches.</li> +</ul> +</td> +</tr> +</tbody> +</table> </dd></dl> <dl class="method"> <dt id="singa.image_tool.ImageTool.random_crop_resize"> <code class="descname">random_crop_resize</code><span class="sig-paren">(</span><em>patch</em>, <em>inplace=True</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.image_tool.ImageTool.random_crop_resize" title="Permalink to this definition">¶</a></dt> -<dd><dl class="simple"> -<dt>Crop of the image at a random size between 0.08 to 1 of input image</dt><dd><p>and random aspect ratio between 3/4 to 4/3. -This crop is then resized to the given patch size.</p> -</dd> -</dl> -<dl class="field-list simple"> -<dt class="field-odd">Parameters</dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>patch</strong> (<em>tuple</em>) â width and height of the patch</p></li> -<li><p><strong>inplace</strong> (<em>Boolean</em>) â replace the internal images list with the patches -if True; otherwise, return the patches.</p></li> -</ul> -</dd> -</dl> +<dd><dl class="docutils"> +<dt>Crop of the image at a random size between 0.08 to 1 of input image</dt> +<dd>and random aspect ratio between 3/4 to 4/3. +This crop is then resized to the given patch size.</dd> +</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>patch</strong> (<em>tuple</em>) â width and height of the patch</li> +<li><strong>inplace</strong> (<em>Boolean</em>) â replace the internal images list with the patches +if True; otherwise, return the patches.</li> +</ul> +</td> +</tr> +</tbody> +</table> </dd></dl> <dl class="method"> <dt id="singa.image_tool.ImageTool.resize_by_list"> <code class="descname">resize_by_list</code><span class="sig-paren">(</span><em>size_list</em>, <em>num_case=1</em>, <em>inplace=True</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.image_tool.ImageTool.resize_by_list" title="Permalink to this definition">¶</a></dt> -<dd><dl class="field-list simple"> -<dt class="field-odd">Parameters</dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>num_case</strong> â num of resize cases, must be <= the length of size_list</p></li> -<li><p><strong>inplace</strong> â inplace imgs or not ( return new_imgs)</p></li> -</ul> -</dd> -</dl> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>num_case</strong> â num of resize cases, must be <= the length of size_list</li> +<li><strong>inplace</strong> â inplace imgs or not ( return new_imgs)</li> +</ul> +</td> +</tr> +</tbody> +</table> </dd></dl> <dl class="method"> <dt id="singa.image_tool.ImageTool.resize_by_range"> <code class="descname">resize_by_range</code><span class="sig-paren">(</span><em>rng</em>, <em>inplace=True</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.image_tool.ImageTool.resize_by_range" title="Permalink to this definition">¶</a></dt> -<dd><dl class="field-list simple"> -<dt class="field-odd">Parameters</dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>rng</strong> â a tuple (begin,end), include begin, exclude end</p></li> -<li><p><strong>inplace</strong> â inplace imgs or not ( return new_imgs)</p></li> -</ul> -</dd> -</dl> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>rng</strong> â a tuple (begin,end), include begin, exclude end</li> +<li><strong>inplace</strong> â inplace imgs or not ( return new_imgs)</li> +</ul> +</td> +</tr> +</tbody> +</table> </dd></dl> <dl class="method"> <dt id="singa.image_tool.ImageTool.rotate_by_list"> <code class="descname">rotate_by_list</code><span class="sig-paren">(</span><em>angle_list</em>, <em>num_case=1</em>, <em>inplace=True</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.image_tool.ImageTool.rotate_by_list" title="Permalink to this definition">¶</a></dt> -<dd><dl class="field-list simple"> -<dt class="field-odd">Parameters</dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>num_case</strong> â num of rotate cases, must be <= the length of angle_list</p></li> -<li><p><strong>inplace</strong> â inplace imgs or not ( return new_imgs)</p></li> -</ul> -</dd> -</dl> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>num_case</strong> â num of rotate cases, must be <= the length of angle_list</li> +<li><strong>inplace</strong> â inplace imgs or not ( return new_imgs)</li> +</ul> +</td> +</tr> +</tbody> +</table> </dd></dl> <dl class="method"> <dt id="singa.image_tool.ImageTool.rotate_by_range"> <code class="descname">rotate_by_range</code><span class="sig-paren">(</span><em>rng</em>, <em>inplace=True</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.image_tool.ImageTool.rotate_by_range" title="Permalink to this definition">¶</a></dt> -<dd><dl class="field-list simple"> -<dt class="field-odd">Parameters</dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>rng</strong> â a tuple (begin,end) in degree, include begin, exclude end</p></li> -<li><p><strong>inplace</strong> â inplace imgs or not ( return new_imgs)</p></li> -</ul> -</dd> -</dl> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>rng</strong> â a tuple (begin,end) in degree, include begin, exclude end</li> +<li><strong>inplace</strong> â inplace imgs or not ( return new_imgs)</li> +</ul> +</td> +</tr> +</tbody> +</table> </dd></dl> </dd></dl> @@ -430,15 +474,19 @@ if True; otherwise, return the patches.< <dt id="singa.image_tool.crop"> <code class="descclassname">singa.image_tool.</code><code class="descname">crop</code><span class="sig-paren">(</span><em>img</em>, <em>patch</em>, <em>position</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.image_tool.crop" title="Permalink to this definition">¶</a></dt> <dd><p>Crop the input image into given size at given position.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters</dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>patch</strong> (<em>tuple</em>) â width and height of the patch</p></li> -<li><p><strong>position</strong> (<em>list</em><em>(</em><em>str</em><em>)</em>) â left_top, left_bottom, right_top, right_bottom</p></li> -<li><p><strong>center.</strong> (<em>and</em>) â </p></li> -</ul> -</dd> -</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>patch</strong> (<em>tuple</em>) â width and height of the patch</li> +<li><strong>position</strong> (<em>list</em><em>(</em><em>str</em><em>)</em>) â left_top, left_bottom, right_top, right_bottom</li> +<li><strong>center.</strong> (<em>and</em>) â </li> +</ul> +</td> +</tr> +</tbody> +</table> </dd></dl> <dl class="function"> @@ -446,25 +494,32 @@ if True; otherwise, return the patches.< <code class="descclassname">singa.image_tool.</code><code class="descname">crop_and_resize</code><span class="sig-paren">(</span><em>img</em>, <em>patch</em>, <em>position</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.image_tool.crop_and_resize" title="Permalink to this definition">¶</a></dt> <dd><p>Crop a max square patch of the input image at given position and resize it into given size.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters</dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>patch</strong> (<em>tuple</em>) â width, height</p></li> -<li><p><strong>position</strong> (<em>list</em><em>(</em><em>str</em><em>)</em>) â left, center, right, top, middle, bottom.</p></li> -</ul> -</dd> -</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>patch</strong> (<em>tuple</em>) â width, height</li> +<li><strong>position</strong> (<em>list</em><em>(</em><em>str</em><em>)</em>) â left, center, right, top, middle, bottom.</li> +</ul> +</td> +</tr> +</tbody> +</table> </dd></dl> <dl class="function"> <dt id="singa.image_tool.enhance"> <code class="descclassname">singa.image_tool.</code><code class="descname">enhance</code><span class="sig-paren">(</span><em>img</em>, <em>scale</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.image_tool.enhance" title="Permalink to this definition">¶</a></dt> <dd><p>Apply random enhancement for Color,Contrast,Brightness,Sharpness.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters</dt> -<dd class="field-odd"><p><strong>scale</strong> (<em>float</em>) â enhancement degree is from [1-scale, 1+scale]</p> -</dd> -</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>scale</strong> (<em>float</em>) â enhancement degree is from [1-scale, 1+scale]</td> +</tr> +</tbody> +</table> </dd></dl> <dl class="function"> @@ -492,7 +547,7 @@ it into given size.</p> <a href="snapshot.html" class="btn btn-neutral float-right" title="Snapshot" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="data.html" class="btn btn-neutral float-left" title="Data" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="data.html" class="btn btn-neutral" title="Data" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -501,7 +556,7 @@ it into given size.</p> <div role="contentinfo"> <p> - © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners. + © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.. </p> </div> @@ -518,17 +573,36 @@ it into given size.</p> + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'1.1.0', + LANGUAGE:'None', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> - - - - - <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> <span class="rst-current-version" data-toggle="rst-current-version"> <span class="fa fa-book"> incubator-singa </span>
Modified: incubator/singa/site/trunk/en/docs/index.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/index.html?rev=1862313&r1=1862312&r2=1862313&view=diff ============================================================================== --- incubator/singa/site/trunk/en/docs/index.html (original) +++ incubator/singa/site/trunk/en/docs/index.html Sat Jun 29 14:42:24 2019 @@ -18,21 +18,15 @@ - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> + + - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - + - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -50,16 +44,21 @@ } </style> + + + <script src="../_static/js/modernizr.min.js"></script> + </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > + <div class="wy-side-nav-search"> @@ -104,7 +103,6 @@ <li class="toctree-l1 current"><a class="current reference internal" href="#">Documentation</a><ul> <li class="toctree-l2"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l2"><a class="reference internal" href="software_stack.html">Software Stack</a></li> -<li class="toctree-l2"><a class="reference internal" href="benchmark.html">Benchmark for Distributed training</a></li> <li class="toctree-l2"><a class="reference internal" href="device.html">Device</a></li> <li class="toctree-l2"><a class="reference internal" href="tensor.html">Tensor</a></li> <li class="toctree-l2"><a class="reference internal" href="layer.html">Layer</a></li> @@ -232,7 +230,6 @@ <li class="toctree-l2"><a class="reference internal" href="software_stack.html#io">IO</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="benchmark.html">Benchmark for Distributed training</a></li> <li class="toctree-l1"><a class="reference internal" href="device.html">Device</a><ul> <li class="toctree-l2"><a class="reference internal" href="device.html#specific-devices">Specific devices</a></li> <li class="toctree-l2"><a class="reference internal" href="device.html#module-singa.device">Python API</a></li> @@ -276,7 +273,7 @@ <li class="toctree-l3"><a class="reference internal" href="autograd.html#operation-layer">Operation + Layer</a><ul> <li class="toctree-l4"><a class="reference internal" href="autograd.html#create-the-layers">Create the layers</a></li> <li class="toctree-l4"><a class="reference internal" href="autograd.html#define-the-forward-function">Define the forward function</a></li> -<li class="toctree-l4"><a class="reference internal" href="autograd.html#id1">Training</a></li> +<li class="toctree-l4"><a class="reference internal" href="autograd.html#training">Training</a></li> </ul> </li> </ul> @@ -303,10 +300,6 @@ <li class="toctree-l3"><a class="reference internal" href="model_zoo/char-rnn/README.html#instructions">Instructions</a></li> </ul> </li> -<li class="toctree-l2"><a class="reference internal" href="model_zoo/mnist/README.html">Train a RBM model against MNIST dataset</a><ul> -<li class="toctree-l3"><a class="reference internal" href="model_zoo/mnist/README.html#running-instructions">Running instructions</a></li> -</ul> -</li> <li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/alexnet/README.html">Train AlexNet over ImageNet</a><ul> <li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/alexnet/README.html#instructions">Instructions</a><ul> <li class="toctree-l4"><a class="reference internal" href="model_zoo/imagenet/alexnet/README.html#compile-singa">Compile SINGA</a></li> @@ -317,31 +310,11 @@ </li> </ul> </li> -<li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/densenet/README.html">Image Classification using DenseNet</a><ul> -<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/densenet/README.html#instructions">Instructions</a></li> -<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/densenet/README.html#details">Details</a></li> -</ul> -</li> <li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/googlenet/README.html">Image Classification using GoogleNet</a><ul> <li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/googlenet/README.html#instructions">Instructions</a></li> <li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/googlenet/README.html#details">Details</a></li> </ul> </li> -<li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/inception/README.html">Image Classification using Inception V4</a><ul> -<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/inception/README.html#instructions">Instructions</a></li> -<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/inception/README.html#details">Details</a></li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/resnet/README.html">Image Classification using Residual Networks</a><ul> -<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/resnet/README.html#instructions">Instructions</a></li> -<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/resnet/README.html#details">Details</a></li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/vgg/README.html">Image Classification using VGG</a><ul> -<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/vgg/README.html#instructions">Instructions</a></li> -<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/vgg/README.html#details">Details</a></li> -</ul> -</li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li> @@ -360,7 +333,7 @@ <a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="../index.html" class="btn btn-neutral float-left" title="Welcome to Apache SINGA" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="../index.html" class="btn btn-neutral" title="Welcome to Apache SINGA" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -369,7 +342,7 @@ <div role="contentinfo"> <p> - © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners. + © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.. </p> </div> @@ -386,17 +359,36 @@ + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'1.1.0', + LANGUAGE:'None', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> - - - - - <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> <span class="rst-current-version" data-toggle="rst-current-version"> <span class="fa fa-book"> incubator-singa </span> Modified: incubator/singa/site/trunk/en/docs/initializer.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/initializer.html?rev=1862313&r1=1862312&r2=1862313&view=diff ============================================================================== --- incubator/singa/site/trunk/en/docs/initializer.html (original) +++ incubator/singa/site/trunk/en/docs/initializer.html Sat Jun 29 14:42:24 2019 @@ -18,21 +18,15 @@ - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> + + - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - + - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -50,16 +44,21 @@ } </style> + + + <script src="../_static/js/modernizr.min.js"></script> + </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > + <div class="wy-side-nav-search"> @@ -104,7 +103,6 @@ <li class="toctree-l1 current"><a class="reference internal" href="index.html">Documentation</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l2"><a class="reference internal" href="software_stack.html">Software Stack</a></li> -<li class="toctree-l2"><a class="reference internal" href="benchmark.html">Benchmark for Distributed training</a></li> <li class="toctree-l2"><a class="reference internal" href="device.html">Device</a></li> <li class="toctree-l2"><a class="reference internal" href="tensor.html">Tensor</a></li> <li class="toctree-l2"><a class="reference internal" href="layer.html">Layer</a></li> @@ -227,18 +225,22 @@ <code class="descclassname">singa.initializer.</code><code class="descname">uniform</code><span class="sig-paren">(</span><em>t</em>, <em>fan_in=0</em>, <em>fan_out=0</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.initializer.uniform" title="Permalink to this definition">¶</a></dt> <dd><p>Initialize the values of the input tensor following a uniform distribution with specific bounds.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters</dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>fan_in</strong> (<em>int</em>) â for the weight Tensor of a convolution layer, +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>fan_in</strong> (<em>int</em>) â for the weight Tensor of a convolution layer, fan_in = nb_channel * kh * kw; for dense layer, -fan_in = input_feature_length</p></li> -<li><p><strong>fan_out</strong> (<em>int</em>) â for the convolution layer weight Tensor, +fan_in = input_feature_length</li> +<li><strong>fan_out</strong> (<em>int</em>) â for the convolution layer weight Tensor, fan_out = nb_filter * kh * kw; for the weight Tensor of a dense -layer, fan_out = output_feature_length</p></li> +layer, fan_out = output_feature_length</li> </ul> -</dd> -</dl> +</td> +</tr> +</tbody> +</table> <p>Ref: [Bengio and Glorot 2010]: Understanding the difficulty of training deep feedforward neuralnetworks.</p> </dd></dl> @@ -248,18 +250,22 @@ training deep feedforward neuralnetworks <code class="descclassname">singa.initializer.</code><code class="descname">gaussian</code><span class="sig-paren">(</span><em>t</em>, <em>fan_in=0</em>, <em>fan_out=0</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.initializer.gaussian" title="Permalink to this definition">¶</a></dt> <dd><p>Initialize the values of the input tensor following a Gaussian distribution with specific std.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters</dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>fan_in</strong> (<em>int</em>) â for the weight Tensor of a convolution layer, +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>fan_in</strong> (<em>int</em>) â for the weight Tensor of a convolution layer, fan_in = nb_channel * kh * kw; for dense layer, -fan_in = input_feature_length</p></li> -<li><p><strong>fan_out</strong> (<em>int</em>) â for the convolution layer weight Tensor, +fan_in = input_feature_length</li> +<li><strong>fan_out</strong> (<em>int</em>) â for the convolution layer weight Tensor, fan_out = nb_filter * kh * kw; for the weight Tensor of a dense -layer, fan_out = output_feature_length</p></li> +layer, fan_out = output_feature_length</li> </ul> -</dd> -</dl> +</td> +</tr> +</tbody> +</table> <p>Ref Kaiming He, Xiangyu Zhang, Shaoqing Ren, Jian Sun: Delving Deep into Rectifiers: Surpassing Human-Level Performance on ImageNet Classification</p> </dd></dl> @@ -281,7 +287,7 @@ Rectifiers: Surpassing Human-Level Perfo <a href="loss.html" class="btn btn-neutral float-right" title="Loss" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="net.html" class="btn btn-neutral float-left" title="FeedForward Net" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="net.html" class="btn btn-neutral" title="FeedForward Net" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -290,7 +296,7 @@ Rectifiers: Surpassing Human-Level Perfo <div role="contentinfo"> <p> - © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners. + © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.. </p> </div> @@ -307,17 +313,36 @@ Rectifiers: Surpassing Human-Level Perfo + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'1.1.0', + LANGUAGE:'None', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> - - - - - <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> <span class="rst-current-version" data-toggle="rst-current-version"> <span class="fa fa-book"> incubator-singa </span> Modified: incubator/singa/site/trunk/en/docs/install_macos1013.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/install_macos1013.html?rev=1862313&r1=1862312&r2=1862313&view=diff ============================================================================== --- incubator/singa/site/trunk/en/docs/install_macos1013.html (original) +++ incubator/singa/site/trunk/en/docs/install_macos1013.html Sat Jun 29 14:42:24 2019 @@ -18,21 +18,15 @@ - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> + + - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - + - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -48,16 +42,21 @@ } </style> + + + <script src="../_static/js/modernizr.min.js"></script> + </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > + <div class="wy-side-nav-search"> @@ -184,14 +183,14 @@ <div class="section" id="requirements"> <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2> <ul class="simple"> -<li><p>homebrew is used to install the requirements. Try:</p></li> +<li>homebrew is used to install the requirements. Try:</li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>brew update </pre></div> </div> <p>If you donât have homebrew in your system or if you upgraded from a previous operating system, you may see an error message. See FAQ below.</p> <ul class="simple"> -<li><p>installing required software for building SINGA:</p></li> +<li>installing required software for building SINGA:</li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>brew tap homebrew/science brew tap homebrew/python @@ -214,7 +213,7 @@ brew install wget </pre></div> </div> <ul class="simple"> -<li><p>preparing compiler</p></li> +<li>preparing compiler</li> </ul> <p>To let the compiler (and cmake) know the openblas path,</p> @@ -231,7 +230,7 @@ path,</p> </pre></div> </div> <ul class="simple"> -<li><p>Get the source code and build it:</p></li> +<li>Get the source code and build it:</li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git clone https://github.com/apache/incubator-singa.git @@ -244,14 +243,14 @@ make </pre></div> </div> <ul class="simple"> -<li><p>Optional: create virtual enviromnet:</p></li> +<li>Optional: create virtual enviromnet:</li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>virtualenv ~/venv <span class="nb">source</span> ~/venv/bin/activate </pre></div> </div> <ul class="simple"> -<li><p>Install the python module</p></li> +<li>Install the python module</li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> python pip install . @@ -263,7 +262,7 @@ pip install . </div> <p>then SINGA is installed successfully.</p> <ul class="simple"> -<li><p>Run Jupyter notebook</p></li> +<li>Run Jupyter notebook</li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install matplotlib @@ -275,12 +274,12 @@ jupyter notebook <div class="section" id="video-tutorial"> <h2>Video Tutorial<a class="headerlink" href="#video-tutorial" title="Permalink to this headline">¶</a></h2> <p>See these steps in the following video:</p> -<table class="docutils align-center"> +<table border="1" class="docutils"> <colgroup> -<col style="width: 100%" /> +<col width="100%" /> </colgroup> -<tbody> -<tr class="row-odd"><td><p><a class="reference external" href="https://www.youtube.com/watch?v=T8xGTH9vCBs";><img alt="video" class="align-middle" src="https://img.youtube.com/vi/T8xGTH9vCBs/0.jpg"; /></a></p></td> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference external" href="https://www.youtube.com/watch?v=T8xGTH9vCBs";><img alt="video" class="align-middle" src="https://img.youtube.com/vi/T8xGTH9vCBs/0.jpg"; /></a></td> </tr> </tbody> </table> @@ -288,13 +287,13 @@ jupyter notebook <div class="section" id="faq"> <h2>FAQ<a class="headerlink" href="#faq" title="Permalink to this headline">¶</a></h2> <ul class="simple"> -<li><p>How to install or update homebrew:</p></li> +<li>How to install or update homebrew:</li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>/usr/bin/ruby -e <span class="s2">"</span><span class="k">$(</span>curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install<span class="k">)</span><span class="s2">"</span> </pre></div> </div> <ul class="simple"> -<li><p>There is an error with protobuf.</p></li> +<li>There is an error with protobuf.</li> </ul> <p>Try overwriting the links:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>brew link --overwrite protobuf @@ -314,7 +313,7 @@ jupyter notebook <div role="contentinfo"> <p> - © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners. + © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.. </p> </div> @@ -331,17 +330,36 @@ jupyter notebook + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'1.1.0', + LANGUAGE:'None', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> - - - - - <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> <span class="rst-current-version" data-toggle="rst-current-version"> <span class="fa fa-book"> incubator-singa </span> Modified: incubator/singa/site/trunk/en/docs/install_win.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/install_win.html?rev=1862313&r1=1862312&r2=1862313&view=diff ============================================================================== --- incubator/singa/site/trunk/en/docs/install_win.html (original) +++ incubator/singa/site/trunk/en/docs/install_win.html Sat Jun 29 14:42:24 2019 @@ -18,21 +18,15 @@ - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> + + - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - + - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -48,16 +42,21 @@ } </style> + + + <script src="../_static/js/modernizr.min.js"></script> + </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > + <div class="wy-side-nav-search"> @@ -187,65 +186,71 @@ <p>You may create a folder for building the dependencies.</p> <p>The dependencies are:</p> <ul> -<li><dl class="simple"> -<dt>Compiler and IDE</dt><dd><ul class="simple"> -<li><p>Visual Studio. The community edition is free and can be used to build SINGA. <a class="reference external" href="https://www.visualstudio.com/";>https://www.visualstudio.com/</a></p></li> +<li><dl class="first docutils"> +<dt>Compiler and IDE</dt> +<dd><ul class="first last simple"> +<li>Visual Studio. The community edition is free and can be used to build SINGA. <a class="reference external" href="https://www.visualstudio.com/";>https://www.visualstudio.com/</a></li> </ul> </dd> </dl> </li> -<li><dl class="simple"> -<dt>CMake</dt><dd><ul class="simple"> -<li><p>Can be downloaded from <a class="reference external" href="http://cmake.org/";>http://cmake.org/</a></p></li> -<li><p>Make sure the path to cmake executable is in the system path, or use full path when calling cmake.</p></li> +<li><dl class="first docutils"> +<dt>CMake</dt> +<dd><ul class="first last simple"> +<li>Can be downloaded from <a class="reference external" href="http://cmake.org/";>http://cmake.org/</a></li> +<li>Make sure the path to cmake executable is in the system path, or use full path when calling cmake.</li> </ul> </dd> </dl> </li> -<li><dl class="simple"> -<dt>SWIG</dt><dd><ul class="simple"> -<li><p>Can be downloaded from <a class="reference external" href="http://swig.org/";>http://swig.org/</a></p></li> -<li><p>Make sure the path to swig executable is in the system path, or use full path when calling swig. Use a recent version such as 3.0.12.</p></li> +<li><dl class="first docutils"> +<dt>SWIG</dt> +<dd><ul class="first last simple"> +<li>Can be downloaded from <a class="reference external" href="http://swig.org/";>http://swig.org/</a></li> +<li>Make sure the path to swig executable is in the system path, or use full path when calling swig. Use a recent version such as 3.0.12.</li> </ul> </dd> </dl> </li> -<li><dl class="simple"> -<dt>Protocol Buffers</dt><dd><ul class="simple"> -<li><p>Download a suitable version such as 2.6.1: <a class="reference external" href="https://github.com/google/protobuf/releases/tag/v2.6.1";>https://github.com/google/protobuf/releases/tag/v2.6.1</a> .</p></li> -<li><p>Download both protobuf-2.6.1.zip and protoc-2.6.1-win32.zip .</p></li> -<li><p>Extract both of them in dependencies folder. Add the path to protoc executable to the system path, or use full path when calling it.</p></li> -<li><p>Open the Visual Studio solution which can be found in vsproject folder.</p></li> -<li><p>Change the build settings to Release and x64.</p></li> -<li><p>build libprotobuf project.</p></li> +<li><dl class="first docutils"> +<dt>Protocol Buffers</dt> +<dd><ul class="first last simple"> +<li>Download a suitable version such as 2.6.1: <a class="reference external" href="https://github.com/google/protobuf/releases/tag/v2.6.1";>https://github.com/google/protobuf/releases/tag/v2.6.1</a> .</li> +<li>Download both protobuf-2.6.1.zip and protoc-2.6.1-win32.zip .</li> +<li>Extract both of them in dependencies folder. Add the path to protoc executable to the system path, or use full path when calling it.</li> +<li>Open the Visual Studio solution which can be found in vsproject folder.</li> +<li>Change the build settings to Release and x64.</li> +<li>build libprotobuf project.</li> </ul> </dd> </dl> </li> -<li><dl> -<dt>Openblas</dt><dd><ul class="simple"> -<li><p>Download a suitable source version such as 0.2.20 from <a class="reference external" href="http://www.openblas.net";>http://www.openblas.net</a></p></li> -<li><p>Extract the source in the dependencies folder.</p></li> -<li><p>If you donât have Perl installed, download a perl environment such as Strawberry Perl (<a class="reference external" href="http://strawberryperl.com/";>http://strawberryperl.com/</a>)</p></li> -<li><p>Build the Visual Studio solution by running this command in the source folder:</p></li> +<li><dl class="first docutils"> +<dt>Openblas</dt> +<dd><ul class="first simple"> +<li>Download a suitable source version such as 0.2.20 from <a class="reference external" href="http://www.openblas.net";>http://www.openblas.net</a></li> +<li>Extract the source in the dependencies folder.</li> +<li>If you donât have Perl installed, download a perl environment such as Strawberry Perl (<a class="reference external" href="http://strawberryperl.com/";>http://strawberryperl.com/</a>)</li> +<li>Build the Visual Studio solution by running this command in the source folder:</li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>cmake -G <span class="s2">"Visual Studio 15 2017 Win64"</span> </pre></div> </div> -<ul class="simple"> -<li><p>Open the Visual Studio solution and change the build settings to Release and x64.</p></li> -<li><p>Build libopenblas project</p></li> +<ul class="last simple"> +<li>Open the Visual Studio solution and change the build settings to Release and x64.</li> +<li>Build libopenblas project</li> </ul> </dd> </dl> </li> -<li><dl class="simple"> -<dt>Google glog</dt><dd><ul class="simple"> -<li><p>Download a suitable version such as 0.3.5 from <a class="reference external" href="https://github.com/google/glog/releases";>https://github.com/google/glog/releases</a></p></li> -<li><p>Extract the source in the dependencies folder.</p></li> -<li><p>Open the Visual Studio solution.</p></li> -<li><p>Change the build settings to Release and x64.</p></li> -<li><p>Build libglog project</p></li> +<li><dl class="first docutils"> +<dt>Google glog</dt> +<dd><ul class="first last simple"> +<li>Download a suitable version such as 0.3.5 from <a class="reference external" href="https://github.com/google/glog/releases";>https://github.com/google/glog/releases</a></li> +<li>Extract the source in the dependencies folder.</li> +<li>Open the Visual Studio solution.</li> +<li>Change the build settings to Release and x64.</li> +<li>Build libglog project</li> </ul> </dd> </dl> @@ -255,10 +260,11 @@ <div class="section" id="build-singa-source"> <h2>2. Build SINGA source<a class="headerlink" href="#build-singa-source" title="Permalink to this headline">¶</a></h2> <ul class="simple"> -<li><p>Download SINGA source code</p></li> -<li><dl class="simple"> -<dt>Compile the protobuf files:</dt><dd><ul> -<li><p>Goto src/proto folder</p></li> +<li>Download SINGA source code</li> +<li><dl class="first docutils"> +<dt>Compile the protobuf files:</dt> +<dd><ul class="first last"> +<li>Goto src/proto folder</li> </ul> </dd> </dl> @@ -269,9 +275,9 @@ protoc.exe *.proto --python_out python_o </pre></div> </div> <ul class="simple"> -<li><dl class="simple"> -<dt>Generate swig interfaces for C++ and Python:</dt><dd><p>Goto src/api</p> -</dd> +<li><dl class="first docutils"> +<dt>Generate swig interfaces for C++ and Python:</dt> +<dd>Goto src/api</dd> </dl> </li> </ul> @@ -279,9 +285,9 @@ protoc.exe *.proto --python_out python_o </pre></div> </div> <ul class="simple"> -<li><dl class="simple"> -<dt>generate Visual Studio solution for SINGA:</dt><dd><p>Goto SINGA source code root folder</p> -</dd> +<li><dl class="first docutils"> +<dt>generate Visual Studio solution for SINGA:</dt> +<dd>Goto SINGA source code root folder</dd> </dl> </li> </ul> @@ -290,7 +296,7 @@ protoc.exe *.proto --python_out python_o </pre></div> </div> <ul class="simple"> -<li><p>Call cmake and add the paths in your system similar to the following example:</p></li> +<li>Call cmake and add the paths in your system similar to the following example:</li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>cmake -G <span class="s2">"Visual Studio 15 2017 Win64"</span> ^ -DGLOG_INCLUDE_DIR<span class="o">=</span><span class="s2">"D:/WinSinga/dependencies/glog-0.3.5/src/windows"</span> ^ @@ -304,36 +310,37 @@ protoc.exe *.proto --python_out python_o </pre></div> </div> <ul class="simple"> -<li><p>Open the generated solution in Visual Studio</p></li> -<li><p>Change the build settings to Release and x64</p></li> -<li><p>Add the singa_wrap.cxx file from src/api to the singa_objects project</p></li> -<li><p>In the singa_objects project, open Additional Include Directories.</p></li> -<li><p>Add Python include path</p></li> -<li><p>Add numpy include path</p></li> -<li><p>Add protobuf include path</p></li> -<li><p>In the preprocessor definitions of the singa_objects project, add USE_GLOG</p></li> -<li><p>Build singa_objects project</p></li> -<li><dl class="simple"> -<dt>In singa project:</dt><dd><ul> -<li><p>add singa_wrap.obj to Object Libraries</p></li> -<li><p>change target name to _singa_wrap</p></li> -<li><p>change target extension to .pyd</p></li> -<li><p>change configuration type to Dynamic Library (.dll)</p></li> -<li><p>goto Additional Library Directories and add the path to python, openblas, protobuf and glog libraries</p></li> -<li><p>goto Additional Dependencies and add libopenblas.lib, libglog.lib and libprotobuf.lib</p></li> +<li>Open the generated solution in Visual Studio</li> +<li>Change the build settings to Release and x64</li> +<li>Add the singa_wrap.cxx file from src/api to the singa_objects project</li> +<li>In the singa_objects project, open Additional Include Directories.</li> +<li>Add Python include path</li> +<li>Add numpy include path</li> +<li>Add protobuf include path</li> +<li>In the preprocessor definitions of the singa_objects project, add USE_GLOG</li> +<li>Build singa_objects project</li> +<li><dl class="first docutils"> +<dt>In singa project:</dt> +<dd><ul class="first last"> +<li>add singa_wrap.obj to Object Libraries</li> +<li>change target name to _singa_wrap</li> +<li>change target extension to .pyd</li> +<li>change configuration type to Dynamic Library (.dll)</li> +<li>goto Additional Library Directories and add the path to python, openblas, protobuf and glog libraries</li> +<li>goto Additional Dependencies and add libopenblas.lib, libglog.lib and libprotobuf.lib</li> </ul> </dd> </dl> </li> -<li><p>build singa project</p></li> +<li>build singa project</li> </ul> </div> <div class="section" id="install-python-module"> <h2>3. Install Python module<a class="headerlink" href="#install-python-module" title="Permalink to this headline">¶</a></h2> <ul class="simple"> -<li><p>Change _singa_wrap.so to _singa_wrap.pyd in build/python/setup.py</p></li> -<li><p>Copy the files in src/proto/python_out to build/python/singa/proto</p></li> -<li><p>Optionally create and activate a virtual environment:</p></li> +<li>Change _singa_wrap.so to _singa_wrap.pyd in build/python/setup.py</li> +<li>Copy the files in src/proto/python_out to build/python/singa/proto</li> +<li>Optionally create and activate a virtual environment:</li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>mkdir SingaEnv virtualenv SingaEnv @@ -341,25 +348,25 @@ SingaEnv<span class="se">\S</span>cripts </pre></div> </div> <ul class="simple"> -<li><p>goto build/python folder and run:</p></li> +<li>goto build/python folder and run:</li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python setup.py install </pre></div> </div> <ul class="simple"> -<li><p>Make _singa_wrap.pyd, libglog.dll and libopenblas.dll available by adding them to the path or by copying them to singa package folder in the python site-packages</p></li> -<li><p>Verify that SINGA is installed by running:</p></li> +<li>Make _singa_wrap.pyd, libglog.dll and libopenblas.dll available by adding them to the path or by copying them to singa package folder in the python site-packages</li> +<li>Verify that SINGA is installed by running:</li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python -c <span class="s2">"from singa import tensor"</span> </pre></div> </div> <p>A video tutorial for the build process can be found here:</p> -<table class="docutils align-center"> +<table border="1" class="docutils"> <colgroup> -<col style="width: 100%" /> +<col width="100%" /> </colgroup> -<tbody> -<tr class="row-odd"><td><p><a class="reference external" href="https://www.youtube.com/watch?v=YOjwtrvTPn4";><img alt="video" class="align-middle" src="https://img.youtube.com/vi/YOjwtrvTPn4/0.jpg"; /></a></p></td> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference external" href="https://www.youtube.com/watch?v=YOjwtrvTPn4";><img alt="video" class="align-middle" src="https://img.youtube.com/vi/YOjwtrvTPn4/0.jpg"; /></a></td> </tr> </tbody> </table> @@ -367,41 +374,47 @@ SingaEnv<span class="se">\S</span>cripts <div class="section" id="run-unit-tests"> <h2>4. Run Unit Tests<a class="headerlink" href="#run-unit-tests" title="Permalink to this headline">¶</a></h2> <ul class="simple"> -<li><p>In the test folder, generate the Visual Studio solution:</p></li> +<li>In the test folder, generate the Visual Studio solution:</li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>cmake -G <span class="s2">"Visual Studio 15 2017 Win64"</span> </pre></div> </div> <ul> -<li><p>Open the generated solution in Visual Studio.</p></li> -<li><p>Change the build settings to Release and x64.</p></li> -<li><p>Build glog project.</p></li> -<li><p>In test_singa project:</p> +<li><p class="first">Open the generated solution in Visual Studio.</p> +</li> +<li><p class="first">Change the build settings to Release and x64.</p> +</li> +<li><p class="first">Build glog project.</p> +</li> +<li><p class="first">In test_singa project:</p> <blockquote> <div><ul class="simple"> -<li><p>Add USE_GLOG to the Preprocessor Definitions.</p></li> -<li><p>In Additional Include Directories, add path of GLOG_INCLUDE_DIR, CBLAS_INCLUDE_DIR and Protobuf_INCLUDE_DIR which were used in step 2 above. Add also build and build/include folders.</p></li> -<li><p>Goto Additional Library Directories and add the path to openblas, protobuf and glog libraries. Add also build/src/singa_objects.dir/Release.</p></li> -<li><p>Goto Additional Dependencies and add libopenblas.lib, libglog.lib and libprotobuf.lib. Fix the names of the two libraries: gtest.lib and singa_objects.lib.</p></li> +<li>Add USE_GLOG to the Preprocessor Definitions.</li> +<li>In Additional Include Directories, add path of GLOG_INCLUDE_DIR, CBLAS_INCLUDE_DIR and Protobuf_INCLUDE_DIR which were used in step 2 above. Add also build and build/include folders.</li> +<li>Goto Additional Library Directories and add the path to openblas, protobuf and glog libraries. Add also build/src/singa_objects.dir/Release.</li> +<li>Goto Additional Dependencies and add libopenblas.lib, libglog.lib and libprotobuf.lib. Fix the names of the two libraries: gtest.lib and singa_objects.lib.</li> </ul> </div></blockquote> </li> -<li><p>Build test_singa project.</p></li> -<li><p>Make libglog.dll and libopenblas.dll available by adding them to the path or by copying them to test/release folder</p></li> -<li><p>The unit tests can be executed</p> +<li><p class="first">Build test_singa project.</p> +</li> +<li><p class="first">Make libglog.dll and libopenblas.dll available by adding them to the path or by copying them to test/release folder</p> +</li> +<li><p class="first">The unit tests can be executed</p> <blockquote> <div><ul> -<li><p>From the command line:</p> +<li><p class="first">From the command line:</p> <blockquote> <div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>test_singa.exe </pre></div> </div> </div></blockquote> </li> -<li><dl class="simple"> -<dt>From Visual Studio:</dt><dd><ul class="simple"> -<li><p>right click on the test_singa project and choose âSet as StartUp Projectâ.</p></li> -<li><p>from the Debug menu, choose âStart Without Debuggingâ</p></li> +<li><dl class="first docutils"> +<dt>From Visual Studio:</dt> +<dd><ul class="first last simple"> +<li>right click on the test_singa project and choose âSet as StartUp Projectâ.</li> +<li>from the Debug menu, choose âStart Without Debuggingâ</li> </ul> </dd> </dl> @@ -411,12 +424,12 @@ SingaEnv<span class="se">\S</span>cripts </li> </ul> <p>A video tutorial for running the unit tests can be found here:</p> -<table class="docutils align-center"> +<table border="1" class="docutils"> <colgroup> -<col style="width: 100%" /> +<col width="100%" /> </colgroup> -<tbody> -<tr class="row-odd"><td><p><a class="reference external" href="https://www.youtube.com/watch?v=YOjwtrvTPn4";><img alt="video" class="align-middle" src="https://img.youtube.com/vi/YOjwtrvTPn4/0.jpg"; /></a></p></td> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference external" href="https://www.youtube.com/watch?v=YOjwtrvTPn4";><img alt="video" class="align-middle" src="https://img.youtube.com/vi/YOjwtrvTPn4/0.jpg"; /></a></td> </tr> </tbody> </table> @@ -429,30 +442,34 @@ SingaEnv<span class="se">\S</span>cripts <h2>5.1 Install Dependencies<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2> <p>In addition to the dependencies in section 1 above, we will need the following:</p> <ul> -<li><p>CUDA</p> +<li><p class="first">CUDA</p> <blockquote> <div><p>Download a suitable version such as 9.1 from <a class="reference external" href="https://developer.nvidia.com/cuda-downloads";>https://developer.nvidia.com/cuda-downloads</a> . Make sure to install the Visual Studio integration module.</p> </div></blockquote> </li> -<li><p>cuDNN</p> +<li><p class="first">cuDNN</p> <blockquote> <div><p>Download a suitable version such as 7.1 from <a class="reference external" href="https://developer.nvidia.com/cudnn";>https://developer.nvidia.com/cudnn</a></p> </div></blockquote> </li> -<li><p>cnmem:</p> +<li><p class="first">cnmem:</p> <blockquote> <div><ul> -<li><p>Download the latest version from <a class="reference external" href="https://github.com/NVIDIA/cnmem";>https://github.com/NVIDIA/cnmem</a></p></li> -<li><p>Build the Visual Studio solution:</p> +<li><p class="first">Download the latest version from <a class="reference external" href="https://github.com/NVIDIA/cnmem";>https://github.com/NVIDIA/cnmem</a></p> +</li> +<li><p class="first">Build the Visual Studio solution:</p> <blockquote> <div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>cmake -G <span class="s2">"Visual Studio 15 2017 Win64"</span> </pre></div> </div> </div></blockquote> </li> -<li><p>Open the generated solution in Visual Studio.</p></li> -<li><p>Change the build settings to Release and x64.</p></li> -<li><p>Build the cnmem project.</p></li> +<li><p class="first">Open the generated solution in Visual Studio.</p> +</li> +<li><p class="first">Change the build settings to Release and x64.</p> +</li> +<li><p class="first">Build the cnmem project.</p> +</li> </ul> </div></blockquote> </li> @@ -461,7 +478,7 @@ SingaEnv<span class="se">\S</span>cripts <div class="section" id="id2"> <h2>5.2 Build SINGA source<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2> <ul> -<li><p>Call cmake and add the paths in your system similar to the following example:</p> +<li><p class="first">Call cmake and add the paths in your system similar to the following example:</p> <blockquote> <div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>cmake -G <span class="s2">"Visual Studio 15 2017 Win64"</span> ^ -DGLOG_INCLUDE_DIR<span class="o">=</span><span class="s2">"D:/WinSinga/dependencies/glog-0.3.5/src/windows"</span> ^ @@ -482,75 +499,83 @@ SingaEnv<span class="se">\S</span>cripts </div> </div></blockquote> </li> -<li><dl> -<dt>Generate swig interfaces for C++ and Python:</dt><dd><p>Goto src/api</p> -<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>swig -python -c++ singa.i +<li><dl class="first docutils"> +<dt>Generate swig interfaces for C++ and Python:</dt> +<dd><p class="first">Goto src/api</p> +<div class="last highlight-bash notranslate"><div class="highlight"><pre><span></span>swig -python -c++ singa.i </pre></div> </div> </dd> </dl> </li> -<li><p>Open the generated solution in Visual Studio</p></li> -<li><p>Change the build settings to Release and x64</p></li> +<li><p class="first">Open the generated solution in Visual Studio</p> +</li> +<li><p class="first">Change the build settings to Release and x64</p> +</li> </ul> </div> <div class="section" id="building-singa-objects"> <h2>5.2.1 Building singa_objects<a class="headerlink" href="#building-singa-objects" title="Permalink to this headline">¶</a></h2> <ul class="simple"> -<li><p>Add the singa_wrap.cxx file from src/api to the singa_objects project</p></li> -<li><p>In the singa_objects project, open Additional Include Directories.</p></li> -<li><p>Add Python include path</p></li> -<li><p>Add numpy include path</p></li> -<li><p>Add protobuf include path</p></li> -<li><p>Add include path for CUDA, cuDNN and cnmem</p></li> -<li><p>In the preprocessor definitions of the singa_objects project, add USE_GLOG, USE_CUDA and USE_CUDNN. Remove DISABLE_WARNINGS.</p></li> -<li><p>Build singa_objects project</p></li> +<li>Add the singa_wrap.cxx file from src/api to the singa_objects project</li> +<li>In the singa_objects project, open Additional Include Directories.</li> +<li>Add Python include path</li> +<li>Add numpy include path</li> +<li>Add protobuf include path</li> +<li>Add include path for CUDA, cuDNN and cnmem</li> +<li>In the preprocessor definitions of the singa_objects project, add USE_GLOG, USE_CUDA and USE_CUDNN. Remove DISABLE_WARNINGS.</li> +<li>Build singa_objects project</li> </ul> </div> <div class="section" id="building-singa-kernel"> <h2>5.2.2 Building singa-kernel<a class="headerlink" href="#building-singa-kernel" title="Permalink to this headline">¶</a></h2> <ul> -<li><p>Create a new Visual Studio project of type âCUDA 9.1 Runtimeâ. Give it a name such as singa-kernel.</p></li> -<li><p>The project comes with an initial file called kernel.cu. Remove this file from the project.</p></li> -<li><p>Add this file: src/core/tensor/math_kernel.cu</p></li> -<li><p>In the project settings:</p> +<li><p class="first">Create a new Visual Studio project of type âCUDA 9.1 Runtimeâ. Give it a name such as singa-kernel.</p> +</li> +<li><p class="first">The project comes with an initial file called kernel.cu. Remove this file from the project.</p> +</li> +<li><p class="first">Add this file: src/core/tensor/math_kernel.cu</p> +</li> +<li><p class="first">In the project settings:</p> <blockquote> <div><ul class="simple"> -<li><p>Set Platform Toolset to âVisual Studio 2015 (v140)â</p></li> -<li><p>Set Configuration Type to â Static Library (.lib)â</p></li> -<li><p>In the Include Directories, add build/include.</p></li> +<li>Set Platform Toolset to âVisual Studio 2015 (v140)â</li> +<li>Set Configuration Type to â Static Library (.lib)â</li> +<li>In the Include Directories, add build/include.</li> </ul> </div></blockquote> </li> -<li><p>Build singa-kernel project</p></li> +<li><p class="first">Build singa-kernel project</p> +</li> </ul> </div> <div class="section" id="building-singa"> <h2>5.2.3 Building singa<a class="headerlink" href="#building-singa" title="Permalink to this headline">¶</a></h2> <ul class="simple"> -<li><dl class="simple"> -<dt>In singa project:</dt><dd><ul> -<li><p>add singa_wrap.obj to Object Libraries</p></li> -<li><p>change target name to _singa_wrap</p></li> -<li><p>change target extension to .pyd</p></li> -<li><p>change configuration type to Dynamic Library (.dll)</p></li> -<li><p>goto Additional Library Directories and add the path to python, openblas, protobuf and glog libraries</p></li> -<li><p>Add also the library path to singa-kernel, cnmem, cuda and cudnn.</p></li> -<li><p>goto Additional Dependencies and add libopenblas.lib, libglog.lib and libprotobuf.lib.</p></li> -<li><p>Add also: singa-kernel.lib, cnmem.lib, cudnn.lib, cuda.lib , cublas.lib, curand.lib and cudart.lib.</p></li> +<li><dl class="first docutils"> +<dt>In singa project:</dt> +<dd><ul class="first last"> +<li>add singa_wrap.obj to Object Libraries</li> +<li>change target name to _singa_wrap</li> +<li>change target extension to .pyd</li> +<li>change configuration type to Dynamic Library (.dll)</li> +<li>goto Additional Library Directories and add the path to python, openblas, protobuf and glog libraries</li> +<li>Add also the library path to singa-kernel, cnmem, cuda and cudnn.</li> +<li>goto Additional Dependencies and add libopenblas.lib, libglog.lib and libprotobuf.lib.</li> +<li>Add also: singa-kernel.lib, cnmem.lib, cudnn.lib, cuda.lib , cublas.lib, curand.lib and cudart.lib.</li> </ul> </dd> </dl> </li> -<li><p>build singa project</p></li> +<li>build singa project</li> </ul> </div> <div class="section" id="id3"> <h2>5.3. Install Python module<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2> <ul class="simple"> -<li><p>Change _singa_wrap.so to _singa_wrap.pyd in build/python/setup.py</p></li> -<li><p>Copy the files in src/proto/python_out to build/python/singa/proto</p></li> -<li><p>Optionally create and activate a virtual environment:</p></li> +<li>Change _singa_wrap.so to _singa_wrap.pyd in build/python/setup.py</li> +<li>Copy the files in src/proto/python_out to build/python/singa/proto</li> +<li>Optionally create and activate a virtual environment:</li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>mkdir SingaEnv virtualenv SingaEnv @@ -558,25 +583,25 @@ SingaEnv<span class="se">\S</span>cripts </pre></div> </div> <ul class="simple"> -<li><p>goto build/python folder and run:</p></li> +<li>goto build/python folder and run:</li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python setup.py install </pre></div> </div> <ul class="simple"> -<li><p>Make _singa_wrap.pyd, libglog.dll, libopenblas.dll, cnmem.dll, CUDA Runtime (e.g. cudart64_91.dll) and cuDNN (e.g. cudnn64_7.dll) available by adding them to the path or by copying them to singa package folder in the python site-packages</p></li> -<li><p>Verify that SINGA is installed by running:</p></li> +<li>Make _singa_wrap.pyd, libglog.dll, libopenblas.dll, cnmem.dll, CUDA Runtime (e.g. cudart64_91.dll) and cuDNN (e.g. cudnn64_7.dll) available by adding them to the path or by copying them to singa package folder in the python site-packages</li> +<li>Verify that SINGA is installed by running:</li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python -c <span class="s2">"from singa import device; dev = device.create_cuda_gpu()"</span> </pre></div> </div> <p>A video tutorial for this part can be found here:</p> -<table class="docutils align-center"> +<table border="1" class="docutils"> <colgroup> -<col style="width: 100%" /> +<col width="100%" /> </colgroup> -<tbody> -<tr class="row-odd"><td><p><a class="reference external" href="https://www.youtube.com/watch?v=YOjwtrvTPn4";><img alt="video" class="align-middle" src="https://img.youtube.com/vi/YOjwtrvTPn4/0.jpg"; /></a></p></td> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference external" href="https://www.youtube.com/watch?v=YOjwtrvTPn4";><img alt="video" class="align-middle" src="https://img.youtube.com/vi/YOjwtrvTPn4/0.jpg"; /></a></td> </tr> </tbody> </table> @@ -584,41 +609,47 @@ SingaEnv<span class="se">\S</span>cripts <div class="section" id="id4"> <h2>5.4. Run Unit Tests<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2> <ul class="simple"> -<li><p>In the test folder, generate the Visual Studio solution:</p></li> +<li>In the test folder, generate the Visual Studio solution:</li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>cmake -G <span class="s2">"Visual Studio 15 2017 Win64"</span> </pre></div> </div> <ul> -<li><p>Open the generated solution in Visual Studio, or add the project to the singa solution that was created in step 5.2</p></li> -<li><p>Change the build settings to Release and x64.</p></li> -<li><p>Build glog project.</p></li> -<li><p>In test_singa project:</p> +<li><p class="first">Open the generated solution in Visual Studio, or add the project to the singa solution that was created in step 5.2</p> +</li> +<li><p class="first">Change the build settings to Release and x64.</p> +</li> +<li><p class="first">Build glog project.</p> +</li> +<li><p class="first">In test_singa project:</p> <blockquote> <div><ul class="simple"> -<li><p>Add USE_GLOG; USE_CUDA; USE_CUDNN to the Preprocessor Definitions.</p></li> -<li><p>In Additional Include Directories, add path of GLOG_INCLUDE_DIR, CBLAS_INCLUDE_DIR and Protobuf_INCLUDE_DIR which were used in step 5.2 above. Add also build, build/include, CUDA and cuDNN include folders.</p></li> -<li><p>Goto Additional Library Directories and add the path to openblas, protobuf and glog libraries. Add also build/src/singa_objects.dir/Release, singa-kernel, cnmem, CUDA and cuDNN library paths.</p></li> -<li><p>Goto Additional Dependencies and add libopenblas.lib; libglog.lib; libprotobuf.lib; cnmem.lib; cudnn.lib; cuda.lib; cublas.lib; curand.lib; cudart.lib; singa-kernel.lib. Fix the names of the two libraries: gtest.lib and singa_objects.lib.</p></li> +<li>Add USE_GLOG; USE_CUDA; USE_CUDNN to the Preprocessor Definitions.</li> +<li>In Additional Include Directories, add path of GLOG_INCLUDE_DIR, CBLAS_INCLUDE_DIR and Protobuf_INCLUDE_DIR which were used in step 5.2 above. Add also build, build/include, CUDA and cuDNN include folders.</li> +<li>Goto Additional Library Directories and add the path to openblas, protobuf and glog libraries. Add also build/src/singa_objects.dir/Release, singa-kernel, cnmem, CUDA and cuDNN library paths.</li> +<li>Goto Additional Dependencies and add libopenblas.lib; libglog.lib; libprotobuf.lib; cnmem.lib; cudnn.lib; cuda.lib; cublas.lib; curand.lib; cudart.lib; singa-kernel.lib. Fix the names of the two libraries: gtest.lib and singa_objects.lib.</li> </ul> </div></blockquote> </li> -<li><p>Build test_singa project.</p></li> -<li><p>Make libglog.dll, libopenblas.dll, cnmem.dll, cudart64_91.dll and cudnn64_7.dll available by adding them to the path or by copying them to test/release folder</p></li> -<li><p>The unit tests can be executed</p> +<li><p class="first">Build test_singa project.</p> +</li> +<li><p class="first">Make libglog.dll, libopenblas.dll, cnmem.dll, cudart64_91.dll and cudnn64_7.dll available by adding them to the path or by copying them to test/release folder</p> +</li> +<li><p class="first">The unit tests can be executed</p> <blockquote> <div><ul> -<li><p>From the command line:</p> +<li><p class="first">From the command line:</p> <blockquote> <div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>test_singa.exe </pre></div> </div> </div></blockquote> </li> -<li><dl class="simple"> -<dt>From Visual Studio:</dt><dd><ul class="simple"> -<li><p>right click on the test_singa project and choose âSet as StartUp Projectâ.</p></li> -<li><p>from the Debug menu, choose âStart Without Debuggingâ</p></li> +<li><dl class="first docutils"> +<dt>From Visual Studio:</dt> +<dd><ul class="first last simple"> +<li>right click on the test_singa project and choose âSet as StartUp Projectâ.</li> +<li>from the Debug menu, choose âStart Without Debuggingâ</li> </ul> </dd> </dl> @@ -628,12 +659,12 @@ SingaEnv<span class="se">\S</span>cripts </li> </ul> <p>A video tutorial for running the unit tests can be found here:</p> -<table class="docutils align-center"> +<table border="1" class="docutils"> <colgroup> -<col style="width: 100%" /> +<col width="100%" /> </colgroup> -<tbody> -<tr class="row-odd"><td><p><a class="reference external" href="https://www.youtube.com/watch?v=YOjwtrvTPn4";><img alt="video" class="align-middle" src="https://img.youtube.com/vi/YOjwtrvTPn4/0.jpg"; /></a></p></td> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference external" href="https://www.youtube.com/watch?v=YOjwtrvTPn4";><img alt="video" class="align-middle" src="https://img.youtube.com/vi/YOjwtrvTPn4/0.jpg"; /></a></td> </tr> </tbody> </table> @@ -651,7 +682,7 @@ SingaEnv<span class="se">\S</span>cripts <div role="contentinfo"> <p> - © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners. + © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.. </p> </div> @@ -668,17 +699,36 @@ SingaEnv<span class="se">\S</span>cripts + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'1.1.0', + LANGUAGE:'None', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> - - - - - <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> <span class="rst-current-version" data-toggle="rst-current-version"> <span class="fa fa-book"> incubator-singa </span>
![https://img.youtube.com/vi/T8xGTH9vCBs/0.jpg"](https://img.youtube.com/vi/T8xGTH9vCBs/0.jpg"){kind=link}
![https://img.youtube.com/vi/YOjwtrvTPn4/0.jpg"](https://img.youtube.com/vi/YOjwtrvTPn4/0.jpg"){kind=link}