You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@singa.apache.org by wa...@apache.org on 2019/04/24 14:57:38 UTC
svn commit: r1858059 [14/38] - in /incubator/singa/site/trunk: ./ en/
en/_sources/ en/_sources/community/ en/_sources/develop/ en/_sources/docs/
en/_sources/docs/model_zoo/ en/_sources/docs/model_zoo/caffe/
en/_sources/docs/model_zoo/char-rnn/ en/_sour...
Added: incubator/singa/site/trunk/en/docs/device.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/device.html?rev=1858059&view=auto
==============================================================================
--- incubator/singa/site/trunk/en/docs/device.html (added)
+++ incubator/singa/site/trunk/en/docs/device.html Wed Apr 24 14:57:35 2019
@@ -0,0 +1,368 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Device — incubator-singa 1.1.0 documentation</title>
+
+
+
+
+
+
+
+
+ <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/pygments.css" type="text/css" />
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <link rel="next" title="Tensor" href="tensor.html" />
+ <link rel="prev" title="Software Stack" href="software_stack.html" />
+ <link href="../_static/style.css" rel="stylesheet" type="text/css">
+ <!--link href="../_static/fontawesome-all.min.css" rel="stylesheet" type="text/css"-->
+ <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous">
+ <style>
+ .fa:hover {
+ opacity: 0.7;
+ }
+ .fab:hover {
+ opacity: 0.7;
+ }
+ </style>
+
+</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" >
+
+
+
+ <a href="../index.html" class="icon icon-home"> incubator-singa
+
+
+
+
+ <img src="../_static/singa.png" class="logo" alt="Logo"/>
+
+ </a>
+
+
+
+
+ <div class="version">
+ latest
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+ <ul class="current">
+<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 current"><a class="current reference internal" href="#">Device</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#specific-devices">Specific devices</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#module-singa.device">Python API</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#cpp-api">CPP API</a></li>
+</ul>
+</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>
+<li class="toctree-l2"><a class="reference internal" href="net.html">FeedForward Net</a></li>
+<li class="toctree-l2"><a class="reference internal" href="initializer.html">Initializer</a></li>
+<li class="toctree-l2"><a class="reference internal" href="loss.html">Loss</a></li>
+<li class="toctree-l2"><a class="reference internal" href="metric.html">Metric</a></li>
+<li class="toctree-l2"><a class="reference internal" href="optimizer.html">Optimizer</a></li>
+<li class="toctree-l2"><a class="reference internal" href="autograd.html">Autograd in Singa</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data.html">Data</a></li>
+<li class="toctree-l2"><a class="reference internal" href="image_tool.html">Image Tool</a></li>
+<li class="toctree-l2"><a class="reference internal" href="snapshot.html">Snapshot</a></li>
+<li class="toctree-l2"><a class="reference internal" href="converter.html">Caffe Converter</a></li>
+<li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="model_zoo/index.html">Model Zoo</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Development</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../develop/schedule.html">Development Schedule</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-contribute.html">How to Contribute to SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-contribute.html#how-to-become-a-singa-committer">How to become a SINGA committer</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-code.html">How to Contribute Code</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-to-release.html">How to prepare a release</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Community</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../community/source-repository.html">Source Repository</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/mail-lists.html">Project Mailing Lists</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/issue-tracking.html">Issue Tracking</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/team-list.html">The SINGA Team</a></li>
+</ul>
+
+
+
+ </div>
+ </div>
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" aria-label="top navigation">
+
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">incubator-singa</a>
+
+ </nav>
+
+
+ <div class="wy-nav-content">
+
+ <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+ <ul class="wy-breadcrumbs">
+
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li><a href="index.html">Documentation</a> »</li>
+
+ <li>Device</li>
+
+
+ <li class="wy-breadcrumbs-aside">
+
+
+
+ </li>
+
+ </ul>
+
+
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="device">
+<h1>Device<a class="headerlink" href="#device" title="Permalink to this headline">¶</a></h1>
+<p>The Device abstract represents any hardware device with memory and compuation units.
+All [Tensor operations](tensor.html) are scheduled by the resident device for execution.
+Tensor memory is also managed by the deviceâs memory manager. Therefore, optimization
+of memory and execution are implemented in the Device class.</p>
+<div class="section" id="specific-devices">
+<h2>Specific devices<a class="headerlink" href="#specific-devices" title="Permalink to this headline">¶</a></h2>
+<p>Currently, SINGA has three Device implmentations,</p>
+<ol class="arabic simple">
+<li><p>CudaGPU for an Nvidia GPU card which runs Cuda code</p></li>
+<li><p>CppCPU for a CPU which runs Cpp code</p></li>
+<li><p>OpenclGPU for a GPU card which runs OpenCL code</p></li>
+</ol>
+</div>
+<div class="section" id="module-singa.device">
+<span id="python-api"></span><h2>Python API<a class="headerlink" href="#module-singa.device" title="Permalink to this headline">¶</a></h2>
+<p>This script includes Device class and its subclasses for python users
+to call singa::Device and its methods.</p>
+<p>TODO(wangwei) implement py CudaGPU class.</p>
+<dl class="function">
+<dt id="singa.device.create_cuda_gpus">
+<code class="descclassname">singa.device.</code><code class="descname">create_cuda_gpus</code><span class="sig-paren">(</span><em>num</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.device.create_cuda_gpus" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create a list of CudaGPU devices.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>num</strong> (<em>int</em>) â number of device to create.</p>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>a list of swig converted CudaGPU devices.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="function">
+<dt id="singa.device.create_cuda_gpus_on">
+<code class="descclassname">singa.device.</code><code class="descname">create_cuda_gpus_on</code><span class="sig-paren">(</span><em>device_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.device.create_cuda_gpus_on" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create a list of CudaGPU devices.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>device_ids</strong> (<em>list</em>) â a list of GPU card IDs.</p>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>a list of swig converted CudaGPU devices.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="function">
+<dt id="singa.device.get_default_device">
+<code class="descclassname">singa.device.</code><code class="descname">get_default_device</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.device.get_default_device" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get the default host device which is a CppCPU device</p>
+</dd></dl>
+
+<p>The following code provides examples of creating devices:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">singa</span> <span class="k">import</span> <span class="n">device</span>
+<span class="n">cuda</span> <span class="o">=</span> <span class="n">device</span><span class="o">.</span><span class="n">create_cuda_gpu_on</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="c1"># use GPU card of ID 0</span>
+<span class="n">host</span> <span class="o">=</span> <span class="n">device</span><span class="o">.</span><span class="n">get_default_device</span><span class="p">()</span> <span class="c1"># get the default host device (a CppCPU)</span>
+<span class="n">ary1</span> <span class="o">=</span> <span class="n">device</span><span class="o">.</span><span class="n">create_cuda_gpus</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span> <span class="c1"># create 2 devices, starting from ID 0</span>
+<span class="n">ary2</span> <span class="o">=</span> <span class="n">device</span><span class="o">.</span><span class="n">create_cuda_gpus</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span><span class="mi">2</span><span class="p">])</span> <span class="c1"># create 2 devices on ID 0 and 2</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="cpp-api">
+<h2>CPP API<a class="headerlink" href="#cpp-api" title="Permalink to this headline">¶</a></h2>
+</div>
+</div>
+
+
+ </div>
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="tensor.html" class="btn btn-neutral float-right" title="Tensor" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="software_stack.html" class="btn btn-neutral float-left" title="Software Stack" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <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.
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <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>
+ v: latest
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Languages</dt>
+ <dd><a href="../../en/index.html">English</a></dd>
+ <dd><a href="../../zh/index.html">ä¸æ</a></dd>
+ </dl>
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="http://singa.apache.org/v0.3.0/">0.3</a></dd>
+ <dd><a href="http://singa.apache.org/v1.1.0/">1.1</a></dd>
+ </dl>
+
+ </div>
+ <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="https://github.com/apache/incubator-singa" class="fa fa-github" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://aws.amazon.com/marketplace/seller-profile?id=5bcac385-12c4-4802-aec7-351e09b77b4c" class="fab fa-aws" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://hub.docker.com/r/apache/singa/" class="fab fa-docker" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.linkedin.com/groups/13550034" class="fa fa-linkedin" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://twitter.com/ApacheSinga" class="fa fa-twitter" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.facebook.com/Apache-SINGA-347284219056544/" class="fa fa-facebook" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.researchgate.net/project/Apache-SINGA" class="fab fa-researchgate" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+
+</div>
+
+ <a href="https://github.com/apache/incubator-singa">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"
+ alt="Fork me on GitHub">
+</a>
+
+
+
+
+</body>
+</html>
\ No newline at end of file
Added: incubator/singa/site/trunk/en/docs/docker.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/docker.html?rev=1858059&view=auto
==============================================================================
--- incubator/singa/site/trunk/en/docs/docker.html (added)
+++ incubator/singa/site/trunk/en/docs/docker.html Wed Apr 24 14:57:35 2019
@@ -0,0 +1,333 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Docker Images — incubator-singa 1.1.0 documentation</title>
+
+
+
+
+
+
+
+
+ <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/pygments.css" type="text/css" />
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <link href="../_static/style.css" rel="stylesheet" type="text/css">
+ <!--link href="../_static/fontawesome-all.min.css" rel="stylesheet" type="text/css"-->
+ <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous">
+ <style>
+ .fa:hover {
+ opacity: 0.7;
+ }
+ .fab:hover {
+ opacity: 0.7;
+ }
+ </style>
+
+</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" >
+
+
+
+ <a href="../index.html" class="icon icon-home"> incubator-singa
+
+
+
+
+ <img src="../_static/singa.png" class="logo" alt="Logo"/>
+
+ </a>
+
+
+
+
+ <div class="version">
+ latest
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="index.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Development</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../develop/schedule.html">Development Schedule</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-contribute.html">How to Contribute to SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-contribute.html#how-to-become-a-singa-committer">How to become a SINGA committer</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-code.html">How to Contribute Code</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-to-release.html">How to prepare a release</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Community</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../community/source-repository.html">Source Repository</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/mail-lists.html">Project Mailing Lists</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/issue-tracking.html">Issue Tracking</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/team-list.html">The SINGA Team</a></li>
+</ul>
+
+
+
+ </div>
+ </div>
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" aria-label="top navigation">
+
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">incubator-singa</a>
+
+ </nav>
+
+
+ <div class="wy-nav-content">
+
+ <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+ <ul class="wy-breadcrumbs">
+
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li>Docker Images</li>
+
+
+ <li class="wy-breadcrumbs-aside">
+
+
+
+ </li>
+
+ </ul>
+
+
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+--><div class="section" id="docker-images">
+<h1>Docker Images<a class="headerlink" href="#docker-images" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="available-tags">
+<h2>Available tags<a class="headerlink" href="#available-tags" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">devel</span></code>, with SINGA and the development packages installed on Ubuntu16.04 (no GPU)</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">devel-cuda</span></code>, with SINGA, CUDA8.0, CUDNN5, and other development packages installed on Ubuntu16.04</p></li>
+</ul>
+</div>
+<div class="section" id="use-the-existing-docker-images">
+<h2>Use the existing Docker images<a class="headerlink" href="#use-the-existing-docker-images" title="Permalink to this headline">¶</a></h2>
+<p>Users can pull the Docker images from Dockerhub via</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">docker</span> <span class="n">pull</span> <span class="n">apache</span><span class="o">/</span><span class="n">singa</span><span class="p">:</span><span class="n">devel</span>
+<span class="c1"># or</span>
+<span class="n">docker</span> <span class="n">pull</span> <span class="n">apache</span><span class="o">/</span><span class="n">singa</span><span class="p">:</span><span class="n">devel</span><span class="o">-</span><span class="n">cuda</span>
+</pre></div>
+</div>
+<p>Run the docker container using</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">docker</span> <span class="n">run</span> <span class="o">-</span><span class="n">it</span> <span class="n">apache</span><span class="o">/</span><span class="n">singa</span><span class="p">:</span><span class="n">devel</span> <span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">bash</span>
+<span class="c1"># or</span>
+<span class="n">docker</span> <span class="n">run</span> <span class="o">-</span><span class="n">it</span> <span class="n">apache</span><span class="o">/</span><span class="n">singa</span><span class="p">:</span><span class="n">devel</span><span class="o">-</span><span class="n">cuda</span> <span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">bash</span>
+</pre></div>
+</div>
+<p>The latest SINGA code is under the <code class="docutils literal notranslate"><span class="pre">incubator-singa</span></code> folder.</p>
+</div>
+<div class="section" id="create-new-docker-images-from-dockerfile">
+<h2>Create new Docker images from Dockerfile<a class="headerlink" href="#create-new-docker-images-from-dockerfile" title="Permalink to this headline">¶</a></h2>
+<p>New Docker images could be created by executing the following command within the
+Dockerfile folder, e.g., tool/docker/devel/</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">docker</span> <span class="n">build</span> <span class="o">-</span><span class="n">t</span> <span class="n">singa</span><span class="p">:</span><span class="o"><</span><span class="n">TAG</span><span class="o">></span> <span class="o">-</span><span class="n">f</span> <span class="n">Dockerfile</span>
+</pre></div>
+</div>
+<p>The <code class="docutils literal notranslate"><span class="pre"><TAG></span></code> is named as</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">devel</span><span class="o">|</span><span class="n">runtime</span><span class="p">[</span><span class="o">-</span><span class="n">CUDA</span><span class="o">|</span><span class="n">CPU</span><span class="p">][</span><span class="o">-</span><span class="n">CUDNN</span><span class="p">]</span>
+</pre></div>
+</div>
+<ul class="simple">
+<li><p>devel: development images with all dependent libsâ header files installed and SINGAâs source code; runtime: the minimal images which can run SINGA programs.</p></li>
+<li><p>CUDA: cuda10.0, cuda9.0</p></li>
+<li><p>CUDNN: cudnn7</p></li>
+</ul>
+<p>Here are some example tags:</p>
+<p><code class="docutils literal notranslate"><span class="pre">devel-cuda9-cudnn7</span></code>, <code class="docutils literal notranslate"><span class="pre">devel-cuda9-cudnn7</span></code>, <code class="docutils literal notranslate"><span class="pre">devel-cuda10-cudnn7</span></code>, <code class="docutils literal notranslate"><span class="pre">devel-cpu</span></code>, <code class="docutils literal notranslate"><span class="pre">runtime-gpu</span></code> and <code class="docutils literal notranslate"><span class="pre">runtime-cpu</span></code></p>
+<p>Please follow the existing Dockefiles under tool/docker/ to create other Dockefiles.
+The folder structure is like</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">level1</span><span class="p">:</span> <span class="n">devel</span><span class="o">|</span><span class="n">runtime</span>
+<span class="n">level2</span><span class="p">:</span> <span class="n">Dockerfile</span><span class="p">,</span> <span class="n">OS</span>
+<span class="n">level3</span><span class="p">:</span> <span class="n">Dockerfile</span><span class="p">,</span> <span class="n">CUDA</span><span class="o">|</span><span class="n">MKLDNN</span>
+</pre></div>
+</div>
+<p>For example, the path of the Dockerfile for <code class="docutils literal notranslate"><span class="pre">devel-cuda9-cudnn7</span></code> is <code class="docutils literal notranslate"><span class="pre">tool/docker/devel/ubuntu/cuda9/Dockerfile</span></code>.</p>
+</div>
+</div>
+
+
+ </div>
+
+ </div>
+ <footer>
+
+
+ <hr/>
+
+ <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.
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <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>
+ v: latest
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Languages</dt>
+ <dd><a href="../../en/index.html">English</a></dd>
+ <dd><a href="../../zh/index.html">ä¸æ</a></dd>
+ </dl>
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="http://singa.apache.org/v0.3.0/">0.3</a></dd>
+ <dd><a href="http://singa.apache.org/v1.1.0/">1.1</a></dd>
+ </dl>
+
+ </div>
+ <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="https://github.com/apache/incubator-singa" class="fa fa-github" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://aws.amazon.com/marketplace/seller-profile?id=5bcac385-12c4-4802-aec7-351e09b77b4c" class="fab fa-aws" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://hub.docker.com/r/apache/singa/" class="fab fa-docker" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.linkedin.com/groups/13550034" class="fa fa-linkedin" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://twitter.com/ApacheSinga" class="fa fa-twitter" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.facebook.com/Apache-SINGA-347284219056544/" class="fa fa-facebook" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.researchgate.net/project/Apache-SINGA" class="fab fa-researchgate" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+
+</div>
+
+ <a href="https://github.com/apache/incubator-singa">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"
+ alt="Fork me on GitHub">
+</a>
+
+
+
+
+</body>
+</html>
\ No newline at end of file
Added: 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=1858059&view=auto
==============================================================================
--- incubator/singa/site/trunk/en/docs/image_tool.html (added)
+++ incubator/singa/site/trunk/en/docs/image_tool.html Wed Apr 24 14:57:35 2019
@@ -0,0 +1,572 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Image Tool — incubator-singa 1.1.0 documentation</title>
+
+
+
+
+
+
+
+
+ <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/pygments.css" type="text/css" />
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <link rel="next" title="Snapshot" href="snapshot.html" />
+ <link rel="prev" title="Data" href="data.html" />
+ <link href="../_static/style.css" rel="stylesheet" type="text/css">
+ <!--link href="../_static/fontawesome-all.min.css" rel="stylesheet" type="text/css"-->
+ <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous">
+ <style>
+ .fa:hover {
+ opacity: 0.7;
+ }
+ .fab:hover {
+ opacity: 0.7;
+ }
+ </style>
+
+</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" >
+
+
+
+ <a href="../index.html" class="icon icon-home"> incubator-singa
+
+
+
+
+ <img src="../_static/singa.png" class="logo" alt="Logo"/>
+
+ </a>
+
+
+
+
+ <div class="version">
+ latest
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+ <ul class="current">
+<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="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>
+<li class="toctree-l2"><a class="reference internal" href="net.html">FeedForward Net</a></li>
+<li class="toctree-l2"><a class="reference internal" href="initializer.html">Initializer</a></li>
+<li class="toctree-l2"><a class="reference internal" href="loss.html">Loss</a></li>
+<li class="toctree-l2"><a class="reference internal" href="metric.html">Metric</a></li>
+<li class="toctree-l2"><a class="reference internal" href="optimizer.html">Optimizer</a></li>
+<li class="toctree-l2"><a class="reference internal" href="autograd.html">Autograd in Singa</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data.html">Data</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Image Tool</a></li>
+<li class="toctree-l2"><a class="reference internal" href="snapshot.html">Snapshot</a></li>
+<li class="toctree-l2"><a class="reference internal" href="converter.html">Caffe Converter</a></li>
+<li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="model_zoo/index.html">Model Zoo</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Development</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../develop/schedule.html">Development Schedule</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-contribute.html">How to Contribute to SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-contribute.html#how-to-become-a-singa-committer">How to become a SINGA committer</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-code.html">How to Contribute Code</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-to-release.html">How to prepare a release</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Community</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../community/source-repository.html">Source Repository</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/mail-lists.html">Project Mailing Lists</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/issue-tracking.html">Issue Tracking</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/team-list.html">The SINGA Team</a></li>
+</ul>
+
+
+
+ </div>
+ </div>
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" aria-label="top navigation">
+
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">incubator-singa</a>
+
+ </nav>
+
+
+ <div class="wy-nav-content">
+
+ <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+ <ul class="wy-breadcrumbs">
+
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li><a href="index.html">Documentation</a> »</li>
+
+ <li>Image Tool</li>
+
+
+ <li class="wy-breadcrumbs-aside">
+
+
+
+ </li>
+
+ </ul>
+
+
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="module-singa.image_tool">
+<span id="image-tool"></span><h1>Image Tool<a class="headerlink" href="#module-singa.image_tool" title="Permalink to this headline">¶</a></h1>
+<p>An utility model for image augmentation.</p>
+<p>Example usage:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">singa</span> <span class="k">import</span> <span class="n">image_tool</span>
+
+<span class="n">tool</span> <span class="o">=</span> <span class="n">image_tool</span><span class="o">.</span><span class="n">ImageTool</span><span class="p">()</span>
+<span class="n">imgs</span> <span class="o">=</span> <span class="n">tool</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'input.png'</span><span class="p">)</span><span class="o">.</span> <span class="n">resize_by_list</span><span class="p">([</span><span class="mi">112</span><span class="p">])</span><span class="o">.</span><span class="n">crop5</span><span class="p">((</span><span class="mi">96</span><span class="p">,</span> <span class="mi">96</span><span class="p">),</span> <span class="mi">5</span><span class="p">)</span><span class="o">.</span><span class="n">enhance</span><span class="p">()</span><span class="o">.</span><span class="n">flip</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
+<span class="k">for</span> <span class="n">idx</span><span class="p">,</span> <span class="n">img</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">imgs</span><span class="p">):</span>
+ <span class="n">img</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="s1">'</span><span class="si">%d</span><span class="s1">.png'</span> <span class="o">%</span> <span class="n">idx</span><span class="p">)</span>
+</pre></div>
+</div>
+<dl class="class">
+<dt id="singa.image_tool.ImageTool">
+<em class="property">class </em><code class="descclassname">singa.image_tool.</code><code class="descname">ImageTool</code><a class="headerlink" href="#singa.image_tool.ImageTool" title="Permalink to this definition">¶</a></dt>
+<dd><p>A tool for image augmentation.</p>
+<p>For operations with inplace=True, the returned value is the ImageTool
+instance self, which is for chaining multiple operations; Otherwise, the
+preprocessed images would be returned.</p>
+<p>For operations that has countable pre-processing cases, argument num_case
+could be set to decide the number of pre-processing cases to apply.
+Typically, it is set to 1 for training phases and to the max for test
+phases.</p>
+<dl class="method">
+<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>
+</dd></dl>
+
+<dl class="method">
+<dt id="singa.image_tool.ImageTool.crop3">
+<code class="descname">crop3</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.crop3" title="Permalink to this definition">¶</a></dt>
+<dd><p>Crop a max square patch of the input image at given position and
+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>
+</dd></dl>
+
+<dl class="method">
+<dt id="singa.image_tool.ImageTool.crop5">
+<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>
+</dd></dl>
+
+<dl class="method">
+<dt id="singa.image_tool.ImageTool.crop8">
+<code class="descname">crop8</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.crop8" title="Permalink to this definition">¶</a></dt>
+<dd><p>This is a union of patch_5 and patch_and_scale.</p>
+<p>You can follow this example to union any num of cases of imgtool methods</p>
+</dd></dl>
+
+<dl class="method">
+<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>
+</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>
+</dd></dl>
+
+<dl class="method">
+<dt id="singa.image_tool.ImageTool.flip_down">
+<code class="descname">flip_down</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_down" title="Permalink to this definition">¶</a></dt>
+<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>
+</dd></dl>
+
+<dl class="method">
+<dt id="singa.image_tool.ImageTool.num_augmentation">
+<code class="descname">num_augmentation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.image_tool.ImageTool.num_augmentation" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return the total number of augmentations to each image</p>
+</dd></dl>
+
+<dl class="method">
+<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>
+</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>
+
+<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></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></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></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></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="singa.image_tool.color_cast">
+<code class="descclassname">singa.image_tool.</code><code class="descname">color_cast</code><span class="sig-paren">(</span><em>img</em>, <em>offset</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.image_tool.color_cast" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add a random value from [-offset, offset] to each channel</p>
+</dd></dl>
+
+<dl class="function">
+<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>
+</dd></dl>
+
+<dl class="function">
+<dt id="singa.image_tool.crop_and_resize">
+<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>
+</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>
+</dd></dl>
+
+<dl class="function">
+<dt id="singa.image_tool.load_img">
+<code class="descclassname">singa.image_tool.</code><code class="descname">load_img</code><span class="sig-paren">(</span><em>path</em>, <em>grayscale=False</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.image_tool.load_img" title="Permalink to this definition">¶</a></dt>
+<dd><p>Read the image from a give path</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="singa.image_tool.resize">
+<code class="descclassname">singa.image_tool.</code><code class="descname">resize</code><span class="sig-paren">(</span><em>img</em>, <em>small_size</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.image_tool.resize" title="Permalink to this definition">¶</a></dt>
+<dd><p>Resize the image to make the smaller side be at the given size</p>
+</dd></dl>
+
+</div>
+
+
+ </div>
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <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>
+
+ </div>
+
+
+ <hr/>
+
+ <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.
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <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>
+ v: latest
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Languages</dt>
+ <dd><a href="../../en/index.html">English</a></dd>
+ <dd><a href="../../zh/index.html">ä¸æ</a></dd>
+ </dl>
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="http://singa.apache.org/v0.3.0/">0.3</a></dd>
+ <dd><a href="http://singa.apache.org/v1.1.0/">1.1</a></dd>
+ </dl>
+
+ </div>
+ <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="https://github.com/apache/incubator-singa" class="fa fa-github" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://aws.amazon.com/marketplace/seller-profile?id=5bcac385-12c4-4802-aec7-351e09b77b4c" class="fab fa-aws" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://hub.docker.com/r/apache/singa/" class="fab fa-docker" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.linkedin.com/groups/13550034" class="fa fa-linkedin" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://twitter.com/ApacheSinga" class="fa fa-twitter" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.facebook.com/Apache-SINGA-347284219056544/" class="fa fa-facebook" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.researchgate.net/project/Apache-SINGA" class="fab fa-researchgate" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+
+</div>
+
+ <a href="https://github.com/apache/incubator-singa">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"
+ alt="Fork me on GitHub">
+</a>
+
+
+
+
+</body>
+</html>
\ No newline at end of file
Added: incubator/singa/site/trunk/en/docs/index.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/index.html?rev=1858059&view=auto
==============================================================================
--- incubator/singa/site/trunk/en/docs/index.html (added)
+++ incubator/singa/site/trunk/en/docs/index.html Wed Apr 24 14:57:35 2019
@@ -0,0 +1,464 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Documentation — incubator-singa 1.1.0 documentation</title>
+
+
+
+
+
+
+
+
+ <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/pygments.css" type="text/css" />
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <link rel="next" title="Installation" href="installation.html" />
+ <link rel="prev" title="Welcome to Apache SINGA" href="../index.html" />
+ <link href="../_static/style.css" rel="stylesheet" type="text/css">
+ <!--link href="../_static/fontawesome-all.min.css" rel="stylesheet" type="text/css"-->
+ <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous">
+ <style>
+ .fa:hover {
+ opacity: 0.7;
+ }
+ .fab:hover {
+ opacity: 0.7;
+ }
+ </style>
+
+</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" >
+
+
+
+ <a href="../index.html" class="icon icon-home"> incubator-singa
+
+
+
+
+ <img src="../_static/singa.png" class="logo" alt="Logo"/>
+
+ </a>
+
+
+
+
+ <div class="version">
+ latest
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+ <ul class="current">
+<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="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>
+<li class="toctree-l2"><a class="reference internal" href="net.html">FeedForward Net</a></li>
+<li class="toctree-l2"><a class="reference internal" href="initializer.html">Initializer</a></li>
+<li class="toctree-l2"><a class="reference internal" href="loss.html">Loss</a></li>
+<li class="toctree-l2"><a class="reference internal" href="metric.html">Metric</a></li>
+<li class="toctree-l2"><a class="reference internal" href="optimizer.html">Optimizer</a></li>
+<li class="toctree-l2"><a class="reference internal" href="autograd.html">Autograd in Singa</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data.html">Data</a></li>
+<li class="toctree-l2"><a class="reference internal" href="image_tool.html">Image Tool</a></li>
+<li class="toctree-l2"><a class="reference internal" href="snapshot.html">Snapshot</a></li>
+<li class="toctree-l2"><a class="reference internal" href="converter.html">Caffe Converter</a></li>
+<li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="model_zoo/index.html">Model Zoo</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Development</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../develop/schedule.html">Development Schedule</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-contribute.html">How to Contribute to SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-contribute.html#how-to-become-a-singa-committer">How to become a SINGA committer</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-code.html">How to Contribute Code</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-to-release.html">How to prepare a release</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Community</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../community/source-repository.html">Source Repository</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/mail-lists.html">Project Mailing Lists</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/issue-tracking.html">Issue Tracking</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/team-list.html">The SINGA Team</a></li>
+</ul>
+
+
+
+ </div>
+ </div>
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" aria-label="top navigation">
+
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">incubator-singa</a>
+
+ </nav>
+
+
+ <div class="wy-nav-content">
+
+ <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+ <ul class="wy-breadcrumbs">
+
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li>Documentation</li>
+
+
+ <li class="wy-breadcrumbs-aside">
+
+
+
+ </li>
+
+ </ul>
+
+
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="documentation">
+<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="installation.html#from-conda">From Conda</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation.html#from-source">From source</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="installation.html#use-conda-to-build-singa">Use Conda to build SINGA</a></li>
+<li class="toctree-l3"><a class="reference internal" href="installation.html#use-native-tools-to-build-singa-on-ubuntu">Use native tools to build SINGA on Ubuntu</a></li>
+<li class="toctree-l3"><a class="reference internal" href="installation.html#compile-singa-on-windows">Compile SINGA on Windows</a></li>
+<li class="toctree-l3"><a class="reference internal" href="installation.html#more-details-about-the-compilation-options">More details about the compilation options</a></li>
+<li class="toctree-l3"><a class="reference internal" href="installation.html#use-modules">USE_MODULES</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="installation.html#use-python">USE_PYTHON</a></li>
+<li class="toctree-l4"><a class="reference internal" href="installation.html#use-cuda">USE_CUDA</a></li>
+<li class="toctree-l4"><a class="reference internal" href="installation.html#use-opencl">USE_OPENCL</a></li>
+<li class="toctree-l4"><a class="reference internal" href="installation.html#use-mkldnn">USE_MKLDNN</a></li>
+<li class="toctree-l4"><a class="reference internal" href="installation.html#package">PACKAGE</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="installation.html#faq">FAQ</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="software_stack.html">Software Stack</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="software_stack.html#core">Core</a></li>
+<li class="toctree-l2"><a class="reference internal" href="software_stack.html#model">Model</a></li>
+<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="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>
+<li class="toctree-l2"><a class="reference internal" href="device.html#cpp-api">CPP API</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="tensor.html">Tensor</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="tensor.html#tensor-implementation">Tensor implementation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tensor.html#module-singa.tensor">Python API</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tensor.html#cpp-api">CPP API</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="layer.html">Layer</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="layer.html#module-singa.layer">Python API</a></li>
+<li class="toctree-l2"><a class="reference internal" href="layer.html#cpp-api">CPP API</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="net.html">FeedForward Net</a></li>
+<li class="toctree-l1"><a class="reference internal" href="initializer.html">Initializer</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="initializer.html#module-singa.initializer">Python API</a></li>
+<li class="toctree-l2"><a class="reference internal" href="initializer.html#cpp-api">CPP API</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="loss.html">Loss</a></li>
+<li class="toctree-l1"><a class="reference internal" href="metric.html">Metric</a></li>
+<li class="toctree-l1"><a class="reference internal" href="optimizer.html">Optimizer</a></li>
+<li class="toctree-l1"><a class="reference internal" href="autograd.html">Autograd in Singa</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="autograd.html#relevant-modules">Relevant Modules</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="autograd.html#tensor">Tensor</a></li>
+<li class="toctree-l3"><a class="reference internal" href="autograd.html#operation">Operation</a></li>
+<li class="toctree-l3"><a class="reference internal" href="autograd.html#layer">Layer</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="autograd.html#examples">Examples</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="autograd.html#operation-only">Operation only</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="autograd.html#import-packages">Import packages</a></li>
+<li class="toctree-l4"><a class="reference internal" href="autograd.html#create-weight-matrix-and-bias-vector">Create weight matrix and bias vector</a></li>
+<li class="toctree-l4"><a class="reference internal" href="autograd.html#training">Training</a></li>
+</ul>
+</li>
+<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>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="data.html">Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="image_tool.html">Image Tool</a></li>
+<li class="toctree-l1"><a class="reference internal" href="snapshot.html">Snapshot</a></li>
+<li class="toctree-l1"><a class="reference internal" href="converter.html">Caffe Converter</a></li>
+<li class="toctree-l1"><a class="reference internal" href="utils.html">Utils</a></li>
+<li class="toctree-l1"><a class="reference internal" href="model_zoo/index.html">Model Zoo</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="model_zoo/cifar10/README.html">Train CNN over Cifar-10</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="model_zoo/cifar10/README.html#instructions">Instructions</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="model_zoo/cifar10/README.html#singa-installation">SINGA installation</a></li>
+<li class="toctree-l4"><a class="reference internal" href="model_zoo/cifar10/README.html#data-preparation">Data preparation</a></li>
+<li class="toctree-l4"><a class="reference internal" href="model_zoo/cifar10/README.html#training">Training</a></li>
+<li class="toctree-l4"><a class="reference internal" href="model_zoo/cifar10/README.html#prediction">Prediction</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="model_zoo/char-rnn/README.html">Train Char-RNN over plain text</a><ul>
+<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>
+<li class="toctree-l4"><a class="reference internal" href="model_zoo/imagenet/alexnet/README.html#data-download">Data download</a></li>
+<li class="toctree-l4"><a class="reference internal" href="model_zoo/imagenet/alexnet/README.html#data-preprocessing">Data preprocessing</a></li>
+<li class="toctree-l4"><a class="reference internal" href="model_zoo/imagenet/alexnet/README.html#training">Training</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/densenet/README.html">name: DenseNet models on ImageNet
+SINGA version: 1.1.1
+SINGA commit:
+license: https://github.com/pytorch/vision/blob/master/torchvision/models/densenet.py</a></li>
+<li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/densenet/README.html#image-classification-using-densenet">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">name: GoogleNet on ImageNet
+SINGA version: 1.0.1
+SINGA commit: 8c990f7da2de220e8a012c6a8ecc897dc7532744
+parameter_url: https://s3-ap-southeast-1.amazonaws.com/dlfile/bvlc_googlenet.tar.gz
+parameter_sha1: 0a88e8948b1abca3badfd8d090d6be03f8d7655d
+license: unrestricted https://github.com/BVLC/caffe/tree/master/models/bvlc_googlenet</a></li>
+<li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/googlenet/README.html#image-classification-using-googlenet">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">name: Inception V4 on ImageNet
+SINGA version: 1.1.1
+SINGA commit:
+parameter_url: https://s3-ap-southeast-1.amazonaws.com/dlfile/inception_v4.tar.gz
+parameter_sha1: 5fdd6f5d8af8fd10e7321d9b38bb87ef14e80d56
+license: https://github.com/tensorflow/models/tree/master/slim</a></li>
+<li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/inception/README.html#image-classification-using-inception-v4">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">name: Resnets on ImageNet
+SINGA version: 1.1
+SINGA commit: 45ec92d8ffc1fa1385a9307fdf07e21da939ee2f
+parameter_url: https://s3-ap-southeast-1.amazonaws.com/dlfile/resnet/resnet-18.tar.gz
+license: Apache V2, https://github.com/facebook/fb.resnet.torch/blob/master/LICENSE</a></li>
+<li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/resnet/README.html#image-classification-using-residual-networks">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">name: VGG models on ImageNet
+SINGA version: 1.1.1
+SINGA commit:
+license: https://github.com/pytorch/vision/blob/master/torchvision/models/vgg.py</a></li>
+<li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/vgg/README.html#image-classification-using-vgg">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>
+</ul>
+</div>
+</div>
+
+
+ </div>
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <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>
+
+ </div>
+
+
+ <hr/>
+
+ <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.
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <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>
+ v: latest
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Languages</dt>
+ <dd><a href="../../en/index.html">English</a></dd>
+ <dd><a href="../../zh/index.html">ä¸æ</a></dd>
+ </dl>
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="http://singa.apache.org/v0.3.0/">0.3</a></dd>
+ <dd><a href="http://singa.apache.org/v1.1.0/">1.1</a></dd>
+ </dl>
+
+ </div>
+ <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="https://github.com/apache/incubator-singa" class="fa fa-github" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://aws.amazon.com/marketplace/seller-profile?id=5bcac385-12c4-4802-aec7-351e09b77b4c" class="fab fa-aws" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://hub.docker.com/r/apache/singa/" class="fab fa-docker" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.linkedin.com/groups/13550034" class="fa fa-linkedin" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://twitter.com/ApacheSinga" class="fa fa-twitter" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.facebook.com/Apache-SINGA-347284219056544/" class="fa fa-facebook" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.researchgate.net/project/Apache-SINGA" class="fab fa-researchgate" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+
+</div>
+
+ <a href="https://github.com/apache/incubator-singa">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"
+ alt="Fork me on GitHub">
+</a>
+
+
+
+
+</body>
+</html>
\ No newline at end of file