You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@singa.apache.org by ch...@apache.org on 2020/11/22 06:16:01 UTC
[singa-site] 03/47: update website from PR501
This is an automated email from the ASF dual-hosted git repository.
chrishkchris pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/singa-site.git
commit f524c765811872690e978ec198538dfb826ddd5b
Author: wangwei <wa...@gmail.com>
AuthorDate: Sat Aug 10 16:52:51 2019 +0800
update website from PR501
---
_static/basic.css | 15 +
_static/searchtools.js | 7 +-
en/community/issue-tracking.html | 115 +-
en/community/mail-lists.html | 140 +-
en/community/source-repository.html | 94 +-
en/community/team-list.html | 263 ++--
en/{docs/installation.html => develop/build.html} | 463 +++---
en/develop/contribute-code.html | 231 +--
en/develop/contribute-docs.html | 199 ++-
en/develop/how-contribute.html | 138 +-
en/develop/how-to-release.html | 157 +-
en/develop/schedule.html | 363 +++--
en/docs/autograd.html | 170 +--
en/docs/benchmark.html | 74 +-
en/docs/cnn.html | 115 +-
en/docs/converter.html | 127 +-
en/docs/data.html | 189 +--
en/docs/dependencies.html | 125 +-
en/docs/device.html | 156 +-
en/docs/docker.html | 127 +-
en/docs/image_tool.html | 457 +-----
en/docs/index.html | 180 +--
en/docs/initializer.html | 191 +--
en/docs/install_macos1013.html | 112 +-
en/docs/install_win.html | 452 +++---
en/docs/installation.html | 513 ++-----
en/docs/layer.html | 1239 +---------------
en/docs/loss.html | 343 +----
en/docs/metric.html | 306 +---
en/docs/net.html | 417 +-----
en/docs/neural-net.html | 182 ++-
en/docs/notebook/README.html | 109 +-
en/docs/{converter.html => onnx.html} | 117 +-
en/docs/optimizer.html | 581 +-------
en/docs/snapshot.html | 177 +--
en/docs/software_stack.html | 185 +--
en/docs/tensor.html | 1607 +--------------------
en/docs/utils.html | 145 +-
en/downloads.html | 352 +++--
en/index.html | 172 +--
en/releases/RELEASE_NOTES_0.1.0.html | 265 ++--
en/releases/RELEASE_NOTES_0.2.0.html | 237 ++-
en/releases/RELEASE_NOTES_0.3.0.html | 156 +-
en/releases/RELEASE_NOTES_1.0.0.html | 265 ++--
en/releases/RELEASE_NOTES_1.1.0.html | 184 ++-
en/releases/RELEASE_NOTES_1.2.0.html | 200 ++-
en/releases/RELEASE_NOTES_2.0.0.html | 180 ++-
search.html => en/security.html | 99 +-
genindex.html | 745 +---------
objects.inv | Bin 3406 -> 1822 bytes
search.html | 29 +-
searchindex.js | 2 +-
52 files changed, 3535 insertions(+), 9932 deletions(-)
diff --git a/_static/basic.css b/_static/basic.css
index 53acd09..c41d718 100644
--- a/_static/basic.css
+++ b/_static/basic.css
@@ -289,6 +289,12 @@ img.align-center, .figure.align-center, object.align-center {
margin-right: auto;
}
+img.align-default, .figure.align-default {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
.align-left {
text-align: left;
}
@@ -297,6 +303,10 @@ img.align-center, .figure.align-center, object.align-center {
text-align: center;
}
+.align-default {
+ text-align: center;
+}
+
.align-right {
text-align: right;
}
@@ -368,6 +378,11 @@ table.align-center {
margin-right: auto;
}
+table.align-default {
+ margin-left: auto;
+ margin-right: auto;
+}
+
table caption span.caption-number {
font-style: italic;
}
diff --git a/_static/searchtools.js b/_static/searchtools.js
index bdc2706..6031f99 100644
--- a/_static/searchtools.js
+++ b/_static/searchtools.js
@@ -319,12 +319,13 @@ var Search = {
for (var prefix in objects) {
for (var name in objects[prefix]) {
var fullname = (prefix ? prefix + '.' : '') + name;
- if (fullname.toLowerCase().indexOf(object) > -1) {
+ var fullnameLower = fullname.toLowerCase()
+ if (fullnameLower.indexOf(object) > -1) {
var score = 0;
- var parts = fullname.split('.');
+ var parts = fullnameLower.split('.');
// check for different match types: exact matches of full name or
// "last name" (i.e. last dotted part)
- if (fullname == object || parts[parts.length - 1] == object) {
+ if (fullnameLower == object || parts[parts.length - 1] == object) {
score += Scorer.objNameMatch;
// matches in last name
} else if (parts[parts.length - 1].indexOf(object) > -1) {
diff --git a/en/community/issue-tracking.html b/en/community/issue-tracking.html
index 1b2c3ae..d80a930 100644
--- a/en/community/issue-tracking.html
+++ b/en/community/issue-tracking.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Issue Tracking — incubator-singa 1.1.0 documentation</title>
+ <title>Issue Tracking — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,28 @@
-
-
+ <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="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="The SINGA Team" href="team-list.html" />
<link rel="prev" title="Project Mailing Lists" href="mail-lists.html" />
- <link href="../_static/style.css" rel="stylesheet" type="text/css">
- <!--link href="../_static/fontawesome-all.min.css" rel="stylesheet" type="text/css"-->
+ <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 {
@@ -44,21 +50,16 @@
}
</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" >
@@ -67,7 +68,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +83,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -102,12 +103,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../docs/index.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -187,24 +186,23 @@
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<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">licenses</span><span class="o">/</span><span class="n">LICENSE</span><span class="o">-</span><span [...]
-
-<span class="n">Unless</span> <span class="n">required</span> <span class="n">by</span> <span class="n">applicable</span> <span class="n">law</span> <span class="ow">or</span> <span class="n">agreed</span> <span class="n">to</span> <span class="ow">in</span> <span class="n">writing</span><span class="p">,</span>
-<span class="n">software</span> <span class="n">distributed</span> <span class="n">under</span> <span class="n">the</span> <span class="n">License</span> <span class="ow">is</span> <span class="n">distributed</span> <span class="n">on</span> <span class="n">an</span>
-<span class="s2">"AS IS"</span> <span class="n">BASIS</span><span class="p">,</span> <span class="n">WITHOUT</span> <span class="n">WARRANTIES</span> <span class="n">OR</span> <span class="n">CONDITIONS</span> <span class="n">OF</span> <span class="n">ANY</span>
-<span class="n">KIND</span><span class="p">,</span> <span class="n">either</span> <span class="n">express</span> <span class="ow">or</span> <span class="n">implied</span><span class="o">.</span> <span class="n">See</span> <span class="n">the</span> <span class="n">License</span> <span class="k">for</span> <span class="n">the</span>
-<span class="n">specific</span> <span class="n">language</span> <span class="n">governing</span> <span class="n">permissions</span> <span class="ow">and</span> <span class="n">limitations</span>
-<span class="n">under</span> <span class="n">the</span> <span class="n">License</span><span class="o">.</span>
-</pre></div>
-</div>
-<p>–></p>
-<div class="section" id="issue-tracking">
-<span id="issue-tracking"></span><h1>Issue Tracking<a class="headerlink" href="#issue-tracking" title="Permalink to this headline">¶</a></h1>
+ 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="issue-tracking">
+<h1>Issue Tracking<a class="headerlink" href="#issue-tracking" title="Permalink to this headline">¶</a></h1>
<hr class="docutils" />
<p>SINGA uses <a class="reference external" href="https://www.atlassian.com/software/jira">JIRA</a> a J2EE-based, issue tracking and project management application.</p>
<p>Issues, bugs, and feature requests should be submitted to the following issue tracking system for this project.</p>
<ul class="simple">
-<li>https://issues.apache.org/jira/browse/singa</li>
+<li><p>https://issues.apache.org/jira/browse/singa</p></li>
</ul>
</div>
@@ -219,7 +217,7 @@
<a href="team-list.html" class="btn btn-neutral float-right" title="The SINGA Team" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="mail-lists.html" class="btn btn-neutral" title="Project Mailing Lists" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="mail-lists.html" class="btn btn-neutral float-left" title="Project Mailing Lists" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -228,7 +226,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>
@@ -245,36 +243,17 @@
-
-
- <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>
@@ -284,8 +263,8 @@
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -294,8 +273,14 @@
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/community/mail-lists.html b/en/community/mail-lists.html
index c041e6a..a041e19 100644
--- a/en/community/mail-lists.html
+++ b/en/community/mail-lists.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Project Mailing Lists — incubator-singa 1.1.0 documentation</title>
+ <title>Project Mailing Lists — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,28 @@
-
-
+ <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="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="Issue Tracking" href="issue-tracking.html" />
<link rel="prev" title="Source Repository" href="source-repository.html" />
- <link href="../_static/style.css" rel="stylesheet" type="text/css">
- <!--link href="../_static/fontawesome-all.min.css" rel="stylesheet" type="text/css"-->
+ <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 {
@@ -44,21 +50,16 @@
}
</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" >
@@ -67,7 +68,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +83,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -102,12 +103,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../docs/index.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -183,35 +182,41 @@
<div class="section" id="project-mailing-lists">
<h1>Project Mailing Lists<a class="headerlink" href="#project-mailing-lists" title="Permalink to this headline">¶</a></h1>
<p>These are the mailing lists that have been established for this project. For each list, there is a subscribe, unsubscribe, and an archive link.</p>
-<table border="1" class="docutils" id="id4">
+<table class="docutils align-default" id="id4">
<caption><span class="caption-text">Mailing Lists</span><a class="headerlink" href="#id4" title="Permalink to this table">¶</a></caption>
<colgroup>
-<col width="20%" />
-<col width="20%" />
-<col width="20%" />
-<col width="20%" />
-<col width="20%" />
+<col style="width: 20%" />
+<col style="width: 20%" />
+<col style="width: 20%" />
+<col style="width: 20%" />
+<col style="width: 20%" />
</colgroup>
-<thead valign="bottom">
-<tr class="row-odd"><th class="head">Name</th>
-<th class="head">Post</th>
-<th class="head">Subscribe</th>
-<th class="head">Unsubscribe</th>
-<th class="head">Archive</th>
+<thead>
+<tr class="row-odd"><th class="head"><p>Name</p></th>
+<th class="head"><p>Post</p></th>
+<th class="head"><p>Subscribe</p></th>
+<th class="head"><p>Unsubscribe</p></th>
+<th class="head"><p>Archive</p></th>
</tr>
</thead>
-<tbody valign="top">
-<tr class="row-even"><td>Development</td>
-<td><a class="reference external" href="mailto:dev%40singa.incubator.apache.org">dev<span>@</span>singa<span>.</span>incubator<span>.</span>apache<span>.</span>org</a></td>
-<td><a class="reference external" href="mailto:dev-subscribe%40singa.incubator.apache.org">Subscribe</a></td>
-<td><a class="reference external" href="mailto:dev-unsubscribe%40singa.incubator.apache.org.">Unsubscribe</a></td>
-<td><a class="reference external" href="http://mail-archives.apache.org/mod_mbox/singa-dev/">mail-archives.apache.org</a></td>
+<tbody>
+<tr class="row-even"><td><p>Development</p></td>
+<td><p><a class="reference external" href="mailto:dev%40singa.incubator.apache.org">dev<span>@</span>singa<span>.</span>incubator<span>.</span>apache<span>.</span>org</a></p></td>
+<td><p><a class="reference external" href="mailto:dev-subscribe%40singa.incubator.apache.org">Subscribe</a></p></td>
+<td><p><a class="reference external" href="mailto:dev-unsubscribe%40singa.incubator.apache.org.">Unsubscribe</a></p></td>
+<td><p><a class="reference external" href="http://mail-archives.apache.org/mod_mbox/singa-dev/">mail-archives.apache.org</a></p></td>
+</tr>
+<tr class="row-odd"><td><p>Commits</p></td>
+<td><p><a class="reference external" href="mailto:commits%40singa.incubator.apache.org">commits<span>@</span>singa<span>.</span>incubator<span>.</span>apache<span>.</span>org</a></p></td>
+<td><p><a class="reference external" href="mailto:commits-subscribe%40singa.incubator.apache.org">Subscribe</a></p></td>
+<td><p><a class="reference external" href="mailto:commits-unsubscribe%40singa.incubator.apache.org">Unsubscribe</a></p></td>
+<td><p><a class="reference external" href="http://mail-archives.apache.org/mod_mbox/singa-commits/">mail-archives.apache.org</a></p></td>
</tr>
-<tr class="row-odd"><td>Commits</td>
-<td><a class="reference external" href="mailto:commits%40singa.incubator.apache.org">commits<span>@</span>singa<span>.</span>incubator<span>.</span>apache<span>.</span>org</a></td>
-<td><a class="reference external" href="mailto:commits-subscribe%40singa.incubator.apache.org">Subscribe</a></td>
-<td><a class="reference external" href="mailto:commits-unsubscribe%40singa.incubator.apache.org">Unsubscribe</a></td>
-<td><a class="reference external" href="http://mail-archives.apache.org/mod_mbox/singa-commits/">mail-archives.apache.org</a></td>
+<tr class="row-even"><td><p>Security</p></td>
+<td><p><a class="reference external" href="mailto:security%40singa.apache.org">security<span>@</span>singa<span>.</span>apache<span>.</span>org</a></p></td>
+<td><p>private</p></td>
+<td><p>private</p></td>
+<td><p>private</p></td>
</tr>
</tbody>
</table>
@@ -228,7 +233,7 @@
<a href="issue-tracking.html" class="btn btn-neutral float-right" title="Issue Tracking" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="source-repository.html" class="btn btn-neutral" title="Source Repository" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="source-repository.html" class="btn btn-neutral float-left" title="Source Repository" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -237,7 +242,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>
@@ -254,36 +259,17 @@
-
-
- <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>
@@ -293,8 +279,8 @@
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -303,8 +289,14 @@
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/community/source-repository.html b/en/community/source-repository.html
index ae9f4f1..f2e0408 100644
--- a/en/community/source-repository.html
+++ b/en/community/source-repository.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Source Repository — incubator-singa 1.1.0 documentation</title>
+ <title>Source Repository — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,28 @@
-
-
+ <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="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="Project Mailing Lists" href="mail-lists.html" />
<link rel="prev" title="How to prepare a release" href="../develop/how-to-release.html" />
- <link href="../_static/style.css" rel="stylesheet" type="text/css">
- <!--link href="../_static/fontawesome-all.min.css" rel="stylesheet" type="text/css"-->
+ <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 {
@@ -44,21 +50,16 @@
}
</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" >
@@ -67,7 +68,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +83,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -102,12 +103,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../docs/index.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -192,7 +191,7 @@
<h2>Web Access<a class="headerlink" href="#web-access" title="Permalink to this headline">¶</a></h2>
<p>The following is a link to the online source repository.</p>
<ul class="simple">
-<li><a class="reference external" href="https://gitbox.apache.org/repos/asf?p=incubator-singa.git">https://gitbox.apache.org/repos/asf?p=incubator-singa.git</a></li>
+<li><p><a class="reference external" href="https://gitbox.apache.org/repos/asf?p=incubator-singa.git">https://gitbox.apache.org/repos/asf?p=incubator-singa.git</a></p></li>
</ul>
</div>
<div class="section" id="contributors">
@@ -208,7 +207,7 @@ git rebase master
<div class="section" id="committers">
<h2>Committers<a class="headerlink" href="#committers" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
-<li>To connect your Apache account with your Github account, Please follow the instructions on: <a class="reference external" href="https://gitbox.apache.org/setup/">https://gitbox.apache.org/setup/</a>. After that you can directly merge PRs using GitHub’s UI.</li>
+<li><p>To connect your Apache account with your Github account, Please follow the instructions on: <a class="reference external" href="https://gitbox.apache.org/setup/">https://gitbox.apache.org/setup/</a>. After that you can directly merge PRs using GitHub’s UI.</p></li>
</ul>
<p>To merge pull request <a class="reference external" href="https://github.com/apache/incubator-singa/pull/xxx">https://github.com/apache/incubator-singa/pull/xxx</a>, the following instructions should be executed,</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git clone https://github.com/apache/incubator-singa.git
@@ -221,7 +220,7 @@ git push asf master:master
</pre></div>
</div>
<ul class="simple">
-<li>To migrate from git-wip-us.apache.org to Gitbox: If you already cloned the SINGA repository from the old repo <a class="reference external" href="https://git-wip-us.apache.org/repos/asf/incubator-singa.git">https://git-wip-us.apache.org/repos/asf/incubator-singa.git</a>, you can update the master by:</li>
+<li><p>To migrate from git-wip-us.apache.org to Gitbox: If you already cloned the SINGA repository from the old repo <a class="reference external" href="https://git-wip-us.apache.org/repos/asf/incubator-singa.git">https://git-wip-us.apache.org/repos/asf/incubator-singa.git</a>, you can update the master by:</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git remote set-url origin git@github.com/apache/singa.git
</pre></div>
@@ -240,7 +239,7 @@ git push asf master:master
<a href="mail-lists.html" class="btn btn-neutral float-right" title="Project Mailing Lists" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="../develop/how-to-release.html" class="btn btn-neutral" title="How to prepare a release" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="../develop/how-to-release.html" class="btn btn-neutral float-left" title="How to prepare a release" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -249,7 +248,7 @@ git push asf master:master
<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>
@@ -266,36 +265,17 @@ git push asf master:master
-
-
- <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>
@@ -305,8 +285,8 @@ git push asf master:master
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -315,8 +295,14 @@ git push asf master:master
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/community/team-list.html b/en/community/team-list.html
index 574bed0..006ecae 100644
--- a/en/community/team-list.html
+++ b/en/community/team-list.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>The SINGA Team — incubator-singa 1.1.0 documentation</title>
+ <title>The SINGA Team — incubator-singa 2.0.0 documentation</title>
@@ -18,21 +18,27 @@
-
-
+ <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="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="prev" title="Issue Tracking" href="issue-tracking.html" />
- <link href="../_static/style.css" rel="stylesheet" type="text/css">
- <!--link href="../_static/fontawesome-all.min.css" rel="stylesheet" type="text/css"-->
+ <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 {
@@ -43,21 +49,16 @@
}
</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" >
@@ -66,7 +67,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -81,7 +82,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -101,12 +102,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../docs/index.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -119,6 +118,7 @@
<li class="toctree-l1 current"><a class="current reference internal" href="#">The SINGA Team</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#mentors">Mentors</a></li>
<li class="toctree-l2"><a class="reference internal" href="#developers">Developers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#how-to-become-a-singa-committer">How to become a SINGA committer</a></li>
</ul>
</li>
</ul>
@@ -188,28 +188,28 @@
<p>A successful project requires many people to play many roles. Some members write code or documentation, while others are valuable as testers, submitting patches and suggestions.</p>
<div class="section" id="mentors">
<h2>Mentors<a class="headerlink" href="#mentors" title="Permalink to this headline">¶</a></h2>
-<table border="1" class="docutils">
+<table class="docutils align-default">
<colgroup>
-<col width="49%" />
-<col width="51%" />
+<col style="width: 49%" />
+<col style="width: 51%" />
</colgroup>
-<thead valign="bottom">
-<tr class="row-odd"><th class="head">Name</th>
-<th class="head">Email</th>
+<thead>
+<tr class="row-odd"><th class="head"><p>Name</p></th>
+<th class="head"><p>Email</p></th>
</tr>
</thead>
-<tbody valign="top">
-<tr class="row-even"><td>Daniel Dai</td>
-<td><a class="reference external" href="mailto:daijy%40apache.org">daijy<span>@</span>apache<span>.</span>org</a></td>
+<tbody>
+<tr class="row-even"><td><p>Daniel Dai</p></td>
+<td><p><a class="reference external" href="mailto:daijy%40apache.org">daijy<span>@</span>apache<span>.</span>org</a></p></td>
</tr>
-<tr class="row-odd"><td>Ted Dunning</td>
-<td><a class="reference external" href="mailto:tdunning%40apache.org">tdunning<span>@</span>apache<span>.</span>org</a></td>
+<tr class="row-odd"><td><p>Ted Dunning</p></td>
+<td><p><a class="reference external" href="mailto:tdunning%40apache.org">tdunning<span>@</span>apache<span>.</span>org</a></p></td>
</tr>
-<tr class="row-even"><td>Alan Gates</td>
-<td><a class="reference external" href="mailto:gates%40apache.org">gates<span>@</span>apache<span>.</span>org</a></td>
+<tr class="row-even"><td><p>Alan Gates</p></td>
+<td><p><a class="reference external" href="mailto:gates%40apache.org">gates<span>@</span>apache<span>.</span>org</a></p></td>
</tr>
-<tr class="row-odd"><td>Thejas Nair</td>
-<td><a class="reference external" href="mailto:thejas%40apache.org">thejas<span>@</span>apache<span>.</span>org</a></td>
+<tr class="row-odd"><td><p>Thejas Nair</p></td>
+<td><p><a class="reference external" href="mailto:thejas%40apache.org">thejas<span>@</span>apache<span>.</span>org</a></p></td>
</tr>
</tbody>
</table>
@@ -217,102 +217,108 @@
<div class="section" id="developers">
<h2>Developers<a class="headerlink" href="#developers" title="Permalink to this headline">¶</a></h2>
<p>The SINGA community has developers mainly from National University of Singapore, Zhejiang University, NetEase, Osaka University, yzBigData, etc.</p>
-<table border="1" class="docutils">
+<table class="docutils align-default">
<colgroup>
-<col width="20%" />
-<col width="32%" />
-<col width="47%" />
+<col style="width: 20%" />
+<col style="width: 32%" />
+<col style="width: 47%" />
</colgroup>
-<thead valign="bottom">
-<tr class="row-odd"><th class="head">Name</th>
-<th class="head">Email</th>
-<th class="head">Organization</th>
+<thead>
+<tr class="row-odd"><th class="head"><p>Name</p></th>
+<th class="head"><p>Email</p></th>
+<th class="head"><p>Organization</p></th>
</tr>
</thead>
-<tbody valign="top">
-<tr class="row-even"><td>Gang Chen</td>
-<td><a class="reference external" href="mailto:cg%40zju.edu.cn">cg<span>@</span>zju<span>.</span>edu<span>.</span>cn</a></td>
-<td>Zhejiang University</td>
+<tbody>
+<tr class="row-even"><td><p>Gang Chen</p></td>
+<td><p><a class="reference external" href="mailto:cg%40zju.edu.cn">cg<span>@</span>zju<span>.</span>edu<span>.</span>cn</a></p></td>
+<td><p>Zhejiang University</p></td>
</tr>
-<tr class="row-odd"><td>Haibo Chen</td>
-<td><a class="reference external" href="mailto:hzchenhaibo%40corp.netease.com">hzchenhaibo<span>@</span>corp<span>.</span>netease<span>.</span>com</a></td>
-<td>NetEase</td>
+<tr class="row-odd"><td><p>Haibo Chen</p></td>
+<td><p><a class="reference external" href="mailto:hzchenhaibo%40corp.netease.com">hzchenhaibo<span>@</span>corp<span>.</span>netease<span>.</span>com</a></p></td>
+<td><p>NetEase</p></td>
</tr>
-<tr class="row-even"><td>Anh Dinh</td>
-<td><a class="reference external" href="mailto:dinhtta%40apache.org">dinhtta<span>@</span>apache<span>.</span>org</a></td>
-<td>National University of Singapore</td>
+<tr class="row-even"><td><p>Anh Dinh</p></td>
+<td><p><a class="reference external" href="mailto:dinhtta%40apache.org">dinhtta<span>@</span>apache<span>.</span>org</a></p></td>
+<td><p>Singapore University of Technology and Design</p></td>
</tr>
-<tr class="row-odd"><td>Jinyang Gao</td>
-<td><a class="reference external" href="mailto:jinyang%40apache.org">jinyang<span>@</span>apache<span>.</span>org</a></td>
-<td>National University of Singapore</td>
+<tr class="row-odd"><td><p>Jinyang Gao</p></td>
+<td><p><a class="reference external" href="mailto:jinyang%40apache.org">jinyang<span>@</span>apache<span>.</span>org</a></p></td>
+<td><p>DAMO Academy, Alibaba Group</p></td>
</tr>
-<tr class="row-even"><td>Xin Ji</td>
-<td><a class="reference external" href="mailto:jixin%40comp.nus.edu.sg">jixin<span>@</span>comp<span>.</span>nus<span>.</span>edu<span>.</span>sg</a></td>
-<td>National University of Singapore</td>
+<tr class="row-even"><td><p>Xin Ji</p></td>
+<td><p><a class="reference external" href="mailto:jixin%40comp.nus.edu.sg">jixin<span>@</span>comp<span>.</span>nus<span>.</span>edu<span>.</span>sg</a></p></td>
+<td><p>Visenze</p></td>
</tr>
-<tr class="row-odd"><td>Chonho Lee</td>
-<td><a class="reference external" href="mailto:chonho%40gmail.com">chonho<span>@</span>gmail<span>.</span>com</a></td>
-<td>Osaka University</td>
+<tr class="row-odd"><td><p>Chonho Lee</p></td>
+<td><p><a class="reference external" href="mailto:chonho%40gmail.com">chonho<span>@</span>gmail<span>.</span>com</a></p></td>
+<td><p>Osaka University</p></td>
</tr>
-<tr class="row-even"><td>Zhaojing Luo</td>
-<td><a class="reference external" href="mailto:zhaojing%40apache.org">zhaojing<span>@</span>apache<span>.</span>org</a></td>
-<td>National University of Singapore</td>
+<tr class="row-even"><td><p>Zhaojing Luo</p></td>
+<td><p><a class="reference external" href="mailto:zhaojing%40apache.org">zhaojing<span>@</span>apache<span>.</span>org</a></p></td>
+<td><p>National University of Singapore</p></td>
</tr>
-<tr class="row-odd"><td>Beng Chin Ooi</td>
-<td><a class="reference external" href="mailto:ooibc%40comp.nus.edu.sg">ooibc<span>@</span>comp<span>.</span>nus<span>.</span>edu<span>.</span>sg</a></td>
-<td>National University of Singapore</td>
+<tr class="row-odd"><td><p>Beng Chin Ooi</p></td>
+<td><p><a class="reference external" href="mailto:ooibc%40comp.nus.edu.sg">ooibc<span>@</span>comp<span>.</span>nus<span>.</span>edu<span>.</span>sg</a></p></td>
+<td><p>National University of Singapore</p></td>
</tr>
-<tr class="row-even"><td>Kian-Lee Tan</td>
-<td><a class="reference external" href="mailto:tankl%40apache.org">tankl<span>@</span>apache<span>.</span>org</a></td>
-<td>National University of Singapore</td>
+<tr class="row-even"><td><p>Kian-Lee Tan</p></td>
+<td><p><a class="reference external" href="mailto:tankl%40apache.org">tankl<span>@</span>apache<span>.</span>org</a></p></td>
+<td><p>National University of Singapore</p></td>
</tr>
-<tr class="row-odd"><td>Anthony K. H. Tung</td>
-<td><a class="reference external" href="mailto:atung%40comp.nus.edu.sg">atung<span>@</span>comp<span>.</span>nus<span>.</span>edu<span>.</span>sg</a></td>
-<td>National University of Singapore</td>
+<tr class="row-odd"><td><p>Anthony K. H. Tung</p></td>
+<td><p><a class="reference external" href="mailto:atung%40comp.nus.edu.sg">atung<span>@</span>comp<span>.</span>nus<span>.</span>edu<span>.</span>sg</a></p></td>
+<td><p>National University of Singapore</p></td>
</tr>
-<tr class="row-even"><td>Ji Wang</td>
-<td><a class="reference external" href="mailto:wangji%40comp.nus.edu.sg">wangji<span>@</span>comp<span>.</span>nus<span>.</span>edu<span>.</span>sg</a></td>
-<td>National University of Singapore</td>
+<tr class="row-even"><td><p>Ji Wang</p></td>
+<td><p><a class="reference external" href="mailto:wangji%40comp.nus.edu.sg">wangji<span>@</span>comp<span>.</span>nus<span>.</span>edu<span>.</span>sg</a></p></td>
+<td><p>Hangzhou MZH Technologies</p></td>
</tr>
-<tr class="row-odd"><td>Sheng Wang</td>
-<td><a class="reference external" href="mailto:wangsh%40apache.org">wangsh<span>@</span>apache<span>.</span>org</a></td>
-<td>National University of Singapore</td>
+<tr class="row-odd"><td><p>Sheng Wang</p></td>
+<td><p><a class="reference external" href="mailto:wangsh%40apache.org">wangsh<span>@</span>apache<span>.</span>org</a></p></td>
+<td><p>DAMO Academy, Alibaba Group</p></td>
</tr>
-<tr class="row-even"><td>Wei Wang</td>
-<td><a class="reference external" href="mailto:wangwei%40apache.org">wangwei<span>@</span>apache<span>.</span>org</a></td>
-<td>National University of Singapore</td>
+<tr class="row-even"><td><p>Wei Wang</p></td>
+<td><p><a class="reference external" href="mailto:wangwei%40apache.org">wangwei<span>@</span>apache<span>.</span>org</a></p></td>
+<td><p>National University of Singapore</p></td>
</tr>
-<tr class="row-odd"><td>Yuan Wang</td>
-<td><a class="reference external" href="mailto:wangyuan%40corp.netease.com">wangyuan<span>@</span>corp<span>.</span>netease<span>.</span>com</a></td>
-<td>NetEase</td>
+<tr class="row-odd"><td><p>Yuan Wang</p></td>
+<td><p><a class="reference external" href="mailto:wangyuan%40corp.netease.com">wangyuan<span>@</span>corp<span>.</span>netease<span>.</span>com</a></p></td>
+<td><p>NetEase</p></td>
</tr>
-<tr class="row-even"><td>Wenfeng Wu</td>
-<td><a class="reference external" href="mailto:wuwf%40comp.nus.edu.sg">wuwf<span>@</span>comp<span>.</span>nus<span>.</span>edu<span>.</span>sg</a></td>
-<td>National University of Singapore</td>
+<tr class="row-even"><td><p>Wenfeng Wu</p></td>
+<td><p><a class="reference external" href="mailto:wuwf%40comp.nus.edu.sg">wuwf<span>@</span>comp<span>.</span>nus<span>.</span>edu<span>.</span>sg</a></p></td>
+<td><p>National University of Singapore</p></td>
</tr>
-<tr class="row-odd"><td>Zhongle Xie</td>
-<td><a class="reference external" href="mailto:zhongle%40apache.org">zhongle<span>@</span>apache<span>.</span>org</a></td>
-<td>National University of Singapore</td>
+<tr class="row-odd"><td><p>Zhongle Xie</p></td>
+<td><p><a class="reference external" href="mailto:zhongle%40apache.org">zhongle<span>@</span>apache<span>.</span>org</a></p></td>
+<td><p>Hangzhou MZH Technologies</p></td>
</tr>
-<tr class="row-even"><td>Meihui Zhang</td>
-<td><a class="reference external" href="mailto:meihui_zhang%40sutd.edu.sg">meihui_zhang<span>@</span>sutd<span>.</span>edu<span>.</span>sg</a></td>
-<td>Singapore University of Technology and Design</td>
+<tr class="row-even"><td><p>Meihui Zhang</p></td>
+<td><p><a class="reference external" href="mailto:meihui_zhang%40sutd.edu.sg">meihui_zhang<span>@</span>sutd<span>.</span>edu<span>.</span>sg</a></p></td>
+<td><p>Beijing Institute of Technology</p></td>
</tr>
-<tr class="row-odd"><td>Kaiping Zheng</td>
-<td><a class="reference external" href="mailto:kaiping%40apache.org">kaiping<span>@</span>apache<span>.</span>org</a></td>
-<td>National University of Singapore</td>
+<tr class="row-odd"><td><p>Kaiping Zheng</p></td>
+<td><p><a class="reference external" href="mailto:kaiping%40apache.org">kaiping<span>@</span>apache<span>.</span>org</a></p></td>
+<td><p>National University of Singapore</p></td>
</tr>
-<tr class="row-even"><td>Moaz Reyad</td>
-<td><a class="reference external" href="mailto:moaz%40apache.org">moaz<span>@</span>apache<span>.</span>org</a></td>
-<td>University of Genoa</td>
+<tr class="row-even"><td><p>Moaz Reyad</p></td>
+<td><p><a class="reference external" href="mailto:moaz%40apache.org">moaz<span>@</span>apache<span>.</span>org</a></p></td>
+<td><p>University of Genoa</p></td>
</tr>
-<tr class="row-odd"><td>Chang Yao</td>
-<td><a class="reference external" href="mailto:yaochang2009%40gmail.com">yaochang2009<span>@</span>gmail<span>.</span>com</a></td>
-<td>yzBigdata</td>
+<tr class="row-odd"><td><p>Chang Yao</p></td>
+<td><p><a class="reference external" href="mailto:yaochang2009%40gmail.com">yaochang2009<span>@</span>gmail<span>.</span>com</a></p></td>
+<td><p>Hangzhou MZH Technologies</p></td>
</tr>
</tbody>
</table>
</div>
+<div class="section" id="how-to-become-a-singa-committer">
+<h2>How to become a SINGA committer<a class="headerlink" href="#how-to-become-a-singa-committer" title="Permalink to this headline">¶</a></h2>
+<p>SINGA committers are members that have write access to SINGA code and documentation repositories. They can contribute by themselves and accept other contributions.</p>
+<p>Becoming a SINGA committer requires understanding the Apache Way and being an active member in the SINGA project. An active member participates on mailing lists, answers questions, contributes code, tests and documentation, presents SINGA in talks and seminars, verifies releases and report issues or feature requests.</p>
+<p>New committers can be suggested by current committers or PPMC members, and voted upon by the PPMC according to Apache guidelines. You can start by talking to other committers and ask for their advice and guidance.</p>
+</div>
</div>
@@ -324,7 +330,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="issue-tracking.html" class="btn btn-neutral" title="Issue Tracking" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="issue-tracking.html" class="btn btn-neutral float-left" title="Issue Tracking" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -333,7 +339,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>
@@ -350,36 +356,17 @@
-
-
- <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>
@@ -389,8 +376,8 @@
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -399,8 +386,14 @@
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/docs/installation.html b/en/develop/build.html
similarity index 51%
copy from en/docs/installation.html
copy to en/develop/build.html
index 51e0646..f6b3c0e 100644
--- a/en/docs/installation.html
+++ b/en/develop/build.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Installation — incubator-singa 1.1.0 documentation</title>
+ <title>Build SINGA from Source — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,26 @@
-
-
+ <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="Software Stack" href="software_stack.html" />
- <link rel="prev" title="Documentation" 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="../../_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 {
@@ -44,21 +48,16 @@
}
</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" >
@@ -67,7 +66,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +81,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -99,50 +98,16 @@
- <ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="index.html">Documentation</a><ul class="current">
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Installation</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#from-conda">From Conda</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#from-source">From source</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="#use-conda-to-build-singa">Use Conda to build SINGA</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#use-native-tools-to-build-singa-on-ubuntu">Use native tools to build SINGA on Ubuntu</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#compile-singa-on-windows">Compile SINGA on Windows</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#more-details-about-the-compilation-options">More details about the compilation options</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#use-modules">USE_MODULES</a></li>
-</ul>
-</li>
-<li class="toctree-l3"><a class="reference internal" href="#faq">FAQ</a></li>
-</ul>
-</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>
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../docs/index.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
+<li class="toctree-l1"><a class="reference internal" href="contribute-code.html">How to Contribute Code</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="how-to-release.html">How to prepare a release</a></li>
</ul>
<p class="caption"><span class="caption-text">Community</span></p>
<ul>
@@ -195,9 +160,7 @@
<li><a href="../index.html">Docs</a> »</li>
- <li><a href="index.html">Documentation</a> »</li>
-
- <li>Installation</li>
+ <li>Build SINGA from Source</li>
<li class="wy-breadcrumbs-aside">
@@ -221,133 +184,171 @@
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<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">licenses</span><span class="o">/</span><span class="n">LICENSE</span><span class="o">-</span><span [...]
-
-<span class="n">Unless</span> <span class="n">required</span> <span class="n">by</span> <span class="n">applicable</span> <span class="n">law</span> <span class="ow">or</span> <span class="n">agreed</span> <span class="n">to</span> <span class="ow">in</span> <span class="n">writing</span><span class="p">,</span>
-<span class="n">software</span> <span class="n">distributed</span> <span class="n">under</span> <span class="n">the</span> <span class="n">License</span> <span class="ow">is</span> <span class="n">distributed</span> <span class="n">on</span> <span class="n">an</span>
-<span class="s2">"AS IS"</span> <span class="n">BASIS</span><span class="p">,</span> <span class="n">WITHOUT</span> <span class="n">WARRANTIES</span> <span class="n">OR</span> <span class="n">CONDITIONS</span> <span class="n">OF</span> <span class="n">ANY</span>
-<span class="n">KIND</span><span class="p">,</span> <span class="n">either</span> <span class="n">express</span> <span class="ow">or</span> <span class="n">implied</span><span class="o">.</span> <span class="n">See</span> <span class="n">the</span> <span class="n">License</span> <span class="k">for</span> <span class="n">the</span>
-<span class="n">specific</span> <span class="n">language</span> <span class="n">governing</span> <span class="n">permissions</span> <span class="ow">and</span> <span class="n">limitations</span>
-<span class="n">under</span> <span class="n">the</span> <span class="n">License</span><span class="o">.</span>
+ 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="build-singa-from-source">
+<h1>Build SINGA from Source<a class="headerlink" href="#build-singa-from-source" title="Permalink to this headline">¶</a></h1>
+<p>The source files could be downloaded either as a
+<a class="reference external" href="https://dist.apache.org/repos/dist/dev/incubator/singa/">tar.gz file</a>, or as a git repo</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ git clone https://github.com/apache/incubator-singa.git
+$ cd incubator-singa/
</pre></div>
</div>
-<p>–></p>
-<div class="section" id="installation">
-<span id="installation"></span><h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
-<div class="section" id="from-conda">
-<span id="from-conda"></span><h2>From Conda<a class="headerlink" href="#from-conda" title="Permalink to this headline">¶</a></h2>
-<p>Conda is a package manager for Python, CPP and other packages.</p>
-<p>Currently, SINGA has conda packages (Python 2.7 and Python 3.6) for Linux and MacOSX.
-<a class="reference external" href="https://conda.io/miniconda.html">Miniconda3</a> is recommended to use with SINGA.
-After installing miniconda, execute the one of the following commands to install
-SINGA.</p>
-<ol>
-<li><p class="first">CPU only</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">nusdbsystem</span> <span class="n">singa</span><span class="o">-</span><span class="n">cpu</span>
+<p>If you want to contribute code to SINGA, refer to <a class="reference external" href="#">this page</a> for the steps and requirements.</p>
+<div class="section" id="use-conda-to-build-singa">
+<h2>Use Conda to build SINGA<a class="headerlink" href="#use-conda-to-build-singa" title="Permalink to this headline">¶</a></h2>
+<p>Conda-build is a building tool that installs the dependent libraries from anaconda cloud and
+executes the building scripts.</p>
+<p>To install conda-build (after installing conda)</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="n">conda</span><span class="o">-</span><span class="n">build</span>
</pre></div>
</div>
-</li>
-<li><p class="first">GPU with CUDA and cuDNN</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">nusdbsystem</span> <span class="n">singa</span><span class="o">-</span><span class="n">gpu</span>
+<div class="section" id="build-cpu-version">
+<h3>Build CPU Version<a class="headerlink" href="#build-cpu-version" title="Permalink to this headline">¶</a></h3>
+<p>To build the CPU version of SINGA</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">build</span> <span class="n">tool</span><span class="o">/</span><span class="n">conda</span><span class="o">/</span><span class="n">singa</span><span class="o">/</span>
</pre></div>
</div>
-</li>
+<p>The above commands have been tested on Ubuntu 16.04 and Mac OSX.
+Refer to the <a class="reference external" href="https://travis-ci.org/apache/incubator-singa">Travis-CI page</a> for more information.</p>
+</div>
+<div class="section" id="build-gpu-version">
+<h3>Build GPU Version<a class="headerlink" href="#build-gpu-version" title="Permalink to this headline">¶</a></h3>
+<p>To build the GPU version of SINGA, the building machine must have Nvida GPU, and the CUDA driver (>= 384.81), CUDA toolkit (>=9) and cuDNN (>=7) must have be installed. The following two Docker images provide the building environment:</p>
+<ol class="simple">
+<li><p>apache/singa:conda-cuda9.0</p></li>
+<li><p>apache/singa:conda-cuda10.0</p></li>
</ol>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">CUDA</span> <span class="n">driver</span> <span class="p">(</span><span class="k">for</span> <span class="n">CUDA</span> <span class="o">>=</span><span class="mf">9.0</span><span class="p">)</span> <span class="n">must</span> <span class="n">be</span> <span class="n">installed</span> <span class="n">before</span> <span class="n">executing</span> <span class="n">the</span> <span class= [...]
- <span class="n">packages</span> <span class="k">for</span> <span class="n">other</span> <span class="n">CUDA</span> <span class="n">versions</span> <span class="n">are</span> <span class="n">also</span> <span class="n">available</span><span class="o">.</span> <span class="n">The</span> <span class="n">following</span> <span class="n">instruction</span>
- <span class="n">lists</span> <span class="nb">all</span> <span class="n">the</span> <span class="n">available</span> <span class="n">Singa</span> <span class="n">packages</span><span class="o">.</span>
-
- <span class="n">conda</span> <span class="n">search</span> <span class="o">-</span><span class="n">c</span> <span class="n">nusdbsystem</span> <span class="n">singa</span>
+<p>Once the building environment is ready, you need to export the CUDA version first, and then run conda command to build SINGA</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">CUDA</span><span class="o">=</span><span class="n">x</span><span class="o">.</span><span class="n">y</span> <span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span> <span class="mf">9.0</span><span class="p">)</span>
+<span class="n">conda</span> <span class="n">build</span> <span class="n">tool</span><span class="o">/</span><span class="n">conda</span><span class="o">/</span><span class="n">singa</span><span class="o">/</span>
</pre></div>
</div>
-<p>If there is no error message from</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"from singa import tensor"</span>
+</div>
+<div class="section" id="post-processing">
+<h3>Post Processing<a class="headerlink" href="#post-processing" title="Permalink to this headline">¶</a></h3>
+<p>The location of the generated package file (<code class="docutils literal notranslate"><span class="pre">.tar.gz</span></code>) is shown on the screen.
+The generated package can be installed directly,</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="o">--</span><span class="n">use</span><span class="o">-</span><span class="n">local</span> <span class="o"><</span><span class="n">path</span> <span class="n">to</span> <span class="n">the</span> <span [...]
</pre></div>
</div>
-<p>then SINGA is installed successfully.</p>
+<p>or uploaded to anaconda cloud for others to download and install. You need to register an account on anaconda for <a class="reference external" href="https://docs.anaconda.com/anaconda-cloud/user-guide/getting-started/">uploading the package</a>.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="n">anaconda</span><span class="o">-</span><span class="n">client</span>
+<span class="n">anaconda</span> <span class="n">login</span>
+<span class="n">anaconda</span> <span class="n">upload</span> <span class="o">-</span><span class="n">l</span> <span class="n">main</span> <span class="o"><</span><span class="n">path</span> <span class="n">to</span> <span class="n">the</span> <span class="n">package</span> <span class="n">file</span><span class="o">></span>
+</pre></div>
</div>
-<div class="section" id="from-source">
-<span id="from-source"></span><h2>From source<a class="headerlink" href="#from-source" title="Permalink to this headline">¶</a></h2>
-<p>The source files could be downloaded either as a
-<a class="reference external" href="https://dist.apache.org/repos/dist/dev/incubator/singa/">tar.gz file</a>, or as a git repo</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ git clone https://github.com/apache/incubator-singa.git
-$ cd incubator-singa/
+<p>After uploading the package to the cloud, you can see it on <a class="reference external" href="https://anaconda.org/">Anaconda Cloud</a> website or via the following command</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">search</span> <span class="o">-</span><span class="n">c</span> <span class="o"><</span><span class="n">anaconda</span> <span class="n">username</span><span class="o">></span> <span class="n">singa</span>
</pre></div>
</div>
-<div class="section" id="use-conda-to-build-singa">
-<span id="use-conda-to-build-singa"></span><h3>Use Conda to build SINGA<a class="headerlink" href="#use-conda-to-build-singa" title="Permalink to this headline">¶</a></h3>
-<p>Conda-build is a building tool that installs the dependent libraries from anaconda cloud and
-executes the building scripts. The generated package can be uploaded to anaconda
-cloud for others to download and install.</p>
-<p>To install conda-build (after installing miniconda)</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="n">conda</span><span class="o">-</span><span class="n">build</span>
+<p>Each specific SINGA package is identified by the version and build string. To install a specific SINGA package, you need to provide all the information, e.g.,</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="o"><</span><span class="n">anaconda</span> <span class="n">username</span><span class="o">></span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">singa</span><span class="o">=</span [...]
</pre></div>
</div>
-<p>To build the CPU version of SINGA</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">build</span> <span class="n">tool</span><span class="o">/</span><span class="n">conda</span><span class="o">/</span><span class="n">singa</span><span class="o">/</span> <span class="o">--</span><span class="n">python</span> <span class="mf">3.6</span>
+<p>To make the installation command simple, you can create the following additional packages which depend on the latest CPU and GPU SINGA packages.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># for singa-cpu</span>
+<span class="n">conda</span> <span class="n">build</span> <span class="n">tool</span><span class="o">/</span><span class="n">conda</span><span class="o">/</span><span class="n">cpu</span><span class="o">/</span> <span class="o">--</span><span class="n">python</span><span class="o">=</span><span class="mf">3.6</span>
+<span class="n">conda</span> <span class="n">build</span> <span class="n">tool</span><span class="o">/</span><span class="n">conda</span><span class="o">/</span><span class="n">cpu</span><span class="o">/</span> <span class="o">--</span><span class="n">python</span><span class="o">=</span><span class="mf">3.7</span>
+<span class="c1"># for singa-gpu</span>
+<span class="n">conda</span> <span class="n">build</span> <span class="n">tool</span><span class="o">/</span><span class="n">conda</span><span class="o">/</span><span class="n">gpu</span><span class="o">/</span> <span class="o">--</span><span class="n">python</span><span class="o">=</span><span class="mf">3.6</span>
+<span class="n">conda</span> <span class="n">build</span> <span class="n">tool</span><span class="o">/</span><span class="n">conda</span><span class="o">/</span><span class="n">gpu</span><span class="o">/</span> <span class="o">--</span><span class="n">python</span><span class="o">=</span><span class="mf">3.7</span>
</pre></div>
</div>
-<p>The above commands have been tested on Ubuntu 16.04 and Mac OSX.
-Refer to the <a class="reference external" href="https://travis-ci.org/apache/incubator-singa">Travis-CI page</a> for more information.</p>
-<p>To build the GPU version of SINGA</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">CUDA</span><span class="o">=</span><span class="n">x</span><span class="o">.</span><span class="n">y</span> <span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span> <span class="mf">9.0</span><span class="p">)</span>
-<span class="n">conda</span> <span class="n">build</span> <span class="n">tool</span><span class="o">/</span><span class="n">conda</span><span class="o">/</span><span class="n">singa</span><span class="o">/</span> <span class="o">--</span><span class="n">python</span> <span class="mf">3.6</span>
+<p>Therefore, when you run</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="o"><</span><span class="n">anaconda</span> <span class="n">username</span><span class="o">></span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">singa</span><span class="o">-</span [...]
</pre></div>
</div>
-<p>The commands for building on GPU platforms have been tested on Ubuntu 16.04 (cuDNN>=7 and CUDA>=9).
-<a class="reference external" href="https://hub.docker.com/r/nvidia/cuda/">Nvidia’s Docker image</a> provides the building
-environment with cuDNN and CUDA.</p>
-<p>The location of the generated package file is shown on the screen.
-Refer to <a class="reference external" href="https://conda.io/docs/commands/conda-install.html">conda install</a> for
-the instructions of installing the package from the local file.</p>
+<p>(<code class="docutils literal notranslate"><span class="pre">xpu</span></code> is either ‘cpu’ or ‘gpu’), the corresponding real SINGA package is installed as the dependent library.</p>
+</div>
</div>
<div class="section" id="use-native-tools-to-build-singa-on-ubuntu">
-<span id="use-native-tools-to-build-singa-on-ubuntu"></span><h3>Use native tools to build SINGA on Ubuntu<a class="headerlink" href="#use-native-tools-to-build-singa-on-ubuntu" title="Permalink to this headline">¶</a></h3>
-<p>The following libraries are required to compile and run SINGA.
-Refer to SINGA <a class="reference external" href="https://github.com/apache/incubator-singa/blob/master/tool/docker/">Dockerfiles</a>
-for the instructions of installing them on Ubuntu 16.04.</p>
-<ul class="simple">
-<li>cmake (>=2.8)</li>
-<li>gcc (>=4.8.1)</li>
-<li>google protobuf (>=2.5)</li>
-<li>blas (tested with openblas >=0.2.10)</li>
-<li>swig(>=3.0.10) for compiling PySINGA</li>
-<li>numpy(>=1.11.0) for compiling PySINGA</li>
-</ul>
-<ol class="simple">
-<li>create a <code class="docutils literal notranslate"><span class="pre">build</span></code> folder inside incubator-singa and go into that folder</li>
-<li>run <code class="docutils literal notranslate"><span class="pre">cmake</span> <span class="pre">[options]</span> <span class="pre">..</span></code>
-by default all options are OFF except <code class="docutils literal notranslate"><span class="pre">USE_PYTHON</span></code><ul>
-<li><code class="docutils literal notranslate"><span class="pre">USE_MODULES=ON</span></code>, used if protobuf and blas are not installed a prior</li>
-<li><code class="docutils literal notranslate"><span class="pre">USE_CUDA=ON</span></code>, used if CUDA and cuDNN is available</li>
-<li><code class="docutils literal notranslate"><span class="pre">USE_PYTHON3=ON</span></code>, used for compiling with Python 3 support. (The default is Python 2)</li>
-<li><code class="docutils literal notranslate"><span class="pre">USE_OPENCL=ON</span></code>, used for compiling with OpenCL support</li>
-<li><code class="docutils literal notranslate"><span class="pre">USE_MKLDNN=ON</span></code>, used for compiling with Intel MKL-dnn support</li>
-<li><code class="docutils literal notranslate"><span class="pre">PACKAGE=ON</span></code>, used for building the Debian package</li>
-<li><code class="docutils literal notranslate"><span class="pre">ENABLE_TEST</span></code>, used for compiling unit test cases</li>
-</ul>
-</li>
-<li>compile the code, <code class="docutils literal notranslate"><span class="pre">make</span></code></li>
-<li>goto python folder</li>
-<li>run <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">.</span></code> or <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-e</span> <span class="pre">.</span></code> The second command creates symlinks instead of copying files into python site-package folder.</li>
-</ol>
-<p>Execute step 4 and 5 are to install PySINGA when USE_PYTHON=ON.</p>
-<p>After compiling SINGA with ENABLE_TEST=ON, you can run the unit tests by</p>
+<h2>Use native tools to build SINGA on Ubuntu<a class="headerlink" href="#use-native-tools-to-build-singa-on-ubuntu" title="Permalink to this headline">¶</a></h2>
+<p>Refer to SINGA <a class="reference external" href="https://github.com/apache/incubator-singa/blob/master/tool/docker/devel/ubuntu/cuda9/Dockerfile#L30">Dockerfiles</a>
+for the instructions of installing the dependent libraries on Ubuntu 16.04. You can also create a Docker container using the <a class="reference external" href="#">devel images</a> and build SINGA inside the container.
+To build SINGA with GPU, MKLDNN, Python and unit tests, run the following instructions</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="n">build</span> <span class="c1"># at the root of incubator-singa folder</span>
+<span class="n">cd</span> <span class="n">build</span>
+<span class="n">cmake</span> <span class="o">-</span><span class="n">DENABLE_TEST</span><span class="o">=</span><span class="n">ON</span> <span class="o">-</span><span class="n">DUSE_CUDA</span><span class="o">=</span><span class="n">ON</span> <span class="o">-</span><span class="n">DUSE_MKLDNN</span><span class="o">=</span><span class="n">ON</span> <span class="o">-</span><span class="n">DUSE_PYTHON3</span><span class="o">=</span><span class="n">ON</span> <span class="o">..</span>
+<span class="n">make</span>
+<span class="n">cd</span> <span class="n">python</span>
+<span class="n">pip</span> <span class="n">install</span> <span class="o">.</span>
+</pre></div>
+</div>
+<p>The details of the CMake options are explained in the last section of this page.
+The last command install the Python package. You can also run <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-e</span> <span class="pre">.</span></code>, which creates symlinks instead of copying the Python files into the site-package folder.</p>
+<p>If SINGA is compiled with ENABLE_TEST=ON, you can run the unit tests by</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./bin/test_singa
</pre></div>
</div>
<p>You can see all the testing cases with testing results. If SINGA passes all
tests, then you have successfully installed SINGA.</p>
</div>
+<div class="section" id="use-native-tools-to-build-singa-on-centos7">
+<h2>Use native tools to Build SINGA on Centos7<a class="headerlink" href="#use-native-tools-to-build-singa-on-centos7" title="Permalink to this headline">¶</a></h2>
+<p>Building from source will be different for Centos7 as package names differ.Follow the instructions given below.</p>
+<div class="section" id="installing-dependencies">
+<h3>Installing dependencies<a class="headerlink" href="#installing-dependencies" title="Permalink to this headline">¶</a></h3>
+<p>Basic packages/libraries</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">yum</span> <span class="n">install</span> <span class="n">freetype</span><span class="o">-</span><span class="n">devel</span> <span class="n">libXft</span><span class="o">-</span><span class="n">devel</span> <span class="n">ncurses</span><span class="o">-</span><span class="n">devel</span> <span class="n">openblas</span><span class="o">-</span><span class="n">de [...]
+</pre></div>
+</div>
+<p>For build-essential</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">yum</span> <span class="n">group</span> <span class="n">install</span> <span class="s2">"Development Tools"</span>
+</pre></div>
+</div>
+<p>For installing swig</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>sudo yum install pcre-devel
+wget http://prdownloads.sourceforge.net/swig/swig-3.0.10.tar.gz
+tar xvzf swig-3.0.10.tar.gz
+cd swig-3.0.10.tar.gz
+./configure --prefix=${RUN}
+make
+make install
+</pre></div>
+</div>
+<p>For installing gfortran</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">yum</span> <span class="n">install</span> <span class="n">centos</span><span class="o">-</span><span class="n">release</span><span class="o">-</span><span class="n">scl</span><span class="o">-</span><span class="n">rh</span>
+<span class="n">sudo</span> <span class="n">yum</span> <span class="o">--</span><span class="n">enablerepo</span><span class="o">=</span><span class="n">centos</span><span class="o">-</span><span class="n">sclo</span><span class="o">-</span><span class="n">rh</span><span class="o">-</span><span class="n">testing</span> <span class="n">install</span> <span class="n">devtoolset</span><span class="o">-</span><span class="mi">7</span><span class="o">-</span><span class="n">gcc</span><span cl [...]
+</pre></div>
+</div>
+<p>For installing pip and other packages</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">yum</span> <span class="n">install</span> <span class="n">epel</span><span class="o">-</span><span class="n">release</span>
+<span class="n">sudo</span> <span class="n">yum</span> <span class="n">install</span> <span class="n">python</span><span class="o">-</span><span class="n">pip</span>
+<span class="n">pip</span> <span class="n">install</span> <span class="n">matplotlib</span> <span class="n">numpy</span> <span class="n">pandas</span> <span class="n">scikit</span><span class="o">-</span><span class="n">learn</span> <span class="n">pydot</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="installation">
+<h3>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h3>
+<p>Follow steps 1-5 of <em>Use native tools to build SINGA on Ubuntu</em></p>
+</div>
+<div class="section" id="testing">
+<h3>Testing<a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h3>
+<p>You can run the unit tests by,</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./bin/test_singa
+</pre></div>
+</div>
+<p>You can see all the testing cases with testing results. If SINGA passes all
+tests, then you have successfully installed SINGA.</p>
+</div>
+</div>
<div class="section" id="compile-singa-on-windows">
-<span id="compile-singa-on-windows"></span><h3>Compile SINGA on Windows<a class="headerlink" href="#compile-singa-on-windows" title="Permalink to this headline">¶</a></h3>
+<h2>Compile SINGA on Windows<a class="headerlink" href="#compile-singa-on-windows" title="Permalink to this headline">¶</a></h2>
<p>Instructions for building on Windows with Python support can be found <a class="reference external" href="install_win.html">here</a>.</p>
</div>
<div class="section" id="more-details-about-the-compilation-options">
-<span id="more-details-about-the-compilation-options"></span><h3>More details about the compilation options<a class="headerlink" href="#more-details-about-the-compilation-options" title="Permalink to this headline">¶</a></h3>
-</div>
-<div class="section" id="use-modules">
-<span id="use-modules"></span><h3>USE_MODULES<a class="headerlink" href="#use-modules" title="Permalink to this headline">¶</a></h3>
+<h2>More details about the compilation options<a class="headerlink" href="#more-details-about-the-compilation-options" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="use-modules-deprecated">
+<h3>USE_MODULES (deprecated)<a class="headerlink" href="#use-modules-deprecated" title="Permalink to this headline">¶</a></h3>
<p>If protobuf and openblas are not installed, you can compile SINGA together with them</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ In SINGA ROOT folder
$ mkdir build
@@ -365,9 +366,10 @@ the following environment variables</p>
<span class="n">export</span> <span class="n">CMAKE_LIBRARY_PATH</span><span class="o">=<</span><span class="n">path</span> <span class="n">to</span> <span class="n">the</span> <span class="n">lib</span> <span class="n">file</span> <span class="n">folder</span><span class="o">></span>
</pre></div>
</div>
+</div>
<div class="section" id="use-python">
-<span id="use-python"></span><h4>USE_PYTHON<a class="headerlink" href="#use-python" title="Permalink to this headline">¶</a></h4>
-<p>Similar to compile CPP code, PySINGA is compiled by</p>
+<h3>USE_PYTHON<a class="headerlink" href="#use-python" title="Permalink to this headline">¶</a></h3>
+<p>Option for compiling the Python wrapper for SINGA,</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cmake -DUSE_PYTHON=ON ..
$ make
$ cd python
@@ -376,11 +378,11 @@ $ pip install .
</div>
</div>
<div class="section" id="use-cuda">
-<span id="use-cuda"></span><h4>USE_CUDA<a class="headerlink" href="#use-cuda" title="Permalink to this headline">¶</a></h4>
+<h3>USE_CUDA<a class="headerlink" href="#use-cuda" title="Permalink to this headline">¶</a></h3>
<p>Users are encouraged to install the CUDA and
<a class="reference external" href="https://developer.nvidia.com/cudnn">cuDNN</a> for running SINGA on GPUs to
get better performance.</p>
-<p>SINGA has been tested over CUDA 9, and cuDNN 7. If cuDNN is
+<p>SINGA has been tested over CUDA 9/10, and cuDNN 7. If cuDNN is
installed into non-system folder, e.g. /home/bob/local/cudnn/, the following
commands should be executed for cmake and the runtime to find it</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ export CMAKE_INCLUDE_PATH=/home/bob/local/cudnn/include:$CMAKE_INCLUDE_PATH
@@ -395,8 +397,20 @@ $ make
</pre></div>
</div>
</div>
+<div class="section" id="use-mkldnn">
+<h3>USE_MKLDNN<a class="headerlink" href="#use-mkldnn" title="Permalink to this headline">¶</a></h3>
+<p>User can enable MKL-DNN to enhance the performance of CPU computation.</p>
+<p>Installation guide of MKL-DNN could be found <a class="reference external" href="https://github.com/intel/mkl-dnn#installation">here</a>.</p>
+<p>SINGA has been tested over MKL-DNN v0.17.2.</p>
+<p>To build SINGA with MKL-DNN support:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># Dependent libs are installed already
+$ cmake -DUSE_MKLDNN=ON ..
+$ make
+</pre></div>
+</div>
+</div>
<div class="section" id="use-opencl">
-<span id="use-opencl"></span><h4>USE_OPENCL<a class="headerlink" href="#use-opencl" title="Permalink to this headline">¶</a></h4>
+<h3>USE_OPENCL<a class="headerlink" href="#use-opencl" title="Permalink to this headline">¶</a></h3>
<p>SINGA uses opencl-headers and viennacl (version 1.7.1 or newer) for OpenCL support, which
can be installed using via</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># On Ubuntu 16.04
@@ -407,9 +421,9 @@ $ sudo yum install opencl-headers, viennacl
</div>
<p>Additionally, you will need the OpenCL Installable Client Driver (ICD) for the platforms that you want to run OpenCL on.</p>
<ul class="simple">
-<li>For AMD and nVidia GPUs, the driver package should also install the correct OpenCL ICD.</li>
-<li>For Intel CPUs and/or GPUs, get the driver from the <a class="reference external" href="https://software.intel.com/en-us/articles/opencl-drivers">Intel website.</a> Note that the drivers provided on that website only supports recent CPUs and Iris GPUs.</li>
-<li>For older Intel CPUs, you can use the <code class="docutils literal notranslate"><span class="pre">beignet-opencl-icd</span></code> package.</li>
+<li><p>For AMD and nVidia GPUs, the driver package should also install the correct OpenCL ICD.</p></li>
+<li><p>For Intel CPUs and/or GPUs, get the driver from the <a class="reference external" href="https://software.intel.com/en-us/articles/opencl-drivers">Intel website.</a> Note that the drivers provided on that website only supports recent CPUs and Iris GPUs.</p></li>
+<li><p>For older Intel CPUs, you can use the <code class="docutils literal notranslate"><span class="pre">beignet-opencl-icd</span></code> package.</p></li>
</ul>
<p>Note that running OpenCL on CPUs is not currently recommended because it is slow.
Memory transfer is on the order of whole seconds (1000’s of ms on CPUs as compared to 1’s of ms on GPUs).</p>
@@ -423,20 +437,8 @@ $ make
</pre></div>
</div>
</div>
-<div class="section" id="use-mkldnn">
-<span id="use-mkldnn"></span><h4>USE_MKLDNN<a class="headerlink" href="#use-mkldnn" title="Permalink to this headline">¶</a></h4>
-<p>User can enable MKL-DNN to enhance the performance of CPU computation.</p>
-<p>Installation guide of MKL-DNN could be found <a class="reference external" href="https://github.com/intel/mkl-dnn#installation">here</a>.</p>
-<p>SINGA has been tested over MKL-DNN v0.17.2.</p>
-<p>To build SINGA with MKL-DNN support:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># Dependent libs are installed already
-$ cmake -DUSE_MKLDNN=ON ..
-$ make
-</pre></div>
-</div>
-</div>
<div class="section" id="package">
-<span id="package"></span><h4>PACKAGE<a class="headerlink" href="#package" title="Permalink to this headline">¶</a></h4>
+<h3>PACKAGE<a class="headerlink" href="#package" title="Permalink to this headline">¶</a></h3>
<p>This setting is used to build the Debian package. Set PACKAGE=ON and build the package with make command like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cmake -DPACKAGE=ON
$ make package
@@ -444,24 +446,18 @@ $ make package
</div>
</div>
</div>
-</div>
<div class="section" id="faq">
-<span id="faq"></span><h2>FAQ<a class="headerlink" href="#faq" title="Permalink to this headline">¶</a></h2>
+<h2>FAQ<a class="headerlink" href="#faq" title="Permalink to this headline">¶</a></h2>
<ul>
-<li><p class="first">Q: Error from ‘import singa’ using PySINGA installed from wheel.</p>
-<p>A: Please check the detailed error from <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-c</span> <span class="pre">"from</span> <span class="pre">singa</span> <span class="pre">import</span> <span class="pre">_singa_wrap"</span></code>. Sometimes it is
-caused by the dependent libraries, e.g. there are multiple versions of protobuf, missing of cudnn, numpy version mismatch. Following
-steps show the solutions for different cases</p>
+<li><p>Q: Error from ‘import singa’</p>
+<p>A: Please check the detailed error from <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-c</span>  <span class="pre">"from</span> <span class="pre">singa</span> <span class="pre">import</span> <span class="pre">_singa_wrap"</span></code>. Sometimes it is caused by the dependent libraries, e.g. there are multiple versions of protobuf, missing of cudnn, numpy version mismatch. Following steps show the solutions for different cases</p>
<ol>
-<li><p class="first">Check the cudnn and cuda and gcc versions, cudnn5 and cuda7.5 and gcc4.8/4.9 are preferred. if gcc is 5.0, then downgrade it.
-If cudnn is missing or not match with the wheel version, you can download the correct version of cudnn into ~/local/cudnn/ and</p>
+<li><p>Check the cudnn and cuda. If cudnn is missing or not match with the wheel version, you can download the correct version of cudnn into ~/local/cudnn/ and</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ echo "export LD_LIBRARY_PATH=/home/<yourname>/local/cudnn/lib64:$LD_LIBRARY_PATH" >> ~/.bashrc
</pre></div>
</div>
</li>
-<li><p class="first">If it is the problem related to protobuf, then download the newest whl files which have <a class="reference external" href="https://issues.apache.org/jira/browse/SINGA-255">compiled protobuf and openblas into the whl</a> file of PySINGA.
-Or you can install protobuf from source into a local folder, say ~/local/;
-Decompress the tar file, and then</p>
+<li><p>If it is the problem related to protobuf. You can install protobuf (3.6.1) from source into a local folder, say ~/local/; Decompress the tar file, and then</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ ./configure --prefix=/home/<yourname>local
$ make && make install
$ echo "export LD_LIBRARY_PATH=/home/<yourname>/local/lib:$LD_LIBRARY_PATH" >> ~/.bashrc
@@ -469,9 +465,8 @@ Decompress the tar file, and then</p>
</pre></div>
</div>
</li>
-<li><p class="first">If it cannot find other libs including python, then create virtual env using pip or conda;</p>
-</li>
-<li><p class="first">If it is not caused by the above reasons, go to the folder of <code class="docutils literal notranslate"><span class="pre">_singa_wrap.so</span></code>,</p>
+<li><p>If it cannot find other libs including python, then create virtual env using pip or conda;</p></li>
+<li><p>If it is not caused by the above reasons, go to the folder of <code class="docutils literal notranslate"><span class="pre">_singa_wrap.so</span></code>,</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ python
>> import importlib
>> importlib.import_module('_singa_wrap')
@@ -487,9 +482,7 @@ Decompress the tar file, and then</p>
</pre></div>
</div>
</li>
-</ul>
-<ul>
-<li><p class="first">Q: Error from running <code class="docutils literal notranslate"><span class="pre">cmake</span> <span class="pre">..</span></code>, which cannot find the dependent libraries.</p>
+<li><p>Q: Error from running <code class="docutils literal notranslate"><span class="pre">cmake</span> <span class="pre">..</span></code>, which cannot find the dependent libraries.</p>
<p>A: If you haven’t installed the libraries, install them. If you installed
the libraries in a folder that is outside of the system folder, e.g. /usr/local,
you need to export the following variables</p>
@@ -498,9 +491,7 @@ you need to export the following variables</p>
</pre></div>
</div>
</li>
-</ul>
-<ul>
-<li><p class="first">Q: Error from <code class="docutils literal notranslate"><span class="pre">make</span></code>, e.g. the linking phase</p>
+<li><p>Q: Error from <code class="docutils literal notranslate"><span class="pre">make</span></code>, e.g. the linking phase</p>
<p>A: If your libraries are in other folders than system default paths, you need
to export the following varaibles</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ export LIBRARY_PATH=<path to your lib file folder>
@@ -508,22 +499,20 @@ to export the following varaibles</p>
</pre></div>
</div>
</li>
-</ul>
-<ul>
-<li><p class="first">Q: Error from header files, e.g. ‘cblas.h no such file or directory exists’</p>
+<li><p>Q: Error from header files, e.g. ‘cblas.h no such file or directory exists’</p>
<p>A: You need to include the folder of the cblas.h into CPLUS_INCLUDE_PATH,
e.g.,</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ export CPLUS_INCLUDE_PATH=/opt/OpenBLAS/include:$CPLUS_INCLUDE_PATH
</pre></div>
</div>
</li>
-<li><p class="first">Q:While compiling SINGA, I get error <code class="docutils literal notranslate"><span class="pre">SSE2</span> <span class="pre">instruction</span> <span class="pre">set</span> <span class="pre">not</span> <span class="pre">enabled</span></code></p>
+<li><p>Q:While compiling SINGA, I get error <code class="docutils literal notranslate"><span class="pre">SSE2</span> <span class="pre">instruction</span> <span class="pre">set</span> <span class="pre">not</span> <span class="pre">enabled</span></code></p>
<p>A:You can try following command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ make CFLAGS='-msse2' CXXFLAGS='-msse2'
</pre></div>
</div>
</li>
-<li><p class="first">Q:I get <code class="docutils literal notranslate"><span class="pre">ImportError:</span> <span class="pre">cannot</span> <span class="pre">import</span> <span class="pre">name</span> <span class="pre">enum_type_wrapper</span></code> from google.protobuf.internal when I try to import .py files.</p>
+<li><p>Q:I get <code class="docutils literal notranslate"><span class="pre">ImportError:</span> <span class="pre">cannot</span> <span class="pre">import</span> <span class="pre">name</span> <span class="pre">enum_type_wrapper</span></code> from google.protobuf.internal when I try to import .py files.</p>
<p>A: You need to install the python binding of protobuf, which could be installed via</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ sudo apt-get install protobuf
</pre></div>
@@ -536,7 +525,7 @@ e.g.,</p>
</pre></div>
</div>
</li>
-<li><p class="first">Q: When I build OpenBLAS from source, I am told that I need a Fortran compiler.</p>
+<li><p>Q: When I build OpenBLAS from source, I am told that I need a Fortran compiler.</p>
<p>A: You can compile OpenBLAS by</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ make ONLY_CBLAS=1
</pre></div>
@@ -546,7 +535,7 @@ e.g.,</p>
</pre></div>
</div>
</li>
-<li><p class="first">Q: When I build protocol buffer, it reports that GLIBC++_3.4.20 not found in /usr/lib64/libstdc++.so.6.</p>
+<li><p>Q: When I build protocol buffer, it reports that GLIBC++_3.4.20 not found in /usr/lib64/libstdc++.so.6.</p>
<p>A: This means the linker found libstdc++.so.6 but that library
belongs to an older version of GCC than was used to compile and link the
program. The program depends on code defined in
@@ -563,7 +552,7 @@ following command,</p>
</pre></div>
</div>
</li>
-<li><p class="first">Q: When I build glog, it reports that “src/logging_unittest.cc:83:20: error: ‘gflags’ is not a namespace-name”</p>
+<li><p>Q: When I build glog, it reports that “src/logging_unittest.cc:83:20: error: ‘gflags’ is not a namespace-name”</p>
<p>A: It maybe that you have installed gflags with a different namespace such as “google”. so glog can’t find ‘gflags’ namespace.
Because it is not necessary to have gflags to build glog. So you can change the configure.ac file to ignore gflags.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="mf">1.</span> <span class="n">cd</span> <span class="n">to</span> <span class="n">glog</span> <span class="n">src</span> <span class="n">directory</span>
@@ -573,17 +562,17 @@ Because it is not necessary to have gflags to build glog. So you can change the
</div>
<p>After this, you can build glog again.</p>
</li>
-<li><p class="first">Q: When using virtual environment, everytime I run pip install, it would reinstall numpy. However, the numpy would not be used when I <code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">numpy</span></code></p>
+<li><p>Q: When using virtual environment, every time I run pip install, it would reinstall numpy. However, the numpy would not be used when I <code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">numpy</span></code></p>
<p>A: It could be caused by the <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code> which should be set to empty when you are using virtual environment to avoid the conflicts with the path of
the virtual environment.</p>
</li>
-<li><p class="first">Q: When compiling PySINGA from source, there is a compilation error due to the missing of <numpy/objectarray.h></p>
+<li><p>Q: When compiling PySINGA from source, there is a compilation error due to the missing of <numpy/objectarray.h></p>
<p>A: Please install numpy and export the path of numpy header files as</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ export CPLUS_INCLUDE_PATH=`python -c "import numpy; print numpy.get_include()"`:$CPLUS_INCLUDE_PATH
</pre></div>
</div>
</li>
-<li><p class="first">Q: When I run PySINGA in Mac OS X, I got the error “Fatal Python error: PyThreadState_Get: no current thread Abort trap: 6”</p>
+<li><p>Q: When I run SINGA in Mac OS X, I got the error “Fatal Python error: PyThreadState_Get: no current thread Abort trap: 6”</p>
<p>A: This error happens typically when you have multiple version of Python on your system and you installed SINGA via pip (this problem is resolved for installation via conda),
e.g, the one comes with the OS and the one installed by Homebrew. The Python linked by PySINGA must be the same as the Python interpreter.
You can check your interpreter by <code class="docutils literal notranslate"><span class="pre">which</span> <span class="pre">python</span></code> and check the Python linked by PySINGA via <code class="docutils literal notranslate"><span class="pre">otool</span> <span class="pre">-L</span> <span class="pre"><path</span> <span class="pre">to</span> <span class="pre">_singa_wrap.so></span></code>.
@@ -604,21 +593,12 @@ In particular, if you build PySINGA from source, you need to specify the paths w
</div>
<footer>
- <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-
- <a href="software_stack.html" class="btn btn-neutral float-right" title="Software Stack" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
-
-
- <a href="index.html" class="btn btn-neutral" title="Documentation" 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..
+ © 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>
@@ -635,36 +615,17 @@ In particular, if you build PySINGA from source, you need to specify the paths w
-
-
- <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>
@@ -674,8 +635,8 @@ In particular, if you build PySINGA from source, you need to specify the paths w
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -684,8 +645,14 @@ In particular, if you build PySINGA from source, you need to specify the paths w
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/develop/contribute-code.html b/en/develop/contribute-code.html
index f4723a1..29d9cd9 100644
--- a/en/develop/contribute-code.html
+++ b/en/develop/contribute-code.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>How to Contribute Code — incubator-singa 1.1.0 documentation</title>
+ <title>How to Contribute Code — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,28 @@
-
-
+ <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="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="How to Contribute to Documentation" href="contribute-docs.html" />
- <link rel="prev" title="How to Contribute to SINGA" href="how-contribute.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="prev" title="Security" href="../security.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 {
@@ -44,21 +50,16 @@
}
</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" >
@@ -67,7 +68,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +83,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -102,16 +103,15 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../docs/index.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="schedule.html">Development Schedule</a></li>
-<li class="toctree-l1"><a class="reference internal" href="how-contribute.html">How to Contribute to SINGA</a></li>
-<li class="toctree-l1"><a class="reference internal" href="how-contribute.html#how-to-become-a-singa-committer">How to become a SINGA committer</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">How to Contribute Code</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#coding-style">Coding Style</a></li>
<li class="toctree-l2"><a class="reference internal" href="#jira-format">JIRA format</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#pull-request">Pull Request</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#git-workflow">Git Workflow</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#developing-environment">Developing Environment</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contribute-docs.html">How to Contribute to Documentation</a></li>
@@ -192,72 +192,102 @@
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<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">licenses</span><span class="o">/</span><span class="n">LICENSE</span><span class="o">-</span><span [...]
-
-<span class="n">Unless</span> <span class="n">required</span> <span class="n">by</span> <span class="n">applicable</span> <span class="n">law</span> <span class="ow">or</span> <span class="n">agreed</span> <span class="n">to</span> <span class="ow">in</span> <span class="n">writing</span><span class="p">,</span>
-<span class="n">software</span> <span class="n">distributed</span> <span class="n">under</span> <span class="n">the</span> <span class="n">License</span> <span class="ow">is</span> <span class="n">distributed</span> <span class="n">on</span> <span class="n">an</span>
-<span class="s2">"AS IS"</span> <span class="n">BASIS</span><span class="p">,</span> <span class="n">WITHOUT</span> <span class="n">WARRANTIES</span> <span class="n">OR</span> <span class="n">CONDITIONS</span> <span class="n">OF</span> <span class="n">ANY</span>
-<span class="n">KIND</span><span class="p">,</span> <span class="n">either</span> <span class="n">express</span> <span class="ow">or</span> <span class="n">implied</span><span class="o">.</span> <span class="n">See</span> <span class="n">the</span> <span class="n">License</span> <span class="k">for</span> <span class="n">the</span>
-<span class="n">specific</span> <span class="n">language</span> <span class="n">governing</span> <span class="n">permissions</span> <span class="ow">and</span> <span class="n">limitations</span>
-<span class="n">under</span> <span class="n">the</span> <span class="n">License</span><span class="o">.</span>
-</pre></div>
-</div>
-<p>–></p>
-<div class="section" id="how-to-contribute-code">
-<span id="how-to-contribute-code"></span><h1>How to Contribute Code<a class="headerlink" href="#how-to-contribute-code" title="Permalink to this headline">¶</a></h1>
+ 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="how-to-contribute-code">
+<h1>How to Contribute Code<a class="headerlink" href="#how-to-contribute-code" title="Permalink to this headline">¶</a></h1>
<div class="section" id="coding-style">
-<span id="coding-style"></span><h2>Coding Style<a class="headerlink" href="#coding-style" title="Permalink to this headline">¶</a></h2>
-<p>The SINGA codebase follows the <a class="reference external" href="http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml">Google C++ Style Guide</a>.</p>
-<p>To check if your code follows the style, you can use the provided cpplint tool:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./tool/cpplint.py YOUR_FILE
+<h2>Coding Style<a class="headerlink" href="#coding-style" title="Permalink to this headline">¶</a></h2>
+<p>The SINGA codebase follows the Google Style for both <a class="reference external" href="http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml">CPP</a> and <a class="reference external" href="http://google.github.io/styleguide/pyguide.html">Python</a> code.</p>
+<p>A simple way to enforce the Google coding styles is to use the linting and formating tools in the Visual Studio Code editor:</p>
+<ul class="simple">
+<li><p><a class="reference external" href="https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools">C/C++ extension</a></p></li>
+<li><p><a class="reference external" href="https://marketplace.visualstudio.com/items?itemName=ms-python.python">Python extension</a></p></li>
+</ul>
+<p>Once the extensions are installed, edit the settings.json file.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">"editor.formatOnSave"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+<span class="s2">"python.formatting.provider"</span><span class="p">:</span> <span class="s2">"yapf"</span><span class="p">,</span>
+<span class="s2">"python.formatting.yapfArgs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"--style"</span><span class="p">,</span>
+ <span class="s2">"{based_on_style: google}"</span>
+<span class="p">],</span>
+<span class="s2">"python.linting.enabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+<span class="s2">"python.linting.lintOnSave"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+<span class="s2">"C_Cpp.clang_format_style"</span><span class="p">:</span> <span class="s2">"Google"</span>
</pre></div>
</div>
+<p>You need to fix the format errors before submitting the pull requests.</p>
</div>
<div class="section" id="jira-format">
-<span id="jira-format"></span><h2>JIRA format<a class="headerlink" href="#jira-format" title="Permalink to this headline">¶</a></h2>
+<h2>JIRA format<a class="headerlink" href="#jira-format" title="Permalink to this headline">¶</a></h2>
<p>Like other Apache projects, SINGA uses JIRA to track bugs, improvements and
other high-level discussions (e.g., system design and features). Github pull requests are
used for implementation discussions, e.g., code review and code merge.</p>
<ul class="simple">
-<li>Provide a descriptive Title.</li>
-<li>Write a detailed Description. For bug reports, this should ideally include a
+<li><p>Provide a descriptive Title.</p></li>
+<li><p>Write a detailed Description. For bug reports, this should ideally include a
short reproduction of the problem. For new features, it may include a design
-document.</li>
-<li>Set <a class="reference external" href="https://cwiki.apache.org/confluence/display/SPARK/Contributing+to+Spark#ContributingtoSpark-JIRA">required fields</a></li>
+document.</p></li>
+<li><p>Set <a class="reference external" href="https://cwiki.apache.org/confluence/display/SPARK/Contributing+to+Spark#ContributingtoSpark-JIRA">required fields</a></p></li>
</ul>
</div>
-<div class="section" id="pull-request">
-<span id="pull-request"></span><h2>Pull Request<a class="headerlink" href="#pull-request" title="Permalink to this headline">¶</a></h2>
-<p>The work flow is</p>
-<ul class="simple">
-<li>Fork the <a class="reference external" href="https://github.com/apache/incubator-singa">SINGA Github repository</a> to
-your own Github account.</li>
-<li>Clone your fork, create a new branch (e.g., feature-foo or fixbug-foo),
-work on it. After finishing your job,
-<a class="reference external" href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">rebase</a> it to the
-current latest master and push commits to your own Github account (the new
-branch).</li>
-<li>Open a pull request against the master branch of apache/incubator-singa.
-The PR title should be of the form SINGA-xxxx Title, where
-SINGA-xxxx is the relevant JIRA number, and Title may be the JIRA’s title or a
-more specific title describing the PR itself, for example, “SINGA-6 Implement thread-safe singleton”. Detailed description can be copied from the JIRA.
-Consider identifying committers or other contributors who have worked on the
-code being changed. Find the file(s) in Github and click “Blame” to see a
-line-by-line annotation of who changed the code last. You can add @username in
-the PR description to ping them immediately.
-Please state that the contribution is your original work and that you license
-the work to the project under the project’s open source license. Further commits (e.g., bug fix)
-to your new branch will be added to this pull request automatically by Github.</li>
-<li>Wait for one committer to review the patch. If no conflicts, the committers will merge it with
-the master branch. The merge should a) not use rebase b) disable fast forward merge c) check the
-commit message format and test the code/feature.</li>
-<li>If there are too many small commit messages, you will be told to squash your commits into fewer meaningful
-commits. If your commit message does not follow the format (i.e., SINGA-xxxx), you will be told to
-reword your commit message. Both changes can be done using interactive git rebase. Once you
-get the commits corrected, push them to you own github again. Your pull request
-will be automatically updated. For details, please refer to
-<a class="reference external" href="https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request">Rebase Pull Requests</a>.</li>
-</ul>
+<div class="section" id="git-workflow">
+<h2>Git Workflow<a class="headerlink" href="#git-workflow" title="Permalink to this headline">¶</a></h2>
+<ol>
+<li><p>Fork the <a class="reference external" href="https://github.com/apache/incubator-singa">SINGA Github repository</a> to your own Github account.</p></li>
+<li><p>Clone the <strong>repo</strong> (short for repository) from your Github</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/<</span><span class="n">Github</span> <span class="n">account</span><span class="o">>/</span><span class="n">incubator</span><span class="o">-</span><span class="n">singa</s [...]
+<span class="n">git</span> <span class="n">remote</span> <span class="n">add</span> <span class="n">apache</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">apache</span><span class="o">/</span><span class="n">incubator</span><span class="o">-</span><span class="n">singa</span><span class="o">.</span><span class="n">git</span>
+</pre></div>
+</div>
+</li>
+<li><p>Create a new branch (e.g., <code class="docutils literal notranslate"><span class="pre">feature-foo</span></code> or <code class="docutils literal notranslate"><span class="pre">fixbug-foo</span></code>), work on it and commit your code.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">checkout</span> <span class="o">-</span><span class="n">b</span> <span class="n">feature</span><span class="o">-</span><span class="n">foo</span>
+<span class="c1"># write your code</span>
+<span class="n">git</span> <span class="n">add</span> <span class="o"><</span><span class="n">created</span><span class="o">/</span><span class="n">updated</span> <span class="n">files</span><span class="o">></span>
+<span class="n">git</span> <span class="n">commit</span>
+</pre></div>
+</div>
+<p>The commit message should have a <strong>title which consists of the JIRA ticket No (SINGA-xxx) and title</strong>. A brief description of the commit should be added in the commit message.</p>
+<p>If your branch has many small commits, you need to clean those commits via</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">rebase</span> <span class="o">-</span><span class="n">i</span> <span class="o"><</span><span class="n">commit</span> <span class="nb">id</span><span class="o">></span>
+</pre></div>
+</div>
+<p>You can <a class="reference external" href="https://help.github.com/en/articles/about-git-rebase">squash and reword</a> the commits.</p>
+</li>
+<li><p>When you are working on the code, the <code class="docutils literal notranslate"><span class="pre">master</span></code> of SINGA may have been updated by others; In this case, you need to pull the latest master</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">checkout</span> <span class="n">master</span>
+<span class="n">git</span> <span class="n">pull</span> <span class="n">apache</span> <span class="n">master</span><span class="p">:</span><span class="n">master</span>
+<span class="n">git</span> <span class="n">checkout</span> <span class="n">feature</span><span class="o">-</span><span class="n">foo</span>
+</pre></div>
+</div>
+</li>
+<li><p><a class="reference external" href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">Rebase</a> <code class="docutils literal notranslate"><span class="pre">feature-foo</span></code> onto the <code class="docutils literal notranslate"><span class="pre">master</span></code> branch and push commits to your own Github account (the new branch).</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">rebase</span> <span class="n">master</span>
+<span class="n">git</span> <span class="n">push</span> <span class="n">origin</span> <span class="n">feature</span><span class="o">-</span><span class="n">foo</span><span class="p">:</span><span class="n">feature</span><span class="o">-</span><span class="n">foo</span>
+</pre></div>
+</div>
+</li>
+<li><p>Open a pull request (PR) against the master branch of apache/incubator-singa on Github website. The PR title should be the JIRA ticket title. If you want to inform other contributors who worked on the same files, you can find the file(s) on Github and click “Blame” to see a line-by-line annotation of who changed the code last. Then, you can add @username in the PR description to ping them immediately. Please state that the contribution is your original work and that you licen [...]
+<li><p>Wait for committers to review the PR. If no conflicts and errors, the committers will merge it with the master branch. The merge should <strong>a) not use rebase b) disable fast forward merge c) check the commit message format and test the code/feature</strong>. During this time, the master of SINGA may have been updated by others, and then you need to <a class="reference external" href="https://docs.fast.ai/dev/git.html#how-to-keep-your-feature-branch-up-to-date">merge the latest [...]
+</ol>
+</div>
+<div class="section" id="developing-environment">
+<h2>Developing Environment<a class="headerlink" href="#developing-environment" title="Permalink to this headline">¶</a></h2>
+<p>Visual Studio Code is recommended as the editor. Extensions like Python, C/C++, Code Spell Checker, autoDocstring, vim, Remote Development could be installed. A reference configuration (i.e., <code class="docutils literal notranslate"><span class="pre">settings.json</span></code>) of these extensions is <a class="reference external" href="https://gist.github.com/nudles/3d23cfb6ffb30ca7636c45fe60278c55">here</a>.</p>
+<p>If you update the CPP code, you need to recompile SINGA <a class="reference internal" href="build.html"><span class="doc">from source</span></a>. It is recommended to use the native building tools in the <code class="docutils literal notranslate"><span class="pre">*-devel</span></code> Docker images or <code class="docutils literal notranslate"><span class="pre">conda</span> <span class="pre">build</span></code>.</p>
+<p>If you only update the Python code, you can install SINGAS once, and then copy the updated Python files to replace those in the Python installation folder,</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cp</span> <span class="n">python</span><span class="o">/</span><span class="n">singa</span><span class="o">/</span><span class="n">xx</span><span class="o">.</span><span class="n">py</span> <span class="o"><</span><span class="n">path</span> <span class="n">to</span> <span class="n">conda</span><span class="o">>/</span><span class="n">lib</span><span class="o">/</span><span class="n [...]
+</pre></div>
+</div>
</div>
</div>
@@ -272,7 +302,7 @@ will be automatically updated. For details, please refer to
<a href="contribute-docs.html" class="btn btn-neutral float-right" title="How to Contribute to Documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="how-contribute.html" class="btn btn-neutral" title="How to Contribute to SINGA" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="../security.html" class="btn btn-neutral float-left" title="Security" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -281,7 +311,7 @@ will be automatically updated. For details, please refer to
<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>
@@ -298,36 +328,17 @@ will be automatically updated. For details, please refer to
-
-
- <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>
@@ -337,8 +348,8 @@ will be automatically updated. For details, please refer to
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -347,8 +358,14 @@ will be automatically updated. For details, please refer to
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/develop/contribute-docs.html b/en/develop/contribute-docs.html
index 708b63f..bc0d84a 100644
--- a/en/develop/contribute-docs.html
+++ b/en/develop/contribute-docs.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>How to Contribute to Documentation — incubator-singa 1.1.0 documentation</title>
+ <title>How to Contribute to Documentation — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,28 @@
-
-
+ <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="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="How to prepare a release" href="how-to-release.html" />
<link rel="prev" title="How to Contribute Code" href="contribute-code.html" />
- <link href="../_static/style.css" rel="stylesheet" type="text/css">
- <!--link href="../_static/fontawesome-all.min.css" rel="stylesheet" type="text/css"-->
+ <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 {
@@ -44,21 +50,16 @@
}
</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" >
@@ -67,7 +68,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +83,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -102,16 +103,21 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../docs/index.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="schedule.html">Development Schedule</a></li>
-<li class="toctree-l1"><a class="reference internal" href="how-contribute.html">How to Contribute to SINGA</a></li>
-<li class="toctree-l1"><a class="reference internal" href="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="contribute-code.html">How to Contribute Code</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">How to Contribute to Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#website">Website</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#python-api">Python API</a></li>
<li class="toctree-l2"><a class="reference internal" href="#cpp-api">CPP API</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#using-visual-studio-code-vscode">Using Visual Studio Code (vscode)</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#preview">Preview</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#docstring-snippet">Docstring Snippet</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#spell-check">Spell Check</a></li>
+</ul>
+</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="how-to-release.html">How to prepare a release</a></li>
@@ -191,52 +197,104 @@
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<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">licenses</span><span class="o">/</span><span class="n">LICENSE</span><span class="o">-</span><span [...]
-
-<span class="n">Unless</span> <span class="n">required</span> <span class="n">by</span> <span class="n">applicable</span> <span class="n">law</span> <span class="ow">or</span> <span class="n">agreed</span> <span class="n">to</span> <span class="ow">in</span> <span class="n">writing</span><span class="p">,</span>
-<span class="n">software</span> <span class="n">distributed</span> <span class="n">under</span> <span class="n">the</span> <span class="n">License</span> <span class="ow">is</span> <span class="n">distributed</span> <span class="n">on</span> <span class="n">an</span>
-<span class="s2">"AS IS"</span> <span class="n">BASIS</span><span class="p">,</span> <span class="n">WITHOUT</span> <span class="n">WARRANTIES</span> <span class="n">OR</span> <span class="n">CONDITIONS</span> <span class="n">OF</span> <span class="n">ANY</span>
-<span class="n">KIND</span><span class="p">,</span> <span class="n">either</span> <span class="n">express</span> <span class="ow">or</span> <span class="n">implied</span><span class="o">.</span> <span class="n">See</span> <span class="n">the</span> <span class="n">License</span> <span class="k">for</span> <span class="n">the</span>
-<span class="n">specific</span> <span class="n">language</span> <span class="n">governing</span> <span class="n">permissions</span> <span class="ow">and</span> <span class="n">limitations</span>
-<span class="n">under</span> <span class="n">the</span> <span class="n">License</span><span class="o">.</span>
-</pre></div>
-</div>
-<p>–></p>
-<div class="section" id="how-to-contribute-to-documentation">
-<span id="how-to-contribute-to-documentation"></span><h1>How to Contribute to Documentation<a class="headerlink" href="#how-to-contribute-to-documentation" title="Permalink to this headline">¶</a></h1>
+ 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="how-to-contribute-to-documentation">
+<h1>How to Contribute to Documentation<a class="headerlink" href="#how-to-contribute-to-documentation" title="Permalink to this headline">¶</a></h1>
<div class="section" id="website">
-<span id="website"></span><h2>Website<a class="headerlink" href="#website" title="Permalink to this headline">¶</a></h2>
+<h2>Website<a class="headerlink" href="#website" title="Permalink to this headline">¶</a></h2>
<p>This document gives step-by-step instructions for deploying <a class="reference external" href="http://singa.incubator.apache.org">SINGA website</a>.</p>
-<p>SINGA website is built by <a class="reference external" href="http://www.sphinx-doc.org">Sphinx</a> >=1.4.4 from a source tree stored in git: https://github.com/apache/incubator-singa/tree/master/doc.</p>
+<p>SINGA website is built by <a class="reference external" href="http://www.sphinx-doc.org">Sphinx</a> from a source tree stored in the <a class="reference external" href="https://github.com/apache/incubator-singa/tree/master/doc">git repo</a>.</p>
<p>To install Sphinx:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ pip install -U Sphinx
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">U</span> <span class="n">Sphinx</span><span class="o">==</span><span class="mf">1.5</span><span class="o">.</span><span class="mi">6</span>
</pre></div>
</div>
<p>To install the markdown support for Sphinx:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ pip install recommonmark
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">recommonmark</span><span class="o">==</span><span class="mf">0.5</span><span class="o">.</span><span class="mi">0</span>
</pre></div>
</div>
<p>To install the rtd theme:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ pip install sphinx_rtd_theme
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">sphinx_rtd_theme</span><span class="o">==</span><span class="mf">0.4</span><span class="o">.</span><span class="mi">3</span>
</pre></div>
</div>
<p>You can build the website by executing the following command from the doc folder:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./build.sh html
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">build</span><span class="o">.</span><span class="n">sh</span> <span class="n">html</span>
</pre></div>
</div>
-<p>Committers can update the <a class="reference external" href="http://singa.apache.org/en/index.html">SINGA website</a> by following these steps:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cd _build
-$ svn co https://svn.apache.org/repos/asf/incubator/singa/site/trunk
-$ cp -r html/* trunk
-# svn add <newly added html files>
-$ svn commit -m "commit messages" --username <committer ID> --password <password>
+<p>Committers can update the <a class="reference external" href="http://singa.apache.org/en/index.html">SINGA website</a> by copying the updated files to the <a class="reference external" href="https://github.com/apache/incubator-singa-site">website repo</a> (suppose the site repo is ~/incubator-singa-sit)</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">_build</span>
+<span class="n">rsync</span> <span class="o">--</span><span class="n">checksum</span> <span class="o">-</span><span class="n">rvh</span> <span class="n">html</span><span class="o">/</span> <span class="o">~/</span><span class="n">incubator</span><span class="o">-</span><span class="n">singa</span><span class="o">-</span><span class="n">site</span><span class="o">/</span>
+<span class="n">cd</span> <span class="o">~/</span><span class="n">incubator</span><span class="o">-</span><span class="n">singa</span><span class="o">-</span><span class="n">site</span>
+<span class="n">git</span> <span class="n">commit</span> <span class="o">-</span><span class="n">m</span> <span class="s2">"update xxxx"</span>
+<span class="n">git</span> <span class="n">push</span>
</pre></div>
</div>
+<p>We fix the versions of the libs in order to generate the same (checksum) html file if the source file is not changed. Otherwise, everytime we build the documentation, the html file of the same source file could be different. As a result, many html files in the site repo need updating.</p>
+</div>
+<div class="section" id="python-api">
+<h2>Python API<a class="headerlink" href="#python-api" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="cpp-api">
-<span id="cpp-api"></span><h2>CPP API<a class="headerlink" href="#cpp-api" title="Permalink to this headline">¶</a></h2>
+<h2>CPP API<a class="headerlink" href="#cpp-api" title="Permalink to this headline">¶</a></h2>
<p>To generate docs, run “doxygen” from the doc folder (Doxygen >= 1.8 recommended)</p>
</div>
+<div class="section" id="using-visual-studio-code-vscode">
+<h2>Using Visual Studio Code (vscode)<a class="headerlink" href="#using-visual-studio-code-vscode" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="preview">
+<h3>Preview<a class="headerlink" href="#preview" title="Permalink to this headline">¶</a></h3>
+<p>The document files (rst and md files) can be previewed in vscode via the <a class="reference external" href="https://docs.restructuredtext.net/">reStructuredText Extension</a>.</p>
+<ol>
+<li><p>Install the extension in vscode.</p></li>
+<li><p>Install the dependent libs. All libs required to build the website should be installed (see the above instructions). In addition, there are two more libs to be installed.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">pip</span> <span class="n">install</span> <span class="n">sphinx</span><span class="o">-</span><span class="n">autobuild</span><span class="o">=</span><span class="mf">0.7</span><span class="o">.</span><span class="mi">1</span>
+ <span class="n">pip</span> <span class="n">install</span> <span class="n">doc8</span><span class="o">=</span><span class="mf">0.8</span><span class="o">.</span><span class="mi">0</span>
+</pre></div>
+</div>
+</li>
+<li><p>Configure the conf path for <code class="docutils literal notranslate"><span class="pre">restructuredtext.confPath</span></code> to the <a class="reference external" href="./conf.py">conf.py</a></p></li>
+</ol>
+</div>
+<div class="section" id="docstring-snippet">
+<h3>Docstring Snippet<a class="headerlink" href="#docstring-snippet" title="Permalink to this headline">¶</a></h3>
+<p><a class="reference external" href="https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring">autoDocstring</a> generates the docstring of functions, classes, etc. Choose the DocString Format to <code class="docutils literal notranslate"><span class="pre">google</span></code>.</p>
+</div>
+<div class="section" id="spell-check">
+<h3>Spell Check<a class="headerlink" href="#spell-check" title="Permalink to this headline">¶</a></h3>
+<p><a class="reference external" href="https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker">Code Spell Checker</a> can be configured to check the comments of the code, or .md and .rst files.</p>
+<p>To do spell check only for comments of Python code, add the following snippet via <code class="docutils literal notranslate"><span class="pre">File</span> <span class="pre">-</span> <span class="pre">Preferences</span> <span class="pre">-</span> <span class="pre">User</span> <span class="pre">Snippets</span> <span class="pre">-</span> <span class="pre">python.json</span></code></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">"cspell check"</span> <span class="p">:</span> <span class="p">{</span>
+<span class="s2">"prefix"</span><span class="p">:</span> <span class="s2">"cspell"</span><span class="p">,</span>
+<span class="s2">"body"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"# Directives for doing spell check only for python and c/cpp comments"</span><span class="p">,</span>
+ <span class="s2">"# cSpell:includeRegExp #.* "</span><span class="p">,</span>
+ <span class="s2">"# cSpell:includeRegExp (</span><span class="se">\"\"\"</span><span class="s2">|''')[^</span><span class="se">\1</span><span class="s2">]*</span><span class="se">\1</span><span class="s2">"</span><span class="p">,</span>
+ <span class="s2">"# cSpell: CStyleComment"</span><span class="p">,</span>
+<span class="p">],</span>
+<span class="s2">"description"</span><span class="p">:</span> <span class="s2">"# spell check only for python comments"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p>To do spell check only for comments of Cpp code, add the following snippet via <code class="docutils literal notranslate"><span class="pre">File</span> <span class="pre">-</span> <span class="pre">Preferences</span> <span class="pre">-</span> <span class="pre">User</span> <span class="pre">Snippets</span> <span class="pre">-</span> <span class="pre">cpp.json</span></code></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">"cspell check"</span> <span class="p">:</span> <span class="p">{</span>
+<span class="s2">"prefix"</span><span class="p">:</span> <span class="s2">"cspell"</span><span class="p">,</span>
+<span class="s2">"body"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"// Directive for doing spell check only for cpp comments"</span><span class="p">,</span>
+ <span class="s2">"// cSpell:includeRegExp CStyleComment"</span><span class="p">,</span>
+<span class="p">],</span>
+<span class="s2">"description"</span><span class="p">:</span> <span class="s2">"# spell check only for cpp comments"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+</div>
</div>
@@ -250,7 +308,7 @@ $ svn commit -m "commit messages" --username <committer ID> --p
<a href="how-to-release.html" class="btn btn-neutral float-right" title="How to prepare a release" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="contribute-code.html" class="btn btn-neutral" title="How to Contribute Code" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="contribute-code.html" class="btn btn-neutral float-left" title="How to Contribute Code" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -259,7 +317,7 @@ $ svn commit -m "commit messages" --username <committer ID> --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>
@@ -276,36 +334,17 @@ $ svn commit -m "commit messages" --username <committer ID> --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>
@@ -315,8 +354,8 @@ $ svn commit -m "commit messages" --username <committer ID> --p
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -325,8 +364,14 @@ $ svn commit -m "commit messages" --username <committer ID> --p
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/develop/how-contribute.html b/en/develop/how-contribute.html
index 4c393d9..6f1aaf3 100644
--- a/en/develop/how-contribute.html
+++ b/en/develop/how-contribute.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>How to Contribute to SINGA — incubator-singa 1.1.0 documentation</title>
+ <title>How to Contribute to SINGA — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,26 @@
-
-
+ <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="How to Contribute Code" href="contribute-code.html" />
- <link rel="prev" title="Development Schedule" href="schedule.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="../../_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 {
@@ -44,21 +48,16 @@
}
</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" >
@@ -67,7 +66,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +81,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -102,12 +101,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../docs/index.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
-<ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="schedule.html">Development Schedule</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">How to Contribute to SINGA</a></li>
-<li class="toctree-l1"><a class="reference internal" href="#how-to-become-a-singa-committer">How to become a SINGA committer</a></li>
+<ul>
<li class="toctree-l1"><a class="reference internal" href="contribute-code.html">How to Contribute Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribute-docs.html">How to Contribute to Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="how-to-release.html">How to prepare a release</a></li>
@@ -187,34 +184,25 @@
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<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">licenses</span><span class="o">/</span><span class="n">LICENSE</span><span class="o">-</span><span [...]
-
-<span class="n">Unless</span> <span class="n">required</span> <span class="n">by</span> <span class="n">applicable</span> <span class="n">law</span> <span class="ow">or</span> <span class="n">agreed</span> <span class="n">to</span> <span class="ow">in</span> <span class="n">writing</span><span class="p">,</span>
-<span class="n">software</span> <span class="n">distributed</span> <span class="n">under</span> <span class="n">the</span> <span class="n">License</span> <span class="ow">is</span> <span class="n">distributed</span> <span class="n">on</span> <span class="n">an</span>
-<span class="s2">"AS IS"</span> <span class="n">BASIS</span><span class="p">,</span> <span class="n">WITHOUT</span> <span class="n">WARRANTIES</span> <span class="n">OR</span> <span class="n">CONDITIONS</span> <span class="n">OF</span> <span class="n">ANY</span>
-<span class="n">KIND</span><span class="p">,</span> <span class="n">either</span> <span class="n">express</span> <span class="ow">or</span> <span class="n">implied</span><span class="o">.</span> <span class="n">See</span> <span class="n">the</span> <span class="n">License</span> <span class="k">for</span> <span class="n">the</span>
-<span class="n">specific</span> <span class="n">language</span> <span class="n">governing</span> <span class="n">permissions</span> <span class="ow">and</span> <span class="n">limitations</span>
-<span class="n">under</span> <span class="n">the</span> <span class="n">License</span><span class="o">.</span>
-</pre></div>
-</div>
-<p>–></p>
-<div class="section" id="how-to-contribute-to-singa">
-<span id="how-to-contribute-to-singa"></span><h1>How to Contribute to SINGA<a class="headerlink" href="#how-to-contribute-to-singa" title="Permalink to this headline">¶</a></h1>
+ 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="how-to-contribute-to-singa">
+<h1>How to Contribute to SINGA<a class="headerlink" href="#how-to-contribute-to-singa" title="Permalink to this headline">¶</a></h1>
<p>As with any open source project, there are several ways you can help:</p>
<ul class="simple">
-<li>Join the <a class="reference external" href="http://singa.apache.org/en/community/mail-lists.html">mailing list</a> and answer other user’s questions.</li>
-<li><a class="reference external" href="http://singa.apache.org/en/docs/installation.html">Build SINGA</a> by yourself.</li>
-<li>Report bugs, feature requests and other issues in the <a class="reference external" href="http://singa.apache.org/en/community/issue-tracking.html">issue tracking</a> application.</li>
-<li>Check SINGA’s <a class="reference external" href="http://singa.apache.org/en/develop/schedule.html">development schedule</a> and <a class="reference external" href="http://singa.apache.org/en/develop/contribute-code.html">contribute code</a> by providing patches.</li>
-<li><a class="reference external" href="http://singa.apache.org/en/develop/contribute-docs.html">Help with the documentation</a> by updating webpages that are lacking or unclear.</li>
+<li><p>Join the <a class="reference external" href="http://singa.apache.org/en/community/mail-lists.html">mailing list</a> and answer other user’s questions.</p></li>
+<li><p><a class="reference external" href="http://singa.apache.org/en/develop/contribute-docs.html">Help with the documentation</a> by updating webpages that are lacking or unclear.</p></li>
+<li><p><a class="reference external" href="http://singa.apache.org/en/develop/contribute-code.html">Contribute code to SINGA</a> by fixing errors or adding new features. <a class="reference external" href="http://singa.apache.org/en/community/issue-tracking.html">All issues are tracked</a> on the JIRA system.</p></li>
</ul>
</div>
-<div class="section" id="how-to-become-a-singa-committer">
-<span id="how-to-become-a-singa-committer"></span><h1>How to become a SINGA committer<a class="headerlink" href="#how-to-become-a-singa-committer" title="Permalink to this headline">¶</a></h1>
-<p>SINGA committers are members that have write access to SINGA code and documentation repositories. They can contribute by themselves and accept other contributions.</p>
-<p>Becoming a SINGA committer requires understanding the Apache Way and being an active member in the SINGA project. An active member participates on mailing lists, answers questions, contributes code, tests and documentation, presents SINGA in talks and seminars, verifies releases and report issues or feature requests.</p>
-<p>New committers can be suggested by current committers or PPMC members, and voted upon by the PPMC according to Apache guidelines. You can start by talking to other committers and ask for their advice and guidance.</p>
-</div>
</div>
@@ -222,21 +210,12 @@
</div>
<footer>
- <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-
- <a href="contribute-code.html" class="btn btn-neutral float-right" title="How to Contribute Code" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
-
-
- <a href="schedule.html" class="btn btn-neutral" title="Development Schedule" 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..
+ © 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>
@@ -253,36 +232,17 @@
-
-
- <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>
@@ -292,8 +252,8 @@
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -302,8 +262,14 @@
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/develop/how-to-release.html b/en/develop/how-to-release.html
index 62b3655..b9019bf 100644
--- a/en/develop/how-to-release.html
+++ b/en/develop/how-to-release.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>How to prepare a release — incubator-singa 1.1.0 documentation</title>
+ <title>How to prepare a release — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,28 @@
-
-
+ <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="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="Source Repository" href="../community/source-repository.html" />
<link rel="prev" title="How to Contribute to Documentation" href="contribute-docs.html" />
- <link href="../_static/style.css" rel="stylesheet" type="text/css">
- <!--link href="../_static/fontawesome-all.min.css" rel="stylesheet" type="text/css"-->
+ <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 {
@@ -44,21 +50,16 @@
}
</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" >
@@ -67,7 +68,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +83,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -102,12 +103,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../docs/index.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="schedule.html">Development Schedule</a></li>
-<li class="toctree-l1"><a class="reference internal" href="how-contribute.html">How to Contribute to SINGA</a></li>
-<li class="toctree-l1"><a class="reference internal" href="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="contribute-code.html">How to Contribute Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribute-docs.html">How to Contribute to Documentation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">How to prepare a release</a><ul>
@@ -204,16 +203,15 @@
<div class="section" id="select-a-release-manager">
<h2>Select a release manager<a class="headerlink" href="#select-a-release-manager" title="Permalink to this headline">¶</a></h2>
<p>The release manager (RM) is the coordinator for the release process. It is the RM’s signature (.asc) that is uploaded together with the release. The RM generates KEY (RSA 4096-bit) and uploads it to a public key server. The RM needs to get his key endorsed (signed) by other Apache user, to be connected to the web of trust. He should first ask the mentor to help signing his key. <a class="reference external" href="http://www.apache.org/dev/release-signing.html">http://www.apache.org/de [...]
-<dl class="docutils">
-<dt>Check:</dt>
-<dd><ul class="first last simple">
-<li>The codebase does not include third-party code which is not compatible to APL</li>
-<li>The dependencies are compatible with APL. GNU-like licenses are NOT compatible</li>
-<li>All source files written by us MUST include the Apache license header: <a class="reference external" href="http://www.apache.org/legal/src-headers.html">http://www.apache.org/legal/src-headers.html</a>. There’s a script in there which helps propagating the header to all files.</li>
-<li>The build process is error-free.</li>
-<li>Unit tests are included (as much as possible)</li>
-<li>The Jupyter notebooks are working with the new release</li>
-<li>The online documentation on the Apache website is up to date.</li>
+<dl class="simple">
+<dt>Check:</dt><dd><ul class="simple">
+<li><p>The codebase does not include third-party code which is not compatible to APL</p></li>
+<li><p>The dependencies are compatible with APL. GNU-like licenses are NOT compatible</p></li>
+<li><p>All source files written by us MUST include the Apache license header: <a class="reference external" href="http://www.apache.org/legal/src-headers.html">http://www.apache.org/legal/src-headers.html</a>. There’s a script in there which helps propagating the header to all files.</p></li>
+<li><p>The build process is error-free.</p></li>
+<li><p>Unit tests are included (as much as possible)</p></li>
+<li><p>The Jupyter notebooks are working with the new release</p></li>
+<li><p>The online documentation on the Apache website is up to date.</p></li>
</ul>
</dd>
</dl>
@@ -226,9 +224,9 @@
<h2>Prepare NOTICE file<a class="headerlink" href="#prepare-notice-file" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><ul class="simple">
-<li>Use this template: <a class="reference external" href="http://apache.org/legal/src-headers.html#notice">http://apache.org/legal/src-headers.html#notice</a></li>
-<li>If we include any third party code in the release package which is not APL, must state it at the end of the NOTICE file.</li>
-<li>Example: <a class="reference external" href="http://apache.org/licenses/example-NOTICE.txt">http://apache.org/licenses/example-NOTICE.txt</a></li>
+<li><p>Use this template: <a class="reference external" href="http://apache.org/legal/src-headers.html#notice">http://apache.org/legal/src-headers.html#notice</a></p></li>
+<li><p>If we include any third party code in the release package which is not APL, must state it at the end of the NOTICE file.</p></li>
+<li><p>Example: <a class="reference external" href="http://apache.org/licenses/example-NOTICE.txt">http://apache.org/licenses/example-NOTICE.txt</a></p></li>
</ul>
</div></blockquote>
</div>
@@ -236,8 +234,8 @@
<h2>Prepare RELEASE_NOTES file<a class="headerlink" href="#prepare-release-notes-file" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><ul class="simple">
-<li>Introduction, Features, Bugs (link to JIRA), Changes (N/A for first erlease), Dependency list, Incompatibility issues.</li>
-<li>Follow this example: <a class="reference external" href="http://commons.apache.org/proper/commons-digester/commons-digester-3.0/RELEASE-NOTES.txt">http://commons.apache.org/proper/commons-digester/commons-digester-3.0/RELEASE-NOTES.txt</a></li>
+<li><p>Introduction, Features, Bugs (link to JIRA), Changes (N/A for first erlease), Dependency list, Incompatibility issues.</p></li>
+<li><p>Follow this example: <a class="reference external" href="http://commons.apache.org/proper/commons-digester/commons-digester-3.0/RELEASE-NOTES.txt">http://commons.apache.org/proper/commons-digester/commons-digester-3.0/RELEASE-NOTES.txt</a></p></li>
</ul>
</div></blockquote>
</div>
@@ -245,9 +243,9 @@
<h2>Prepare README file<a class="headerlink" href="#prepare-readme-file" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><ul class="simple">
-<li>How to build, run test, run examples</li>
-<li>List of dependencies.</li>
-<li>Mail list, website, etc. Any information useful for user to start.</li>
+<li><p>How to build, run test, run examples</p></li>
+<li><p>List of dependencies.</p></li>
+<li><p>Mail list, website, etc. Any information useful for user to start.</p></li>
</ul>
</div></blockquote>
</div>
@@ -255,35 +253,33 @@
<h2>Prepare DISCLAIMER file<a class="headerlink" href="#prepare-disclaimer-file" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><ul class="simple">
-<li>modify from <a class="reference external" href="http://incubator.apache.org/guides/branding.html#disclaimers">http://incubator.apache.org/guides/branding.html#disclaimers</a></li>
+<li><p>modify from <a class="reference external" href="http://incubator.apache.org/guides/branding.html#disclaimers">http://incubator.apache.org/guides/branding.html#disclaimers</a></p></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="package-the-release">
<h2>Package the release<a class="headerlink" href="#package-the-release" title="Permalink to this headline">¶</a></h2>
-<dl class="docutils">
-<dt>The release should be packaged into <span class="classifier-delimiter">:</span> <span class="classifier">apache-singa-incubating-xx.xx.xx.tar.gz</span></dt>
-<dd><ul class="first last simple">
-<li>src/</li>
-<li>README</li>
-<li>LICENSE</li>
-<li>NOTICE</li>
-<li>RELEASE_NOTES</li>
-<li>DISCLAIMER</li>
-<li>…</li>
+<dl class="simple">
+<dt>The release should be packaged into<span class="classifier">apache-singa-incubating-xx.xx.xx.tar.gz</span></dt><dd><ul class="simple">
+<li><p>src/</p></li>
+<li><p>README</p></li>
+<li><p>LICENSE</p></li>
+<li><p>NOTICE</p></li>
+<li><p>RELEASE_NOTES</p></li>
+<li><p>DISCLAIMER</p></li>
+<li><p>…</p></li>
</ul>
</dd>
</dl>
</div>
<div class="section" id="upload-the-release">
<h2>Upload the release<a class="headerlink" href="#upload-the-release" title="Permalink to this headline">¶</a></h2>
-<dl class="docutils">
-<dt>The release is uploaded to the RM’s Apache page: people.apache.org/~ID/…</dt>
-<dd><ul class="first last simple">
-<li>apache-singa-incubating-xx.xx.xx.tar.gz</li>
-<li>KEY</li>
-<li>XX.acs</li>
-<li>XX.md5</li>
+<dl class="simple">
+<dt>The release is uploaded to the RM’s Apache page: people.apache.org/~ID/…</dt><dd><ul class="simple">
+<li><p>apache-singa-incubating-xx.xx.xx.tar.gz</p></li>
+<li><p>KEY</p></li>
+<li><p>XX.acs</p></li>
+<li><p>XX.md5</p></li>
</ul>
</dd>
</dl>
@@ -392,7 +388,7 @@ Subject: [ANNOUNCE] Apache SINGA (incubating) X.Y.Z released</p>
<a href="../community/source-repository.html" class="btn btn-neutral float-right" title="Source Repository" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="contribute-docs.html" class="btn btn-neutral" title="How to Contribute to Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="contribute-docs.html" class="btn btn-neutral float-left" title="How to Contribute to Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -401,7 +397,7 @@ Subject: [ANNOUNCE] Apache SINGA (incubating) X.Y.Z released</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>
@@ -418,36 +414,17 @@ Subject: [ANNOUNCE] Apache SINGA (incubating) X.Y.Z released</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>
@@ -457,8 +434,8 @@ Subject: [ANNOUNCE] Apache SINGA (incubating) X.Y.Z released</p>
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -467,8 +444,14 @@ Subject: [ANNOUNCE] Apache SINGA (incubating) X.Y.Z released</p>
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/develop/schedule.html b/en/develop/schedule.html
index fd099cb..a851046 100644
--- a/en/develop/schedule.html
+++ b/en/develop/schedule.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Development Schedule — incubator-singa 1.1.0 documentation</title>
+ <title>Development Schedule — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,26 @@
-
-
+ <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="How to Contribute to SINGA" href="how-contribute.html" />
- <link rel="prev" title="Download SINGA" href="../downloads.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="../../_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 {
@@ -44,21 +48,16 @@
}
</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" >
@@ -67,7 +66,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +81,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -102,12 +101,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../docs/index.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
-<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Development Schedule</a></li>
-<li class="toctree-l1"><a class="reference internal" href="how-contribute.html">How to Contribute to SINGA</a></li>
-<li class="toctree-l1"><a class="reference internal" href="how-contribute.html#how-to-become-a-singa-committer">How to become a SINGA committer</a></li>
+<ul>
<li class="toctree-l1"><a class="reference internal" href="contribute-code.html">How to Contribute Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribute-docs.html">How to Contribute to Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="how-to-release.html">How to prepare a release</a></li>
@@ -182,182 +179,182 @@
<div class="section" id="development-schedule">
<h1>Development Schedule<a class="headerlink" href="#development-schedule" title="Permalink to this headline">¶</a></h1>
-<table border="1" class="docutils">
+<table class="docutils align-default">
<colgroup>
-<col width="33%" />
-<col width="33%" />
-<col width="33%" />
+<col style="width: 33%" />
+<col style="width: 33%" />
+<col style="width: 33%" />
</colgroup>
-<thead valign="bottom">
-<tr class="row-odd"><th class="head">Release</th>
-<th class="head">Module</th>
-<th class="head">Feature</th>
+<thead>
+<tr class="row-odd"><th class="head"><p>Release</p></th>
+<th class="head"><p>Module</p></th>
+<th class="head"><p>Feature</p></th>
</tr>
</thead>
-<tbody valign="top">
-<tr class="row-even"><td>v0.1 Sep 2015</td>
-<td>Neural Network</td>
-<td>Feed forward neural network, including CNN, MLP</td>
+<tbody>
+<tr class="row-even"><td><p>v0.1 Sep 2015</p></td>
+<td><p>Neural Network</p></td>
+<td><p>Feed forward neural network, including CNN, MLP</p></td>
</tr>
-<tr class="row-odd"><td> </td>
-<td> </td>
-<td>RBM-like model, including RBM</td>
+<tr class="row-odd"><td></td>
+<td></td>
+<td><p>RBM-like model, including RBM</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td> </td>
-<td>Recurrent neural network, including standard RNN</td>
+<tr class="row-even"><td></td>
+<td></td>
+<td><p>Recurrent neural network, including standard RNN</p></td>
</tr>
-<tr class="row-odd"><td> </td>
-<td>Architecture</td>
-<td>One worker group on single node (with data partition)</td>
+<tr class="row-odd"><td></td>
+<td><p>Architecture</p></td>
+<td><p>One worker group on single node (with data partition)</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td> </td>
-<td>Multi worker groups on single node using <a class="reference external" href="http://www.eecs.berkeley.edu/~brecht/papers/hogwildTR.pdf">Hogwild</a></td>
+<tr class="row-even"><td></td>
+<td></td>
+<td><p>Multi worker groups on single node using <a class="reference external" href="http://www.eecs.berkeley.edu/~brecht/papers/hogwildTR.pdf">Hogwild</a></p></td>
</tr>
-<tr class="row-odd"><td> </td>
-<td> </td>
-<td>Distributed Hogwild</td>
+<tr class="row-odd"><td></td>
+<td></td>
+<td><p>Distributed Hogwild</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td> </td>
-<td>Multi groups across nodes, like <a class="reference external" href="http://papers.nips.cc/paper/4687-large-scale-distributed-deep-networks">Downpour</a></td>
+<tr class="row-even"><td></td>
+<td></td>
+<td><p>Multi groups across nodes, like <a class="reference external" href="http://papers.nips.cc/paper/4687-large-scale-distributed-deep-networks">Downpour</a></p></td>
</tr>
-<tr class="row-odd"><td> </td>
-<td> </td>
-<td>All-Reduce training architecture like <a class="reference external" href="http://arxiv.org/abs/1501.02876">DeepImage</a></td>
+<tr class="row-odd"><td></td>
+<td></td>
+<td><p>All-Reduce training architecture like <a class="reference external" href="http://arxiv.org/abs/1501.02876">DeepImage</a></p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td> </td>
-<td>Load-balance among servers</td>
+<tr class="row-even"><td></td>
+<td></td>
+<td><p>Load-balance among servers</p></td>
</tr>
-<tr class="row-odd"><td> </td>
-<td>Failure recovery</td>
-<td>Checkpoint and restore</td>
+<tr class="row-odd"><td></td>
+<td><p>Failure recovery</p></td>
+<td><p>Checkpoint and restore</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td>Tools</td>
-<td>Installation with GNU auto Tools</td>
+<tr class="row-even"><td></td>
+<td><p>Tools</p></td>
+<td><p>Installation with GNU auto Tools</p></td>
</tr>
-<tr class="row-odd"><td>v0.2 Jan 2016</td>
-<td>Neural Network</td>
-<td>Feed forward neural network, including AlexNet, cuDNN layers,Tools</td>
+<tr class="row-odd"><td><p>v0.2 Jan 2016</p></td>
+<td><p>Neural Network</p></td>
+<td><p>Feed forward neural network, including AlexNet, cuDNN layers,Tools</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td> </td>
-<td>Recurrent neural network, including GRULayer and BPTT</td>
+<tr class="row-even"><td></td>
+<td></td>
+<td><p>Recurrent neural network, including GRULayer and BPTT</p></td>
</tr>
-<tr class="row-odd"><td> </td>
-<td> </td>
-<td>Model partition and hybrid partition</td>
+<tr class="row-odd"><td></td>
+<td></td>
+<td><p>Model partition and hybrid partition</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td>Tools</td>
-<td>Integration with Mesos for resource management</td>
+<tr class="row-even"><td></td>
+<td><p>Tools</p></td>
+<td><p>Integration with Mesos for resource management</p></td>
</tr>
-<tr class="row-odd"><td> </td>
-<td> </td>
-<td>Prepare Docker images for deployment</td>
+<tr class="row-odd"><td></td>
+<td></td>
+<td><p>Prepare Docker images for deployment</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td> </td>
-<td>Visualization of neural net and debug information</td>
+<tr class="row-even"><td></td>
+<td></td>
+<td><p>Visualization of neural net and debug information</p></td>
</tr>
-<tr class="row-odd"><td> </td>
-<td>Binding</td>
-<td>Python binding for major components</td>
+<tr class="row-odd"><td></td>
+<td><p>Binding</p></td>
+<td><p>Python binding for major components</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td>GPU</td>
-<td>Single node with multiple GPUs</td>
+<tr class="row-even"><td></td>
+<td><p>GPU</p></td>
+<td><p>Single node with multiple GPUs</p></td>
</tr>
-<tr class="row-odd"><td>v0.3 April 2016</td>
-<td>GPU</td>
-<td>Multiple nodes, each with multiple GPUs</td>
+<tr class="row-odd"><td><p>v0.3 April 2016</p></td>
+<td><p>GPU</p></td>
+<td><p>Multiple nodes, each with multiple GPUs</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td> </td>
-<td>Heterogeneous training using both GPU and CPU <a class="reference external" href="http://arxiv.org/abs/1504.04343">CcT</a></td>
+<tr class="row-even"><td></td>
+<td></td>
+<td><p>Heterogeneous training using both GPU and CPU <a class="reference external" href="http://arxiv.org/abs/1504.04343">CcT</a></p></td>
</tr>
-<tr class="row-odd"><td> </td>
-<td> </td>
-<td>Support cuDNN v4</td>
+<tr class="row-odd"><td></td>
+<td></td>
+<td><p>Support cuDNN v4</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td>Installation</td>
-<td>Remove dependency on ZeroMQ, CZMQ, Zookeeper for single node training</td>
+<tr class="row-even"><td></td>
+<td><p>Installation</p></td>
+<td><p>Remove dependency on ZeroMQ, CZMQ, Zookeeper for single node training</p></td>
</tr>
-<tr class="row-odd"><td> </td>
-<td>Updater</td>
-<td>Add new SGD updaters including Adam, AdamMax and AdaDelta</td>
+<tr class="row-odd"><td></td>
+<td><p>Updater</p></td>
+<td><p>Add new SGD updaters including Adam, AdamMax and AdaDelta</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td>Binding</td>
-<td>Enhance Python binding for training</td>
+<tr class="row-even"><td></td>
+<td><p>Binding</p></td>
+<td><p>Enhance Python binding for training</p></td>
</tr>
-<tr class="row-odd"><td>v1.0 Sep 2016</td>
-<td>Programming abstraction</td>
-<td>Tensor with linear algebra, neural net and random operations</td>
+<tr class="row-odd"><td><p>v1.0 Sep 2016</p></td>
+<td><p>Programming abstraction</p></td>
+<td><p>Tensor with linear algebra, neural net and random operations</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td> </td>
-<td>Updater for distributed parameter updating</td>
+<tr class="row-even"><td></td>
+<td></td>
+<td><p>Updater for distributed parameter updating</p></td>
</tr>
-<tr class="row-odd"><td> </td>
-<td>Hardware</td>
-<td>Use Cuda and Cudnn for Nvidia GPU</td>
+<tr class="row-odd"><td></td>
+<td><p>Hardware</p></td>
+<td><p>Use Cuda and Cudnn for Nvidia GPU</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td> </td>
-<td>Use OpenCL for AMD GPU or other devices</td>
+<tr class="row-even"><td></td>
+<td></td>
+<td><p>Use OpenCL for AMD GPU or other devices</p></td>
</tr>
-<tr class="row-odd"><td> </td>
-<td>Cross-platform</td>
-<td>To extend from Linux to MacOS</td>
+<tr class="row-odd"><td></td>
+<td><p>Cross-platform</p></td>
+<td><p>To extend from Linux to MacOS</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td> </td>
-<td>Large image models, e.g., <a class="reference external" href="https://arxiv.org/pdf/1409.1556.pdf">VGG</a> and <a class="reference external" href="http://arxiv.org/abs/1512.03385">Residual Net</a></td>
+<tr class="row-even"><td></td>
+<td></td>
+<td><p>Large image models, e.g., <a class="reference external" href="https://arxiv.org/pdf/1409.1556.pdf">VGG</a> and <a class="reference external" href="http://arxiv.org/abs/1512.03385">Residual Net</a></p></td>
</tr>
-<tr class="row-odd"><td>v1.1 Jan 2017</td>
-<td>Model Zoo</td>
-<td>GoogleNet; Health-care models</td>
+<tr class="row-odd"><td><p>v1.1 Jan 2017</p></td>
+<td><p>Model Zoo</p></td>
+<td><p>GoogleNet; Health-care models</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td>Caffe converter</td>
-<td>Use SINGA to train models configured in caffe proto files</td>
+<tr class="row-even"><td></td>
+<td><p>Caffe converter</p></td>
+<td><p>Use SINGA to train models configured in caffe proto files</p></td>
</tr>
-<tr class="row-odd"><td> </td>
-<td>Model components</td>
-<td>Add concat and slice layers; accept multiple inputs to the net</td>
+<tr class="row-odd"><td></td>
+<td><p>Model components</p></td>
+<td><p>Add concat and slice layers; accept multiple inputs to the net</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td>Compilation and installation</td>
-<td>Windows suppport</td>
+<tr class="row-even"><td></td>
+<td><p>Compilation and installation</p></td>
+<td><p>Windows suppport</p></td>
</tr>
-<tr class="row-odd"><td> </td>
-<td> </td>
-<td>Simplify the installation by compiling protobuf and openblas together with SINGA</td>
+<tr class="row-odd"><td></td>
+<td></td>
+<td><p>Simplify the installation by compiling protobuf and openblas together with SINGA</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td> </td>
-<td>Build python wheel automatically using Jenkins</td>
+<tr class="row-even"><td></td>
+<td></td>
+<td><p>Build python wheel automatically using Jenkins</p></td>
</tr>
-<tr class="row-odd"><td> </td>
-<td> </td>
-<td>Install SINGA from Debian packages</td>
+<tr class="row-odd"><td></td>
+<td></td>
+<td><p>Install SINGA from Debian packages</p></td>
</tr>
-<tr class="row-even"><td>v1.2 June 2018</td>
-<td>AutoGrad</td>
-<td>AutoGrad for BP</td>
+<tr class="row-even"><td><p>v1.2 June 2018</p></td>
+<td><p>AutoGrad</p></td>
+<td><p>AutoGrad for BP</p></td>
</tr>
-<tr class="row-odd"><td> </td>
-<td>Python 3</td>
-<td>Support Python 3 for PySinga</td>
+<tr class="row-odd"><td></td>
+<td><p>Python 3</p></td>
+<td><p>Support Python 3 for PySinga</p></td>
</tr>
-<tr class="row-even"><td> </td>
-<td>Models</td>
-<td>Add popular models, including VGG, ResNet, DenseNet, InceptionNet</td>
+<tr class="row-even"><td></td>
+<td><p>Models</p></td>
+<td><p>Add popular models, including VGG, ResNet, DenseNet, InceptionNet</p></td>
</tr>
</tbody>
</table>
@@ -369,21 +366,12 @@
</div>
<footer>
- <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-
- <a href="how-contribute.html" class="btn btn-neutral float-right" title="How to Contribute to SINGA" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
-
-
- <a href="../downloads.html" class="btn btn-neutral" title="Download 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..
+ © 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>
@@ -400,36 +388,17 @@
-
-
- <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>
@@ -439,8 +408,8 @@
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -449,8 +418,14 @@
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/docs/autograd.html b/en/docs/autograd.html
index ded94ec..e839a5b 100644
--- a/en/docs/autograd.html
+++ b/en/docs/autograd.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Autograd in Singa — incubator-singa 1.1.0 documentation</title>
+ <title>Autograd in Singa — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,28 @@
-
-
+ <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="Data" href="data.html" />
- <link rel="prev" title="Optimizer" href="optimizer.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="../../_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="ONNX" href="onnx.html" />
+ <link rel="prev" title="Tensor" href="tensor.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 {
@@ -44,21 +50,16 @@
}
</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" >
@@ -67,7 +68,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +83,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -105,12 +106,6 @@
<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 current"><a class="current reference internal" href="#">Autograd in Singa</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#relevant-modules">Relevant Modules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#tensor">Tensor</a></li>
@@ -125,22 +120,15 @@
</li>
</ul>
</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>
+<li class="toctree-l2"><a class="reference internal" href="onnx.html">ONNX</a></li>
+<li class="toctree-l2"><a class="reference internal" href="benchmark.html">Benchmark for Distributed training</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -222,54 +210,53 @@
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<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">licenses</span><span class="o">/</span><span class="n">LICENSE</span><span class="o">-</span><span [...]
-
-<span class="n">Unless</span> <span class="n">required</span> <span class="n">by</span> <span class="n">applicable</span> <span class="n">law</span> <span class="ow">or</span> <span class="n">agreed</span> <span class="n">to</span> <span class="ow">in</span> <span class="n">writing</span><span class="p">,</span>
-<span class="n">software</span> <span class="n">distributed</span> <span class="n">under</span> <span class="n">the</span> <span class="n">License</span> <span class="ow">is</span> <span class="n">distributed</span> <span class="n">on</span> <span class="n">an</span>
-<span class="s2">"AS IS"</span> <span class="n">BASIS</span><span class="p">,</span> <span class="n">WITHOUT</span> <span class="n">WARRANTIES</span> <span class="n">OR</span> <span class="n">CONDITIONS</span> <span class="n">OF</span> <span class="n">ANY</span>
-<span class="n">KIND</span><span class="p">,</span> <span class="n">either</span> <span class="n">express</span> <span class="ow">or</span> <span class="n">implied</span><span class="o">.</span> <span class="n">See</span> <span class="n">the</span> <span class="n">License</span> <span class="k">for</span> <span class="n">the</span>
-<span class="n">specific</span> <span class="n">language</span> <span class="n">governing</span> <span class="n">permissions</span> <span class="ow">and</span> <span class="n">limitations</span>
-<span class="n">under</span> <span class="n">the</span> <span class="n">License</span><span class="o">.</span>
-</pre></div>
-</div>
-<p>–></p>
-<div class="section" id="autograd-in-singa">
-<span id="autograd-in-singa"></span><h1>Autograd in Singa<a class="headerlink" href="#autograd-in-singa" title="Permalink to this headline">¶</a></h1>
+ 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="autograd-in-singa">
+<h1>Autograd in Singa<a class="headerlink" href="#autograd-in-singa" title="Permalink to this headline">¶</a></h1>
<p>There are two typical ways to implement autograd, via symbolic differentiation like <a class="reference external" href="http://deeplearning.net/software/theano/index.html">Theano</a> or reverse differentiation like <a class="reference external" href="https://pytorch.org/docs/stable/notes/autograd.html">Pytorch</a>. Singa follows Pytorch way, which records the computation graph and apply the backward propagation automatically after forward propagation. The autograd algorithm is explain [...]
<div class="section" id="relevant-modules">
-<span id="relevant-modules"></span><h2>Relevant Modules<a class="headerlink" href="#relevant-modules" title="Permalink to this headline">¶</a></h2>
+<h2>Relevant Modules<a class="headerlink" href="#relevant-modules" title="Permalink to this headline">¶</a></h2>
<p>There are three classes involved in autograd, namely <code class="docutils literal notranslate"><span class="pre">singa.tensor.Tensor</span></code> , <code class="docutils literal notranslate"><span class="pre">singa.autograd.Operation</span></code>, and <code class="docutils literal notranslate"><span class="pre">singa.autograd.Layer</span></code>. In the rest of this article, we use tensor, operation and layer to refer to an instance of the respective class.</p>
<div class="section" id="tensor">
-<span id="tensor"></span><h3>Tensor<a class="headerlink" href="#tensor" title="Permalink to this headline">¶</a></h3>
+<h3>Tensor<a class="headerlink" href="#tensor" title="Permalink to this headline">¶</a></h3>
<p>Three attributes of Tensor are used by autograd,</p>
<ul class="simple">
-<li><code class="docutils literal notranslate"><span class="pre">.creator</span></code> is an <code class="docutils literal notranslate"><span class="pre">Operation</span></code> instance. It records the operation that generates the Tensor instance.</li>
-<li><code class="docutils literal notranslate"><span class="pre">.requires_grad</span></code> is a boolean variable. It is used to indicate that the autograd algorithm needs to compute the gradient of the tensor (i.e., the owner). For example, during backpropagation, the gradients of the tensors for the weight matrix of a linear layer and the feature maps of a convolution layer (not the bottom layer) should be computed.</li>
-<li><code class="docutils literal notranslate"><span class="pre">.stores_grad</span></code> is a boolean variable. It is used to indicate that the gradient of the owner tensor should be stored and output by the backward function. For example, the gradient of the feature maps is computed during backpropagation, but is not included in the output of the backward function.</li>
+<li><p><code class="docutils literal notranslate"><span class="pre">.creator</span></code> is an <code class="docutils literal notranslate"><span class="pre">Operation</span></code> instance. It records the operation that generates the Tensor instance.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">.requires_grad</span></code> is a boolean variable. It is used to indicate that the autograd algorithm needs to compute the gradient of the tensor (i.e., the owner). For example, during backpropagation, the gradients of the tensors for the weight matrix of a linear layer and the feature maps of a convolution layer (not the bottom layer) should be computed.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">.stores_grad</span></code> is a boolean variable. It is used to indicate that the gradient of the owner tensor should be stored and output by the backward function. For example, the gradient of the feature maps is computed during backpropagation, but is not included in the output of the backward function.</p></li>
</ul>
<p>Programmers can change <code class="docutils literal notranslate"><span class="pre">requires_grad</span></code> and <code class="docutils literal notranslate"><span class="pre">stores_grad</span></code> of a Tensor instance. For example, if later is set to True, the corresponding gradient is included in the output of the backward function. It should be noted that if <code class="docutils literal notranslate"><span class="pre">stores_grad</span></code> is True, then <code class="docuti [...]
</div>
<div class="section" id="operation">
-<span id="operation"></span><h3>Operation<a class="headerlink" href="#operation" title="Permalink to this headline">¶</a></h3>
+<h3>Operation<a class="headerlink" href="#operation" title="Permalink to this headline">¶</a></h3>
<p>It takes one or more <code class="docutils literal notranslate"><span class="pre">Tensor</span></code> instances as input, and then outputs one or more <code class="docutils literal notranslate"><span class="pre">Tensor</span></code> instances. For example, ReLU can be implemented as a specific Operation subclass. When an <code class="docutils literal notranslate"><span class="pre">Operation</span></code> instance is called (after instantiation), the following two steps are executed:</p>
<ol class="simple">
-<li>record the source operations, i.e., the <code class="docutils literal notranslate"><span class="pre">creator</span></code>s of the input tensors. 2. do calculation by calling member function <code class="docutils literal notranslate"><span class="pre">.forward()</span></code></li>
+<li><p>record the source operations, i.e., the <code class="docutils literal notranslate"><span class="pre">creator</span></code>s of the input tensors. 2. do calculation by calling member function <code class="docutils literal notranslate"><span class="pre">.forward()</span></code></p></li>
</ol>
<p>There are two member functions for forwarding and backwarding, i.e., <code class="docutils literal notranslate"><span class="pre">.forward()</span></code> and <code class="docutils literal notranslate"><span class="pre">.backward()</span></code>. They take <code class="docutils literal notranslate"><span class="pre">Tensor.data</span></code> as inputs (the type is <code class="docutils literal notranslate"><span class="pre">CTensor</span></code>), and output <code class="docutils lite [...]
</div>
<div class="section" id="layer">
-<span id="layer"></span><h3>Layer<a class="headerlink" href="#layer" title="Permalink to this headline">¶</a></h3>
+<h3>Layer<a class="headerlink" href="#layer" title="Permalink to this headline">¶</a></h3>
<p>For those operations that require parameters, we package them into a new class, <code class="docutils literal notranslate"><span class="pre">Layer</span></code>. For example, convolution operation is wrapped into a convolution layer. <code class="docutils literal notranslate"><span class="pre">Layer</span></code> manages (stores) the parameters and calls the corresponding <code class="docutils literal notranslate"><span class="pre">Operation</span></code>s to implement the transformat [...]
</div>
</div>
<div class="section" id="examples">
-<span id="examples"></span><h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
+<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<p>Multiple examples are provided in the <a class="reference external" href="https://github.com/apache/incubator-singa/tree/master/examples/autograd">example folder</a>. We explain two representative examples here.</p>
<div class="section" id="operation-only">
-<span id="operation-only"></span><h3>Operation only<a class="headerlink" href="#operation-only" title="Permalink to this headline">¶</a></h3>
+<h3>Operation only<a class="headerlink" href="#operation-only" title="Permalink to this headline">¶</a></h3>
<p>The following codes implement a MLP model using only Operation instances (no Layer instances).</p>
<div class="section" id="import-packages">
-<span id="import-packages"></span><h4>Import packages<a class="headerlink" href="#import-packages" title="Permalink to this headline">¶</a></h4>
+<h4>Import packages<a class="headerlink" href="#import-packages" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">singa.tensor</span> <span class="k">import</span> <span class="n">Tensor</span>
<span class="kn">from</span> <span class="nn">singa</span> <span class="k">import</span> <span class="n">autograd</span>
<span class="kn">from</span> <span class="nn">singa</span> <span class="k">import</span> <span class="n">opt</span>
@@ -277,7 +264,7 @@
</div>
</div>
<div class="section" id="create-weight-matrix-and-bias-vector">
-<span id="create-weight-matrix-and-bias-vector"></span><h4>Create weight matrix and bias vector<a class="headerlink" href="#create-weight-matrix-and-bias-vector" title="Permalink to this headline">¶</a></h4>
+<h4>Create weight matrix and bias vector<a class="headerlink" href="#create-weight-matrix-and-bias-vector" title="Permalink to this headline">¶</a></h4>
<p>The parameter tensors are created with both <code class="docutils literal notranslate"><span class="pre">requires_grad</span></code> and <code class="docutils literal notranslate"><span class="pre">stores_grad</span></code> set to True.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">w0</span> <span class="o">=</span> <span class="n">Tensor</span><span class="p">(</span><span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">),</span> <span class="n">requires_grad</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n [...]
<span class="n">w0</span><span class="o">.</span><span class="n">gaussian</span><span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">)</span>
@@ -292,7 +279,7 @@
</div>
</div>
<div class="section" id="training">
-<span id="training"></span><h4>Training<a class="headerlink" href="#training" title="Permalink to this headline">¶</a></h4>
+<h4>Training<a class="headerlink" href="#training" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">inputs</span> <span class="o">=</span> <span class="n">Tensor</span><span class="p">(</span><span class="n">data</span><span class="o">=</span><span class="n">data</span><span class="p">)</span> <span class="c1"># data matrix</span>
<span class="n">target</span> <span class="o">=</span> <span class="n">Tensor</span><span class="p">(</span><span class="n">data</span><span class="o">=</span><span class="n">label</span><span class="p">)</span> <span class="c1"># label vector</span>
<span class="n">autograd</span><span class="o">.</span><span class="n">training</span> <span class="o">=</span> <span class="kc">True</span> <span class="c1"># for training</span>
@@ -315,10 +302,10 @@
</div>
</div>
<div class="section" id="operation-layer">
-<span id="operation-layer"></span><h3>Operation + Layer<a class="headerlink" href="#operation-layer" title="Permalink to this headline">¶</a></h3>
+<h3>Operation + Layer<a class="headerlink" href="#operation-layer" title="Permalink to this headline">¶</a></h3>
<p>The following <a class="reference external" href="https://github.com/apache/incubator-singa/blob/master/examples/autograd/mnist_cnn.py">example</a> implements a CNN model using layers provided by the autograd module.</p>
<div class="section" id="create-the-layers">
-<span id="create-the-layers"></span><h4>Create the layers<a class="headerlink" href="#create-the-layers" title="Permalink to this headline">¶</a></h4>
+<h4>Create the layers<a class="headerlink" href="#create-the-layers" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conv1</span> <span class="o">=</span> <span class="n">autograd</span><span class="o">.</span><span class="n">Conv2d</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">32</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="n">padding</span><span class="o">=</span><span class="mi">1</span><span class="p"> [...]
<span class="n">bn1</span> <span class="o">=</span> <span class="n">autograd</span><span class="o">.</span><span class="n">BatchNorm2d</span><span class="p">(</span><span class="mi">32</span><span class="p">)</span>
<span class="n">pooling1</span> <span class="o">=</span> <span class="n">autograd</span><span class="o">.</span><span class="n">MaxPool2d</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">padding</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
@@ -331,7 +318,7 @@
</div>
</div>
<div class="section" id="define-the-forward-function">
-<span id="define-the-forward-function"></span><h4>Define the forward function<a class="headerlink" href="#define-the-forward-function" title="Permalink to this headline">¶</a></h4>
+<h4>Define the forward function<a class="headerlink" href="#define-the-forward-function" title="Permalink to this headline">¶</a></h4>
<p>The operations in the forward pass will be recorded automatically for backward propagation.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">t</span><span class="p">):</span>
<span class="c1"># x is the input data (a batch of images)</span>
@@ -356,8 +343,8 @@
</pre></div>
</div>
</div>
-<div class="section" id="training">
-<span id="id1"></span><h4>Training<a class="headerlink" href="#training" title="Permalink to this headline">¶</a></h4>
+<div class="section" id="id1">
+<h4>Training<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">autograd</span><span class="o">.</span><span class="n">training</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">for</span> <span class="n">epoch</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">epochs</span><span class="p">):</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">batch_number</span><span class="p">):</span>
@@ -385,10 +372,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="data.html" class="btn btn-neutral float-right" title="Data" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="onnx.html" class="btn btn-neutral float-right" title="ONNX" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="optimizer.html" class="btn btn-neutral" title="Optimizer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="tensor.html" class="btn btn-neutral float-left" title="Tensor" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -397,7 +384,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>
@@ -414,36 +401,17 @@
-
-
- <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>
@@ -453,8 +421,8 @@
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -463,8 +431,14 @@
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/docs/benchmark.html b/en/docs/benchmark.html
index 9a0402b..052003e 100644
--- a/en/docs/benchmark.html
+++ b/en/docs/benchmark.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Benchmark for Distributed training — incubator-singa 1.1.0 documentation</title>
+ <title>Benchmark for Distributed training — incubator-singa 2.0.0 documentation</title>
@@ -18,28 +18,28 @@
- <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
+ <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" 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>
+ <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="Device" href="device.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="../../_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="Download SINGA" href="../downloads.html" />
+ <link rel="prev" title="ONNX" href="onnx.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 {
@@ -68,7 +68,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -83,7 +83,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -104,32 +104,18 @@
<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="#">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>
-<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>
+<li class="toctree-l2"><a class="reference internal" href="onnx.html">ONNX</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Benchmark for Distributed training</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -238,10 +224,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="device.html" class="btn btn-neutral float-right" title="Device" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="../downloads.html" class="btn btn-neutral float-right" title="Download SINGA" 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>
+ <a href="onnx.html" class="btn btn-neutral float-left" title="ONNX" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -287,8 +273,8 @@
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -297,8 +283,14 @@
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/docs/cnn.html b/en/docs/cnn.html
index 0682b73..63f1b67 100644
--- a/en/docs/cnn.html
+++ b/en/docs/cnn.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Quickstart - Cifar10 example — incubator-singa 1.1.0 documentation</title>
+ <title>Quickstart - Cifar10 example — incubator-singa 2.0.0 documentation</title>
@@ -18,20 +18,26 @@
-
-
+ <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="../../_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 {
@@ -42,21 +48,16 @@
}
</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" >
@@ -65,7 +66,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -80,7 +81,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -100,12 +101,10 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -185,22 +184,21 @@
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<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">licenses</span><span class="o">/</span><span class="n">LICENSE</span><span class="o">-</span><span [...]
-
-<span class="n">Unless</span> <span class="n">required</span> <span class="n">by</span> <span class="n">applicable</span> <span class="n">law</span> <span class="ow">or</span> <span class="n">agreed</span> <span class="n">to</span> <span class="ow">in</span> <span class="n">writing</span><span class="p">,</span>
-<span class="n">software</span> <span class="n">distributed</span> <span class="n">under</span> <span class="n">the</span> <span class="n">License</span> <span class="ow">is</span> <span class="n">distributed</span> <span class="n">on</span> <span class="n">an</span>
-<span class="s2">"AS IS"</span> <span class="n">BASIS</span><span class="p">,</span> <span class="n">WITHOUT</span> <span class="n">WARRANTIES</span> <span class="n">OR</span> <span class="n">CONDITIONS</span> <span class="n">OF</span> <span class="n">ANY</span>
-<span class="n">KIND</span><span class="p">,</span> <span class="n">either</span> <span class="n">express</span> <span class="ow">or</span> <span class="n">implied</span><span class="o">.</span> <span class="n">See</span> <span class="n">the</span> <span class="n">License</span> <span class="k">for</span> <span class="n">the</span>
-<span class="n">specific</span> <span class="n">language</span> <span class="n">governing</span> <span class="n">permissions</span> <span class="ow">and</span> <span class="n">limitations</span>
-<span class="n">under</span> <span class="n">the</span> <span class="n">License</span><span class="o">.</span>
-</pre></div>
-</div>
-<p>–></p>
-<div class="section" id="quickstart-cifar10-example">
-<span id="quickstart-cifar10-example"></span><h1>Quickstart - Cifar10 example<a class="headerlink" href="#quickstart-cifar10-example" title="Permalink to this headline">¶</a></h1>
+ 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="quickstart-cifar10-example">
+<h1>Quickstart - Cifar10 example<a class="headerlink" href="#quickstart-cifar10-example" title="Permalink to this headline">¶</a></h1>
<p>Convolution neural network (CNN) is a type of feed-forward artificial neural network widely used for image classification. In this example, we will use a deep CNN model to do image classification for the <a class="reference external" href="http://www.cs.toronto.edu/~kriz/cifar.html">CIFAR10 dataset</a>.</p>
<div class="section" id="running-instructions-for-cpp-version">
-<span id="running-instructions-for-cpp-version"></span><h2>Running instructions for CPP version<a class="headerlink" href="#running-instructions-for-cpp-version" title="Permalink to this headline">¶</a></h2>
+<h2>Running instructions for CPP version<a class="headerlink" href="#running-instructions-for-cpp-version" title="Permalink to this headline">¶</a></h2>
<p>Please refer to <a class="reference external" href="installation.html">Installation</a> page for how to install SINGA. Currently, we CNN requires CUDNN, hence both CUDA and CUDNN should be installed and SINGA should be compiled with CUDA and CUDNN.</p>
<p>The Cifar10 dataset could be downloaded by running</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># switch to cifar10 directory
@@ -266,7 +264,7 @@ $ ./run.sh
<p>The training details are stored in <code class="docutils literal notranslate"><span class="pre">train_perf</span></code> file in the same directory and the validation details in <code class="docutils literal notranslate"><span class="pre">val_perf</span></code> file.</p>
</div>
<div class="section" id="running-instructions-for-python-version">
-<span id="running-instructions-for-python-version"></span><h2>Running instructions for Python version<a class="headerlink" href="#running-instructions-for-python-version" title="Permalink to this headline">¶</a></h2>
+<h2>Running instructions for Python version<a class="headerlink" href="#running-instructions-for-python-version" title="Permalink to this headline">¶</a></h2>
<p>To run CNN example in Python version, we need to compile SINGA with Python binding,</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ mkdir build && cd build
$ cmake -DUSE_PYTHON=ON ..
@@ -351,7 +349,7 @@ $ python download_data.py py
<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>
@@ -368,36 +366,17 @@ $ python download_data.py py
-
-
- <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>
@@ -407,8 +386,8 @@ $ python download_data.py py
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -417,8 +396,14 @@ $ python download_data.py py
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/docs/converter.html b/en/docs/converter.html
index 652b854..56c1cd6 100644
--- a/en/docs/converter.html
+++ b/en/docs/converter.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Caffe Converter — incubator-singa 1.1.0 documentation</title>
+ <title>Caffe Converter — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,26 @@
-
-
+ <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="Utils" href="utils.html" />
- <link rel="prev" title="Snapshot" href="snapshot.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="../../_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 {
@@ -44,21 +48,16 @@
}
</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" >
@@ -67,7 +66,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +81,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -99,35 +98,13 @@
- <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"><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 current"><a class="current reference internal" href="#">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>
+ <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>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -183,8 +160,6 @@
<li><a href="../index.html">Docs</a> »</li>
- <li><a href="index.html">Documentation</a> »</li>
-
<li>Caffe Converter</li>
@@ -202,8 +177,8 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
- <div class="section" id="module-singa.converter">
-<span id="caffe-converter"></span><h1>Caffe Converter<a class="headerlink" href="#module-singa.converter" title="Permalink to this headline">¶</a></h1>
+ <div class="section" id="caffe-converter">
+<h1>Caffe Converter<a class="headerlink" href="#caffe-converter" title="Permalink to this headline">¶</a></h1>
</div>
@@ -212,21 +187,12 @@
</div>
<footer>
- <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-
- <a href="utils.html" class="btn btn-neutral float-right" title="Utils" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
-
-
- <a href="snapshot.html" class="btn btn-neutral" title="Snapshot" 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..
+ © 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>
@@ -243,36 +209,17 @@
-
-
- <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>
@@ -282,8 +229,8 @@
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -292,8 +239,14 @@
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/docs/data.html b/en/docs/data.html
index c8e8368..e2b9e2b 100644
--- a/en/docs/data.html
+++ b/en/docs/data.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Data — incubator-singa 1.1.0 documentation</title>
+ <title>Data — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,26 @@
-
-
+ <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="Image Tool" href="image_tool.html" />
- <link rel="prev" title="Autograd in Singa" href="autograd.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="../../_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 {
@@ -44,21 +48,16 @@
}
</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" >
@@ -67,7 +66,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +81,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -99,35 +98,13 @@
- <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 current"><a class="current reference internal" href="#">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>
+ <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>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -183,8 +160,6 @@
<li><a href="../index.html">Docs</a> »</li>
- <li><a href="index.html">Documentation</a> »</li>
-
<li>Data</li>
@@ -202,70 +177,8 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
- <div class="section" id="module-singa.data">
-<span id="data"></span><h1>Data<a class="headerlink" href="#module-singa.data" title="Permalink to this headline">¶</a></h1>
-<p>This module includes classes for loading and prefetching data batches.</p>
-<p>Example usage:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">image_tool</span>
-<span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</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="k">def</span> <span class="nf">image_transform</span><span class="p">(</span><span class="n">img_path</span><span class="p">):</span>
- <span class="k">global</span> <span class="n">tool</span>
- <span class="k">return</span> <span class="n">tool</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">img_path</span><span class="p">)</span><span class="o">.</span><span class="n">resize_by_range</span><span class="p">(</span>
- <span class="p">(</span><span class="mi">112</span><span class="p">,</span> <span class="mi">128</span><span class="p">))</span><span class="o">.</span><span class="n">random_crop</span><span class="p">(</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="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="n">data</span> <span class="o">=</span> <span class="n">ImageBatchIter</span><span class="p">(</span><span class="s1">'train.txt'</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span>
- <span class="n">image_transform</span><span class="p">,</span> <span class="n">shuffle</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">delimiter</span><span class="o">=</span><span class="s1">','</span><span class="p">,</span>
- <span class="n">image_folder</span><span class="o">=</span><span class="s1">'images/'</span><span class="p">,</span>
- <span class="n">capacity</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
-<span class="n">data</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
-<span class="c1"># imgs is a numpy array for a batch of images,</span>
-<span class="c1"># shape: batch_size, 3 (RGB), height, width</span>
-<span class="n">imgs</span><span class="p">,</span> <span class="n">labels</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
-
-<span class="c1"># convert numpy array back into images</span>
-<span class="k">for</span> <span class="n">idx</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">imgs</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]):</span>
- <span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">fromarray</span><span class="p">(</span><span class="n">imgs</span><span class="p">[</span><span class="n">idx</span><span class="p">]</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">uint8</span><span class="p">)</span><span class="o">.</span><span class="n">transpose [...]
- <span class="s1">'RGB'</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">'img</span><span class="si">%d</span><span class="s1">.png'</span> <span class="o">%</span> <span class="n">idx</span><span class="p">)</span>
-<span class="n">data</span><span class="o">.</span><span class="n">end</span><span class="p">()</span>
-</pre></div>
-</div>
-<dl class="class">
-<dt id="singa.data.ImageBatchIter">
-<em class="property">class </em><code class="descclassname">singa.data.</code><code class="descname">ImageBatchIter</code><span class="sig-paren">(</span><em>img_list_file</em>, <em>batch_size</em>, <em>image_transform</em>, <em>shuffle=True</em>, <em>delimiter=' '</em>, <em>image_folder=None</em>, <em>capacity=10</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.data.ImageBatchIter" title="Permalink to this definition">¶</a></dt>
-<dd><p>Utility for iterating over an image dataset to get mini-batches.</p>
-<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>img_list_file</strong> (<em>str</em>) – name of the file containing image meta data; each
-line consists of image_path_suffix delimiter meta_info,
-where meta info could be label index or label strings, etc.
-meta_info should not contain the delimiter. If the meta_info
-of each image is just the label index, then we will parse the
-label index into a numpy array with length=batchsize
-(for compatibility); otherwise, we return a list of meta_info;
-if meta info is available, we return a list of None.</li>
-<li><strong>batch_size</strong> (<em>int</em>) – num of samples in one mini-batch</li>
-<li><strong>image_transform</strong> – a function for image augmentation; it accepts the full
-image path and outputs a list of augmented images.</li>
-<li><strong>shuffle</strong> (<em>boolean</em>) – True for shuffling images in the list</li>
-<li><strong>delimiter</strong> (<em>char</em>) – delimiter between image_path_suffix and label, e.g.,
-space or comma</li>
-<li><strong>image_folder</strong> (<em>boolean</em>) – prefix of the image path</li>
-<li><strong>capacity</strong> (<em>int</em>) – the max num of mini-batches in the internal queue.</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
+ <div class="section" id="data">
+<h1>Data<a class="headerlink" href="#data" title="Permalink to this headline">¶</a></h1>
</div>
@@ -274,21 +187,12 @@ space or comma</li>
</div>
<footer>
- <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-
- <a href="image_tool.html" class="btn btn-neutral float-right" title="Image Tool" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
-
-
- <a href="autograd.html" class="btn btn-neutral" title="Autograd in 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..
+ © 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>
@@ -305,36 +209,17 @@ space or comma</li>
-
-
- <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>
@@ -344,8 +229,8 @@ space or comma</li>
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -354,8 +239,14 @@ space or comma</li>
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/docs/dependencies.html b/en/docs/dependencies.html
index dcd9c40..7cccaa2 100644
--- a/en/docs/dependencies.html
+++ b/en/docs/dependencies.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Dependent library installation — incubator-singa 1.1.0 documentation</title>
+ <title>Dependent library installation — incubator-singa 2.0.0 documentation</title>
@@ -18,20 +18,26 @@
-
-
+ <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="../../_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 {
@@ -42,21 +48,16 @@
}
</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" >
@@ -65,7 +66,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -80,7 +81,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -100,12 +101,10 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -185,21 +184,20 @@
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<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">licenses</span><span class="o">/</span><span class="n">LICENSE</span><span class="o">-</span><span [...]
-
-<span class="n">Unless</span> <span class="n">required</span> <span class="n">by</span> <span class="n">applicable</span> <span class="n">law</span> <span class="ow">or</span> <span class="n">agreed</span> <span class="n">to</span> <span class="ow">in</span> <span class="n">writing</span><span class="p">,</span>
-<span class="n">software</span> <span class="n">distributed</span> <span class="n">under</span> <span class="n">the</span> <span class="n">License</span> <span class="ow">is</span> <span class="n">distributed</span> <span class="n">on</span> <span class="n">an</span>
-<span class="s2">"AS IS"</span> <span class="n">BASIS</span><span class="p">,</span> <span class="n">WITHOUT</span> <span class="n">WARRANTIES</span> <span class="n">OR</span> <span class="n">CONDITIONS</span> <span class="n">OF</span> <span class="n">ANY</span>
-<span class="n">KIND</span><span class="p">,</span> <span class="n">either</span> <span class="n">express</span> <span class="ow">or</span> <span class="n">implied</span><span class="o">.</span> <span class="n">See</span> <span class="n">the</span> <span class="n">License</span> <span class="k">for</span> <span class="n">the</span>
-<span class="n">specific</span> <span class="n">language</span> <span class="n">governing</span> <span class="n">permissions</span> <span class="ow">and</span> <span class="n">limitations</span>
-<span class="n">under</span> <span class="n">the</span> <span class="n">License</span><span class="o">.</span>
-</pre></div>
-</div>
-<p>–></p>
-<div class="section" id="dependent-library-installation">
-<span id="dependent-library-installation"></span><h1>Dependent library installation<a class="headerlink" href="#dependent-library-installation" title="Permalink to this headline">¶</a></h1>
+ 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="dependent-library-installation">
+<h1>Dependent library installation<a class="headerlink" href="#dependent-library-installation" title="Permalink to this headline">¶</a></h1>
<div class="section" id="windows">
-<span id="windows"></span><h2>Windows<a class="headerlink" href="#windows" title="Permalink to this headline">¶</a></h2>
+<h2>Windows<a class="headerlink" href="#windows" title="Permalink to this headline">¶</a></h2>
<p>This section is used to compile and install the dependent libraries under
windows system from source codes. The following instructions ONLY work for Visual Studio 2015 as
previous VS does not support <a class="reference external" href="https://msdn.microsoft.com/en-us/library/hh567368.aspx">C++11 features</a> well (including generic lambdas, auto, non-static
@@ -209,7 +207,7 @@ VS projects for the dependent libraries as 32-bit/64-bit. This can be done by
may get system-specific warnings/errors. Please fix them according to the
prompts by VS.</p>
<div class="section" id="google-logging">
-<span id="google-logging"></span><h3>Google Logging<a class="headerlink" href="#google-logging" title="Permalink to this headline">¶</a></h3>
+<h3>Google Logging<a class="headerlink" href="#google-logging" title="Permalink to this headline">¶</a></h3>
<p>The glog library is an optional library for singa project. But it is currently necessary for Window compilation.
Since the latest release version of glog will encounter error C2084 on sprintf function
under VS2015, we test the compilation and installation using the master branch from <a class="reference external" href="https://github.com/google/glog">github</a>.</p>
@@ -224,7 +222,7 @@ system folder).</p>
<p>Step 4: Done.</p>
</div>
<div class="section" id="google-protobuf">
-<span id="google-protobuf"></span><h3>Google protobuf<a class="headerlink" href="#google-protobuf" title="Permalink to this headline">¶</a></h3>
+<h3>Google protobuf<a class="headerlink" href="#google-protobuf" title="Permalink to this headline">¶</a></h3>
<p>Tested on version 2.6.1:</p>
<p>Step 1: Download and decompress the source code.</p>
<p>Step 2: Open “protobuf.sln” file under “vsprojects” folder. You will get a conversion
@@ -241,7 +239,7 @@ installation include folder (or system folder).</p>
<p>Step 5: Done.</p>
</div>
<div class="section" id="cblas">
-<span id="cblas"></span><h3>CBLAS<a class="headerlink" href="#cblas" title="Permalink to this headline">¶</a></h3>
+<h3>CBLAS<a class="headerlink" href="#cblas" title="Permalink to this headline">¶</a></h3>
<p>There are ready-to-use binary packages online
(<a class="reference external" href="https://sourceforge.net/projects/openblas/files/">link</a>). However, we still install
OpenBLAS with version 0.2.18 as test:</p>
@@ -262,12 +260,12 @@ folders).</p>
</div>
</div>
<div class="section" id="faq">
-<span id="faq"></span><h2>FAQ<a class="headerlink" href="#faq" title="Permalink to this headline">¶</a></h2>
+<h2>FAQ<a class="headerlink" href="#faq" title="Permalink to this headline">¶</a></h2>
<ol>
-<li><p class="first">Error C2375 ‘snprintf’: redefinition; different linkage</p>
+<li><p>Error C2375 ‘snprintf’: redefinition; different linkage</p>
<p>Add “HAVE_SNPRINTF” to “C/C++ - Preprocessor - Preprocessor definitions”</p>
</li>
-<li><p class="first">Error due to hash map</p>
+<li><p>Error due to hash map</p>
<p>Add “_SILENCE_STDEXT_HASH_DEPRECATION_WARNINGS” to Preprocessor Definitions.</p>
</li>
</ol>
@@ -285,7 +283,7 @@ folders).</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>
@@ -302,36 +300,17 @@ folders).</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>
@@ -341,8 +320,8 @@ folders).</p>
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -351,8 +330,14 @@ folders).</p>
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/docs/device.html b/en/docs/device.html
index 06af6d5..a925bf2 100644
--- a/en/docs/device.html
+++ b/en/docs/device.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Device — incubator-singa 1.1.0 documentation</title>
+ <title>Device — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,28 @@
-
-
+ <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="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 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 {
@@ -44,21 +50,16 @@
}
</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" >
@@ -67,7 +68,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +83,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -105,34 +106,21 @@
<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="#python-api">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>
+<li class="toctree-l2"><a class="reference internal" href="onnx.html">ONNX</a></li>
+<li class="toctree-l2"><a class="reference internal" href="benchmark.html">Benchmark for Distributed training</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -217,54 +205,13 @@ of memory and execution are implemented in the Device class.</p>
<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>CudaGPU for an Nvidia GPU card which runs Cuda code</li>
-<li>CppCPU for a CPU which runs Cpp code</li>
-<li>OpenclGPU for a GPU card which runs OpenCL code</li>
+<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>
-<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>num</strong> (<em>int</em>) – number of device to create.</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a list of swig converted CudaGPU devices.</td>
-</tr>
-</tbody>
-</table>
-</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>
-<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>device_ids</strong> (<em>list</em>) – a list of GPU card IDs.</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a list of swig converted CudaGPU devices.</td>
-</tr>
-</tbody>
-</table>
-</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>
-
+<div class="section" id="python-api">
+<h2>Python API<a class="headerlink" href="#python-api" title="Permalink to this headline">¶</a></h2>
<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>
@@ -290,7 +237,7 @@ to call singa::Device and its methods.</p>
<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" title="Software Stack" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</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>
@@ -299,7 +246,7 @@ to call singa::Device and its methods.</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>
@@ -316,36 +263,17 @@ to call singa::Device and its methods.</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>
@@ -355,8 +283,8 @@ to call singa::Device and its methods.</p>
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -365,8 +293,14 @@ to call singa::Device and its methods.</p>
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/docs/docker.html b/en/docs/docker.html
index bec2815..7eec183 100644
--- a/en/docs/docker.html
+++ b/en/docs/docker.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Docker Images — incubator-singa 1.1.0 documentation</title>
+ <title>Docker Images — incubator-singa 2.0.0 documentation</title>
@@ -18,20 +18,26 @@
-
-
+ <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="../../_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 {
@@ -42,21 +48,16 @@
}
</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" >
@@ -65,7 +66,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -80,7 +81,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -100,12 +101,10 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -185,28 +184,27 @@
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<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">licenses</span><span class="o">/</span><span class="n">LICENSE</span><span class="o">-</span><span [...]
-
-<span class="n">Unless</span> <span class="n">required</span> <span class="n">by</span> <span class="n">applicable</span> <span class="n">law</span> <span class="ow">or</span> <span class="n">agreed</span> <span class="n">to</span> <span class="ow">in</span> <span class="n">writing</span><span class="p">,</span>
-<span class="n">software</span> <span class="n">distributed</span> <span class="n">under</span> <span class="n">the</span> <span class="n">License</span> <span class="ow">is</span> <span class="n">distributed</span> <span class="n">on</span> <span class="n">an</span>
-<span class="s2">"AS IS"</span> <span class="n">BASIS</span><span class="p">,</span> <span class="n">WITHOUT</span> <span class="n">WARRANTIES</span> <span class="n">OR</span> <span class="n">CONDITIONS</span> <span class="n">OF</span> <span class="n">ANY</span>
-<span class="n">KIND</span><span class="p">,</span> <span class="n">either</span> <span class="n">express</span> <span class="ow">or</span> <span class="n">implied</span><span class="o">.</span> <span class="n">See</span> <span class="n">the</span> <span class="n">License</span> <span class="k">for</span> <span class="n">the</span>
-<span class="n">specific</span> <span class="n">language</span> <span class="n">governing</span> <span class="n">permissions</span> <span class="ow">and</span> <span class="n">limitations</span>
-<span class="n">under</span> <span class="n">the</span> <span class="n">License</span><span class="o">.</span>
-</pre></div>
-</div>
-<p>–></p>
-<div class="section" id="docker-images">
-<span id="docker-images"></span><h1>Docker Images<a class="headerlink" href="#docker-images" title="Permalink to this headline">¶</a></h1>
+ 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">
-<span id="available-tags"></span><h2>Available tags<a class="headerlink" href="#available-tags" title="Permalink to this headline">¶</a></h2>
+<h2>Available tags<a class="headerlink" href="#available-tags" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
-<li><code class="docutils literal notranslate"><span class="pre">devel</span></code>, with SINGA and the development packages installed on Ubuntu16.04 (no GPU)</li>
-<li><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</li>
+<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">
-<span id="use-the-existing-docker-images"></span><h2>Use the existing Docker images<a class="headerlink" href="#use-the-existing-docker-images" title="Permalink to this headline">¶</a></h2>
+<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>
@@ -222,7 +220,7 @@
<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">
-<span id="create-new-docker-images-from-dockerfile"></span><h2>Create new Docker images from Dockerfile<a class="headerlink" href="#create-new-docker-images-from-dockerfile" title="Permalink to this headline">¶</a></h2>
+<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>
@@ -233,9 +231,9 @@ Dockerfile folder, e.g., tool/docker/devel/</p>
</pre></div>
</div>
<ul class="simple">
-<li>devel: development images with all dependent libs’ header files installed and SINGA’s source code; runtime: the minimal images which can run SINGA programs.</li>
-<li>CUDA: cuda10.0, cuda9.0</li>
-<li>CUDNN: cudnn7</li>
+<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 lite [...]
@@ -261,7 +259,7 @@ The folder structure is like</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>
@@ -278,36 +276,17 @@ The folder structure is like</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>
@@ -317,8 +296,8 @@ The folder structure is like</p>
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -327,8 +306,14 @@ The folder structure is like</p>
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/docs/image_tool.html b/en/docs/image_tool.html
index 1493691..0a3edf8 100644
--- a/en/docs/image_tool.html
+++ b/en/docs/image_tool.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Image Tool — incubator-singa 1.1.0 documentation</title>
+ <title>Image Tool — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,26 @@
-
-
+ <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="../../_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 {
@@ -44,21 +48,16 @@
}
</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" >
@@ -67,7 +66,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +81,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -99,35 +98,13 @@
- <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>
+ <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>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -183,8 +160,6 @@
<li><a href="../index.html">Docs</a> »</li>
- <li><a href="index.html">Documentation</a> »</li>
-
<li>Image Tool</li>
@@ -202,338 +177,8 @@
<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">,</sp [...]
-<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>
-<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">
-<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>
-<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">
-<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>
-<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">
-<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>
-<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>
-<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">
-<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>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">
-<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>
-<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="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><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><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><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><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>
-
-<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>
-<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">
-<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>
-<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>
-<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">
-<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 class="section" id="image-tool">
+<h1>Image Tool<a class="headerlink" href="#image-tool" title="Permalink to this headline">¶</a></h1>
</div>
@@ -542,21 +187,12 @@ it into given size.</p>
</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" 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..
+ © 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>
@@ -573,36 +209,17 @@ 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>
@@ -612,8 +229,8 @@ it into given size.</p>
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -622,8 +239,14 @@ it into given size.</p>
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/docs/index.html b/en/docs/index.html
index 8a99470..bc3ead5 100644
--- a/en/docs/index.html
+++ b/en/docs/index.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Documentation — incubator-singa 1.1.0 documentation</title>
+ <title>Documentation — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,28 @@
-
-
+ <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="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 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 {
@@ -44,21 +50,16 @@
}
</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" >
@@ -67,7 +68,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +83,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -105,29 +106,16 @@
<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>
+<li class="toctree-l2"><a class="reference internal" href="onnx.html">ONNX</a></li>
+<li class="toctree-l2"><a class="reference internal" href="benchmark.html">Benchmark for Distributed training</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -206,21 +194,8 @@
<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#using-docker">Using Docker</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation.html#from-source">From source</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#faq">FAQ</a></li>
</ul>
</li>
@@ -232,30 +207,16 @@
</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#python-api">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#python-api">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>
@@ -273,51 +234,15 @@
<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#training">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>
+<li class="toctree-l4"><a class="reference internal" href="autograd.html#id1">Training</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/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/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>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li>
+<li class="toctree-l1"><a class="reference internal" href="onnx.html">ONNX</a></li>
+<li class="toctree-l1"><a class="reference internal" href="benchmark.html">Benchmark for Distributed training</a></li>
</ul>
</div>
</div>
@@ -333,7 +258,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" 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 float-left" title="Welcome to Apache SINGA" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -342,7 +267,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>
@@ -359,36 +284,17 @@
-
-
- <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>
@@ -398,8 +304,8 @@
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -408,8 +314,14 @@
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/docs/initializer.html b/en/docs/initializer.html
index 6507f10..273e363 100644
--- a/en/docs/initializer.html
+++ b/en/docs/initializer.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Initializer — incubator-singa 1.1.0 documentation</title>
+ <title>Initializer — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,26 @@
-
-
+ <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="Loss" href="loss.html" />
- <link rel="prev" title="FeedForward Net" href="net.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="../../_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 {
@@ -44,21 +48,16 @@
}
</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" >
@@ -67,7 +66,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +81,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -99,39 +98,13 @@
- <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 current"><a class="current reference internal" href="#">Initializer</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#module-singa.initializer">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="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>
+ <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>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -187,8 +160,6 @@
<li><a href="../index.html">Docs</a> »</li>
- <li><a href="index.html">Documentation</a> »</li>
-
<li>Initializer</li>
@@ -208,68 +179,8 @@
<div class="section" id="initializer">
<h1>Initializer<a class="headerlink" href="#initializer" title="Permalink to this headline">¶</a></h1>
-<div class="section" id="module-singa.initializer">
-<span id="python-api"></span><h2>Python API<a class="headerlink" href="#module-singa.initializer" title="Permalink to this headline">¶</a></h2>
-<p>Popular initialization methods for parameter values (Tensor objects).</p>
-<p>Example usages:</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">tensor</span>
-<span class="kn">from</span> <span class="nn">singa</span> <span class="k">import</span> <span class="n">initializer</span>
-
-<span class="n">x</span> <span class="o">=</span> <span class="n">tensor</span><span class="o">.</span><span class="n">Tensor</span><span class="p">((</span><span class="mi">3</span><span class="p">,</span> <span class="mi">5</span><span class="p">))</span>
-<span class="n">initializer</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span> <span class="c1"># use both fan_in and fan_out</span>
-<span class="n">initializer</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="c1"># use only fan_in</span>
-</pre></div>
-</div>
-<dl class="function">
-<dt id="singa.initializer.uniform">
-<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>
-<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</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</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-<p>Ref: [Bengio and Glorot 2010]: Understanding the difficulty of
-training deep feedforward neuralnetworks.</p>
-</dd></dl>
-
-<dl class="function">
-<dt id="singa.initializer.gaussian">
-<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>
-<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</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</li>
-</ul>
-</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>
-
+<div class="section" id="python-api">
+<h2>Python API<a class="headerlink" href="#python-api" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="cpp-api">
<h2>CPP API<a class="headerlink" href="#cpp-api" title="Permalink to this headline">¶</a></h2>
@@ -282,21 +193,12 @@ Rectifiers: Surpassing Human-Level Performance on ImageNet Classification</p>
</div>
<footer>
- <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-
- <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" title="FeedForward Net" 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..
+ © 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>
@@ -313,36 +215,17 @@ Rectifiers: Surpassing Human-Level Performance on ImageNet Classification</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>
@@ -352,8 +235,8 @@ Rectifiers: Surpassing Human-Level Performance on ImageNet Classification</p>
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -362,8 +245,14 @@ Rectifiers: Surpassing Human-Level Performance on ImageNet Classification</p>
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/docs/install_macos1013.html b/en/docs/install_macos1013.html
index b31ef0c..4e3db52 100644
--- a/en/docs/install_macos1013.html
+++ b/en/docs/install_macos1013.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Installing SINGA on macOS 13.10 — incubator-singa 1.1.0 documentation</title>
+ <title>Installing SINGA on macOS 13.10 — incubator-singa 2.0.0 documentation</title>
@@ -18,20 +18,26 @@
-
-
+ <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="../../_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 {
@@ -42,21 +48,16 @@
}
</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" >
@@ -65,7 +66,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -80,7 +81,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -100,12 +101,10 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -183,14 +182,14 @@
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
-<li>homebrew is used to install the requirements. Try:</li>
+<li><p>homebrew is used to install the requirements. Try:</p></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>installing required software for building SINGA:</li>
+<li><p>installing required software for building SINGA:</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>brew tap homebrew/science
brew tap homebrew/python
@@ -213,7 +212,7 @@ brew install wget
</pre></div>
</div>
<ul class="simple">
-<li>preparing compiler</li>
+<li><p>preparing compiler</p></li>
</ul>
<p>To let the compiler (and cmake) know the openblas
path,</p>
@@ -230,7 +229,7 @@ path,</p>
</pre></div>
</div>
<ul class="simple">
-<li>Get the source code and build it:</li>
+<li><p>Get the source code and build it:</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git clone https://github.com/apache/incubator-singa.git
@@ -243,14 +242,14 @@ make
</pre></div>
</div>
<ul class="simple">
-<li>Optional: create virtual enviromnet:</li>
+<li><p>Optional: create virtual enviromnet:</p></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>Install the python module</li>
+<li><p>Install the python module</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> python
pip install .
@@ -262,7 +261,7 @@ pip install .
</div>
<p>then SINGA is installed successfully.</p>
<ul class="simple">
-<li>Run Jupyter notebook</li>
+<li><p>Run Jupyter notebook</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install matplotlib
@@ -274,12 +273,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 border="1" class="docutils">
+<table class="docutils align-default">
<colgroup>
-<col width="100%" />
+<col style="width: 100%" />
</colgroup>
-<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>
+<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>
</tr>
</tbody>
</table>
@@ -287,13 +286,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>How to install or update homebrew:</li>
+<li><p>How to install or update homebrew:</p></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>There is an error with protobuf.</li>
+<li><p>There is an error with protobuf.</p></li>
</ul>
<p>Try overwriting the links:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>brew link --overwrite protobuf
@@ -313,7 +312,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>
@@ -330,36 +329,17 @@ 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>
@@ -369,8 +349,8 @@ jupyter notebook
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -379,8 +359,14 @@ jupyter notebook
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/docs/install_win.html b/en/docs/install_win.html
index b7faeb6..45c7adb 100644
--- a/en/docs/install_win.html
+++ b/en/docs/install_win.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Building SINGA on Windows — incubator-singa 1.1.0 documentation</title>
+ <title>Building SINGA on Windows — incubator-singa 2.0.0 documentation</title>
@@ -18,20 +18,26 @@
-
-
+ <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="../../_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 {
@@ -42,21 +48,16 @@
}
</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" >
@@ -65,7 +66,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -80,7 +81,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -100,12 +101,10 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -186,71 +185,65 @@
<p>You may create a folder for building the dependencies.</p>
<p>The dependencies are:</p>
<ul>
-<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>
+<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>
</ul>
</dd>
</dl>
</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>
+<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>
</ul>
</dd>
</dl>
</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>
+<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>
</ul>
</dd>
</dl>
</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>
+<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>
</ul>
</dd>
</dl>
</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>
+<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>
</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="last simple">
-<li>Open the Visual Studio solution and change the build settings to Release and x64.</li>
-<li>Build libopenblas project</li>
+<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>
</dd>
</dl>
</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>
+<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>
</ul>
</dd>
</dl>
@@ -260,11 +253,10 @@
<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>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>
+<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>
</ul>
</dd>
</dl>
@@ -275,9 +267,9 @@ protoc.exe *.proto --python_out python_out
</pre></div>
</div>
<ul class="simple">
-<li><dl class="first docutils">
-<dt>Generate swig interfaces for C++ and Python:</dt>
-<dd>Goto src/api</dd>
+<li><dl class="simple">
+<dt>Generate swig interfaces for C++ and Python:</dt><dd><p>Goto src/api</p>
+</dd>
</dl>
</li>
</ul>
@@ -285,9 +277,9 @@ protoc.exe *.proto --python_out python_out
</pre></div>
</div>
<ul class="simple">
-<li><dl class="first docutils">
-<dt>generate Visual Studio solution for SINGA:</dt>
-<dd>Goto SINGA source code root folder</dd>
+<li><dl class="simple">
+<dt>generate Visual Studio solution for SINGA:</dt><dd><p>Goto SINGA source code root folder</p>
+</dd>
</dl>
</li>
</ul>
@@ -296,7 +288,7 @@ protoc.exe *.proto --python_out python_out
</pre></div>
</div>
<ul class="simple">
-<li>Call cmake and add the paths in your system similar to the following example:</li>
+<li><p>Call cmake and add the paths in your system similar to the following example:</p></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> ^
@@ -310,37 +302,36 @@ protoc.exe *.proto --python_out python_out
</pre></div>
</div>
<ul class="simple">
-<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>
+<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>
</ul>
</dd>
</dl>
</li>
-<li>build singa project</li>
+<li><p>build singa project</p></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>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>
+<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>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>mkdir SingaEnv
virtualenv SingaEnv
@@ -348,25 +339,25 @@ SingaEnv<span class="se">\S</span>cripts<span class="se">\a</span>ctivate
</pre></div>
</div>
<ul class="simple">
-<li>goto build/python folder and run:</li>
+<li><p>goto build/python folder and run:</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python setup.py install
</pre></div>
</div>
<ul class="simple">
-<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>
+<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>
</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 border="1" class="docutils">
+<table class="docutils align-default">
<colgroup>
-<col width="100%" />
+<col style="width: 100%" />
</colgroup>
-<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>
+<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>
</tr>
</tbody>
</table>
@@ -374,47 +365,41 @@ SingaEnv<span class="se">\S</span>cripts<span class="se">\a</span>ctivate
<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>In the test folder, generate the Visual Studio solution:</li>
+<li><p>In the test folder, generate the Visual Studio solution:</p></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 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>
+<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>
<blockquote>
<div><ul class="simple">
-<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>
+<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>
</ul>
</div></blockquote>
</li>
-<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>
+<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>
<blockquote>
<div><ul>
-<li><p class="first">From the command line:</p>
+<li><p>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="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>
+<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>
</ul>
</dd>
</dl>
@@ -424,12 +409,12 @@ SingaEnv<span class="se">\S</span>cripts<span class="se">\a</span>ctivate
</li>
</ul>
<p>A video tutorial for running the unit tests can be found here:</p>
-<table border="1" class="docutils">
+<table class="docutils align-default">
<colgroup>
-<col width="100%" />
+<col style="width: 100%" />
</colgroup>
-<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>
+<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>
</tr>
</tbody>
</table>
@@ -442,34 +427,30 @@ SingaEnv<span class="se">\S</span>cripts<span class="se">\a</span>ctivate
<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 class="first">CUDA</p>
+<li><p>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 class="first">cuDNN</p>
+<li><p>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 class="first">cnmem:</p>
+<li><p>cnmem:</p>
<blockquote>
<div><ul>
-<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>
+<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>
<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 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>
+<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>
</ul>
</div></blockquote>
</li>
@@ -478,7 +459,7 @@ SingaEnv<span class="se">\S</span>cripts<span class="se">\a</span>ctivate
<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 class="first">Call cmake and add the paths in your system similar to the following example:</p>
+<li><p>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> ^
@@ -499,83 +480,75 @@ SingaEnv<span class="se">\S</span>cripts<span class="se">\a</span>ctivate
</div>
</div></blockquote>
</li>
-<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
+<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
</pre></div>
</div>
</dd>
</dl>
</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>Open the generated solution in Visual Studio</p></li>
+<li><p>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>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>
+<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>
</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 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>
+<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>
<blockquote>
<div><ul class="simple">
-<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>
+<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>
</ul>
</div></blockquote>
</li>
-<li><p class="first">Build singa-kernel project</p>
-</li>
+<li><p>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="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>
+<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>
</ul>
</dd>
</dl>
</li>
-<li>build singa project</li>
+<li><p>build singa project</p></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>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>
+<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>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>mkdir SingaEnv
virtualenv SingaEnv
@@ -583,25 +556,25 @@ SingaEnv<span class="se">\S</span>cripts<span class="se">\a</span>ctivate
</pre></div>
</div>
<ul class="simple">
-<li>goto build/python folder and run:</li>
+<li><p>goto build/python folder and run:</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python setup.py install
</pre></div>
</div>
<ul class="simple">
-<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>
+<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>
</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 border="1" class="docutils">
+<table class="docutils align-default">
<colgroup>
-<col width="100%" />
+<col style="width: 100%" />
</colgroup>
-<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>
+<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>
</tr>
</tbody>
</table>
@@ -609,47 +582,41 @@ SingaEnv<span class="se">\S</span>cripts<span class="se">\a</span>ctivate
<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>In the test folder, generate the Visual Studio solution:</li>
+<li><p>In the test folder, generate the Visual Studio solution:</p></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 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>
+<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>
<blockquote>
<div><ul class="simple">
-<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>
+<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>
</ul>
</div></blockquote>
</li>
-<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>
+<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>
<blockquote>
<div><ul>
-<li><p class="first">From the command line:</p>
+<li><p>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="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>
+<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>
</ul>
</dd>
</dl>
@@ -659,12 +626,12 @@ SingaEnv<span class="se">\S</span>cripts<span class="se">\a</span>ctivate
</li>
</ul>
<p>A video tutorial for running the unit tests can be found here:</p>
-<table border="1" class="docutils">
+<table class="docutils align-default">
<colgroup>
-<col width="100%" />
+<col style="width: 100%" />
</colgroup>
-<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>
+<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>
</tr>
</tbody>
</table>
@@ -682,7 +649,7 @@ SingaEnv<span class="se">\S</span>cripts<span class="se">\a</span>ctivate
<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>
@@ -699,36 +666,17 @@ SingaEnv<span class="se">\S</span>cripts<span class="se">\a</span>ctivate
-
-
- <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>
@@ -738,8 +686,8 @@ SingaEnv<span class="se">\S</span>cripts<span class="se">\a</span>ctivate
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -748,8 +696,14 @@ SingaEnv<span class="se">\S</span>cripts<span class="se">\a</span>ctivate
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/docs/installation.html b/en/docs/installation.html
index 51e0646..08bc702 100644
--- a/en/docs/installation.html
+++ b/en/docs/installation.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Installation — incubator-singa 1.1.0 documentation</title>
+ <title>Installation — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,28 @@
-
-
+ <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="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="Software Stack" href="software_stack.html" />
<link rel="prev" title="Documentation" 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 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 {
@@ -44,21 +50,16 @@
}
</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" >
@@ -67,7 +68,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +83,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -103,43 +104,24 @@
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Documentation</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Installation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#from-conda">From Conda</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#from-source">From source</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="#use-conda-to-build-singa">Use Conda to build SINGA</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#use-native-tools-to-build-singa-on-ubuntu">Use native tools to build SINGA on Ubuntu</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#compile-singa-on-windows">Compile SINGA on Windows</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#more-details-about-the-compilation-options">More details about the compilation options</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#use-modules">USE_MODULES</a></li>
-</ul>
-</li>
+<li class="toctree-l3"><a class="reference internal" href="#using-docker">Using Docker</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#from-source">From source</a></li>
<li class="toctree-l3"><a class="reference internal" href="#faq">FAQ</a></li>
</ul>
</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>
+<li class="toctree-l2"><a class="reference internal" href="onnx.html">ONNX</a></li>
+<li class="toctree-l2"><a class="reference internal" href="benchmark.html">Benchmark for Distributed training</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -221,378 +203,118 @@
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<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">licenses</span><span class="o">/</span><span class="n">LICENSE</span><span class="o">-</span><span [...]
-
-<span class="n">Unless</span> <span class="n">required</span> <span class="n">by</span> <span class="n">applicable</span> <span class="n">law</span> <span class="ow">or</span> <span class="n">agreed</span> <span class="n">to</span> <span class="ow">in</span> <span class="n">writing</span><span class="p">,</span>
-<span class="n">software</span> <span class="n">distributed</span> <span class="n">under</span> <span class="n">the</span> <span class="n">License</span> <span class="ow">is</span> <span class="n">distributed</span> <span class="n">on</span> <span class="n">an</span>
-<span class="s2">"AS IS"</span> <span class="n">BASIS</span><span class="p">,</span> <span class="n">WITHOUT</span> <span class="n">WARRANTIES</span> <span class="n">OR</span> <span class="n">CONDITIONS</span> <span class="n">OF</span> <span class="n">ANY</span>
-<span class="n">KIND</span><span class="p">,</span> <span class="n">either</span> <span class="n">express</span> <span class="ow">or</span> <span class="n">implied</span><span class="o">.</span> <span class="n">See</span> <span class="n">the</span> <span class="n">License</span> <span class="k">for</span> <span class="n">the</span>
-<span class="n">specific</span> <span class="n">language</span> <span class="n">governing</span> <span class="n">permissions</span> <span class="ow">and</span> <span class="n">limitations</span>
-<span class="n">under</span> <span class="n">the</span> <span class="n">License</span><span class="o">.</span>
-</pre></div>
-</div>
-<p>–></p>
-<div class="section" id="installation">
-<span id="installation"></span><h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
+ 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="installation">
+<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
<div class="section" id="from-conda">
-<span id="from-conda"></span><h2>From Conda<a class="headerlink" href="#from-conda" title="Permalink to this headline">¶</a></h2>
+<h2>From Conda<a class="headerlink" href="#from-conda" title="Permalink to this headline">¶</a></h2>
<p>Conda is a package manager for Python, CPP and other packages.</p>
-<p>Currently, SINGA has conda packages (Python 2.7 and Python 3.6) for Linux and MacOSX.
+<p>Currently, SINGA has conda packages for Linux and MacOSX.
<a class="reference external" href="https://conda.io/miniconda.html">Miniconda3</a> is recommended to use with SINGA.
After installing miniconda, execute the one of the following commands to install
SINGA.</p>
<ol>
-<li><p class="first">CPU only</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">nusdbsystem</span> <span class="n">singa</span><span class="o">-</span><span class="n">cpu</span>
+<li><p>CPU only</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">nusdbsystem</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">singa</span><span class="o">-</span><span class="n">cpu</span>
</pre></div>
</div>
+<p><a class="reference external" href="https://colab.research.google.com/drive/1Ntkhi-Z6XTR8WYPXiLwujHd2dOm0772V"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></p>
</li>
-<li><p class="first">GPU with CUDA and cuDNN</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">nusdbsystem</span> <span class="n">singa</span><span class="o">-</span><span class="n">gpu</span>
+<li><p>GPU with CUDA and cuDNN (CUDA driver >=384.81 is required)</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">nusdbsystem</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">singa</span><span class="o">-</span><span class="n">gpu</span>
</pre></div>
</div>
+<p><a class="reference external" href="https://colab.research.google.com/drive/1do_TLJe18IthLOnBOsHCEe-FFPGk1sPJ"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></p>
</li>
-</ol>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">CUDA</span> <span class="n">driver</span> <span class="p">(</span><span class="k">for</span> <span class="n">CUDA</span> <span class="o">>=</span><span class="mf">9.0</span><span class="p">)</span> <span class="n">must</span> <span class="n">be</span> <span class="n">installed</span> <span class="n">before</span> <span class="n">executing</span> <span class="n">the</span> <span class= [...]
- <span class="n">packages</span> <span class="k">for</span> <span class="n">other</span> <span class="n">CUDA</span> <span class="n">versions</span> <span class="n">are</span> <span class="n">also</span> <span class="n">available</span><span class="o">.</span> <span class="n">The</span> <span class="n">following</span> <span class="n">instruction</span>
- <span class="n">lists</span> <span class="nb">all</span> <span class="n">the</span> <span class="n">available</span> <span class="n">Singa</span> <span class="n">packages</span><span class="o">.</span>
+<li><p>Install a specific version of SINGA. The following command lists all the available SINGA packages.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">conda</span> <span class="n">search</span> <span class="o">-</span><span class="n">c</span> <span class="n">nusdbsystem</span> <span class="n">singa</span>
- <span class="n">conda</span> <span class="n">search</span> <span class="o">-</span><span class="n">c</span> <span class="n">nusdbsystem</span> <span class="n">singa</span>
-</pre></div>
-</div>
-<p>If there is no error message from</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"from singa import tensor"</span>
-</pre></div>
-</div>
-<p>then SINGA is installed successfully.</p>
-</div>
-<div class="section" id="from-source">
-<span id="from-source"></span><h2>From source<a class="headerlink" href="#from-source" title="Permalink to this headline">¶</a></h2>
-<p>The source files could be downloaded either as a
-<a class="reference external" href="https://dist.apache.org/repos/dist/dev/incubator/singa/">tar.gz file</a>, or as a git repo</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ git clone https://github.com/apache/incubator-singa.git
-$ cd incubator-singa/
+ <span class="n">Loading</span> <span class="n">channels</span><span class="p">:</span> <span class="n">done</span>
+ <span class="c1"># Name Version Build Channel </span>
+ <span class="n">singa</span> <span class="mf">2.1</span><span class="o">.</span><span class="mf">0.</span><span class="n">dev</span> <span class="n">cpu_py36</span> <span class="n">nusdbsystem</span>
+ <span class="n">singa</span> <span class="mf">2.1</span><span class="o">.</span><span class="mf">0.</span><span class="n">dev</span> <span class="n">cpu_py37</span> <span class="n">nusdbsystem</span>
</pre></div>
</div>
-<div class="section" id="use-conda-to-build-singa">
-<span id="use-conda-to-build-singa"></span><h3>Use Conda to build SINGA<a class="headerlink" href="#use-conda-to-build-singa" title="Permalink to this headline">¶</a></h3>
-<p>Conda-build is a building tool that installs the dependent libraries from anaconda cloud and
-executes the building scripts. The generated package can be uploaded to anaconda
-cloud for others to download and install.</p>
-<p>To install conda-build (after installing miniconda)</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="n">conda</span><span class="o">-</span><span class="n">build</span>
+<p>The following command install a specific version of SINGA,</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">nusdbsystem</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">singa</span><span class="o">=</span><span class="mf">2.1</span><span class="o">.</span><span class="mf">0.</span><spa [...]
</pre></div>
</div>
-<p>To build the CPU version of SINGA</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">build</span> <span class="n">tool</span><span class="o">/</span><span class="n">conda</span><span class="o">/</span><span class="n">singa</span><span class="o">/</span> <span class="o">--</span><span class="n">python</span> <span class="mf">3.6</span>
-</pre></div>
-</div>
-<p>The above commands have been tested on Ubuntu 16.04 and Mac OSX.
-Refer to the <a class="reference external" href="https://travis-ci.org/apache/incubator-singa">Travis-CI page</a> for more information.</p>
-<p>To build the GPU version of SINGA</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">CUDA</span><span class="o">=</span><span class="n">x</span><span class="o">.</span><span class="n">y</span> <span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span> <span class="mf">9.0</span><span class="p">)</span>
-<span class="n">conda</span> <span class="n">build</span> <span class="n">tool</span><span class="o">/</span><span class="n">conda</span><span class="o">/</span><span class="n">singa</span><span class="o">/</span> <span class="o">--</span><span class="n">python</span> <span class="mf">3.6</span>
-</pre></div>
-</div>
-<p>The commands for building on GPU platforms have been tested on Ubuntu 16.04 (cuDNN>=7 and CUDA>=9).
-<a class="reference external" href="https://hub.docker.com/r/nvidia/cuda/">Nvidia’s Docker image</a> provides the building
-environment with cuDNN and CUDA.</p>
-<p>The location of the generated package file is shown on the screen.
-Refer to <a class="reference external" href="https://conda.io/docs/commands/conda-install.html">conda install</a> for
-the instructions of installing the package from the local file.</p>
-</div>
-<div class="section" id="use-native-tools-to-build-singa-on-ubuntu">
-<span id="use-native-tools-to-build-singa-on-ubuntu"></span><h3>Use native tools to build SINGA on Ubuntu<a class="headerlink" href="#use-native-tools-to-build-singa-on-ubuntu" title="Permalink to this headline">¶</a></h3>
-<p>The following libraries are required to compile and run SINGA.
-Refer to SINGA <a class="reference external" href="https://github.com/apache/incubator-singa/blob/master/tool/docker/">Dockerfiles</a>
-for the instructions of installing them on Ubuntu 16.04.</p>
-<ul class="simple">
-<li>cmake (>=2.8)</li>
-<li>gcc (>=4.8.1)</li>
-<li>google protobuf (>=2.5)</li>
-<li>blas (tested with openblas >=0.2.10)</li>
-<li>swig(>=3.0.10) for compiling PySINGA</li>
-<li>numpy(>=1.11.0) for compiling PySINGA</li>
-</ul>
-<ol class="simple">
-<li>create a <code class="docutils literal notranslate"><span class="pre">build</span></code> folder inside incubator-singa and go into that folder</li>
-<li>run <code class="docutils literal notranslate"><span class="pre">cmake</span> <span class="pre">[options]</span> <span class="pre">..</span></code>
-by default all options are OFF except <code class="docutils literal notranslate"><span class="pre">USE_PYTHON</span></code><ul>
-<li><code class="docutils literal notranslate"><span class="pre">USE_MODULES=ON</span></code>, used if protobuf and blas are not installed a prior</li>
-<li><code class="docutils literal notranslate"><span class="pre">USE_CUDA=ON</span></code>, used if CUDA and cuDNN is available</li>
-<li><code class="docutils literal notranslate"><span class="pre">USE_PYTHON3=ON</span></code>, used for compiling with Python 3 support. (The default is Python 2)</li>
-<li><code class="docutils literal notranslate"><span class="pre">USE_OPENCL=ON</span></code>, used for compiling with OpenCL support</li>
-<li><code class="docutils literal notranslate"><span class="pre">USE_MKLDNN=ON</span></code>, used for compiling with Intel MKL-dnn support</li>
-<li><code class="docutils literal notranslate"><span class="pre">PACKAGE=ON</span></code>, used for building the Debian package</li>
-<li><code class="docutils literal notranslate"><span class="pre">ENABLE_TEST</span></code>, used for compiling unit test cases</li>
-</ul>
</li>
-<li>compile the code, <code class="docutils literal notranslate"><span class="pre">make</span></code></li>
-<li>goto python folder</li>
-<li>run <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">.</span></code> or <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-e</span> <span class="pre">.</span></code> The second command creates symlinks instead of copying files into python site-package folder.</li>
</ol>
-<p>Execute step 4 and 5 are to install PySINGA when USE_PYTHON=ON.</p>
-<p>After compiling SINGA with ENABLE_TEST=ON, you can run the unit tests by</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./bin/test_singa
-</pre></div>
-</div>
-<p>You can see all the testing cases with testing results. If SINGA passes all
-tests, then you have successfully installed SINGA.</p>
-</div>
-<div class="section" id="compile-singa-on-windows">
-<span id="compile-singa-on-windows"></span><h3>Compile SINGA on Windows<a class="headerlink" href="#compile-singa-on-windows" title="Permalink to this headline">¶</a></h3>
-<p>Instructions for building on Windows with Python support can be found <a class="reference external" href="install_win.html">here</a>.</p>
-</div>
-<div class="section" id="more-details-about-the-compilation-options">
-<span id="more-details-about-the-compilation-options"></span><h3>More details about the compilation options<a class="headerlink" href="#more-details-about-the-compilation-options" title="Permalink to this headline">¶</a></h3>
-</div>
-<div class="section" id="use-modules">
-<span id="use-modules"></span><h3>USE_MODULES<a class="headerlink" href="#use-modules" title="Permalink to this headline">¶</a></h3>
-<p>If protobuf and openblas are not installed, you can compile SINGA together with them</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ In SINGA ROOT folder
-$ mkdir build
-$ cd build
-$ cmake -DUSE_MODULES=ON ..
-$ make
-</pre></div>
-</div>
-<p>cmake would download OpenBlas and Protobuf (2.6.1) and compile them together
-with SINGA.</p>
-<p>You can use <code class="docutils literal notranslate"><span class="pre">ccmake</span> <span class="pre">..</span></code> to configure the compilation options.
-If some dependent libraries are not in the system default paths, you need to export
-the following environment variables</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">CMAKE_INCLUDE_PATH</span><span class="o">=<</span><span class="n">path</span> <span class="n">to</span> <span class="n">the</span> <span class="n">header</span> <span class="n">file</span> <span class="n">folder</span><span class="o">></span>
-<span class="n">export</span> <span class="n">CMAKE_LIBRARY_PATH</span><span class="o">=<</span><span class="n">path</span> <span class="n">to</span> <span class="n">the</span> <span class="n">lib</span> <span class="n">file</span> <span class="n">folder</span><span class="o">></span>
-</pre></div>
-</div>
-<div class="section" id="use-python">
-<span id="use-python"></span><h4>USE_PYTHON<a class="headerlink" href="#use-python" title="Permalink to this headline">¶</a></h4>
-<p>Similar to compile CPP code, PySINGA is compiled by</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cmake -DUSE_PYTHON=ON ..
-$ make
-$ cd python
-$ pip install .
-</pre></div>
-</div>
-</div>
-<div class="section" id="use-cuda">
-<span id="use-cuda"></span><h4>USE_CUDA<a class="headerlink" href="#use-cuda" title="Permalink to this headline">¶</a></h4>
-<p>Users are encouraged to install the CUDA and
-<a class="reference external" href="https://developer.nvidia.com/cudnn">cuDNN</a> for running SINGA on GPUs to
-get better performance.</p>
-<p>SINGA has been tested over CUDA 9, and cuDNN 7. If cuDNN is
-installed into non-system folder, e.g. /home/bob/local/cudnn/, the following
-commands should be executed for cmake and the runtime to find it</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ export CMAKE_INCLUDE_PATH=/home/bob/local/cudnn/include:$CMAKE_INCLUDE_PATH
-$ export CMAKE_LIBRARY_PATH=/home/bob/local/cudnn/lib64:$CMAKE_LIBRARY_PATH
-$ export LD_LIBRARY_PATH=/home/bob/local/cudnn/lib64:$LD_LIBRARY_PATH
-</pre></div>
-</div>
-<p>The cmake options for CUDA and cuDNN should be switched on</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># Dependent libs are install already
-$ cmake -DUSE_CUDA=ON ..
-$ make
-</pre></div>
-</div>
-</div>
-<div class="section" id="use-opencl">
-<span id="use-opencl"></span><h4>USE_OPENCL<a class="headerlink" href="#use-opencl" title="Permalink to this headline">¶</a></h4>
-<p>SINGA uses opencl-headers and viennacl (version 1.7.1 or newer) for OpenCL support, which
-can be installed using via</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># On Ubuntu 16.04
-$ sudo apt-get install opencl-headers, libviennacl-dev
-# On Fedora
-$ sudo yum install opencl-headers, viennacl
-</pre></div>
-</div>
-<p>Additionally, you will need the OpenCL Installable Client Driver (ICD) for the platforms that you want to run OpenCL on.</p>
-<ul class="simple">
-<li>For AMD and nVidia GPUs, the driver package should also install the correct OpenCL ICD.</li>
-<li>For Intel CPUs and/or GPUs, get the driver from the <a class="reference external" href="https://software.intel.com/en-us/articles/opencl-drivers">Intel website.</a> Note that the drivers provided on that website only supports recent CPUs and Iris GPUs.</li>
-<li>For older Intel CPUs, you can use the <code class="docutils literal notranslate"><span class="pre">beignet-opencl-icd</span></code> package.</li>
-</ul>
-<p>Note that running OpenCL on CPUs is not currently recommended because it is slow.
-Memory transfer is on the order of whole seconds (1000’s of ms on CPUs as compared to 1’s of ms on GPUs).</p>
-<p>More information on setting up a working OpenCL environment may be found <a class="reference external" href="https://wiki.tiker.net/OpenCLHowTo">here</a>.</p>
-<p>If the package version of ViennaCL is not at least 1.7.1, you will need to build it from source:</p>
-<p>Clone <a class="reference external" href="https://github.com/viennacl/viennacl-dev">the repository from here</a>, checkout the <code class="docutils literal notranslate"><span class="pre">release-1.7.1</span></code> tag and build it.
-Remember to add its directory to <code class="docutils literal notranslate"><span class="pre">PATH</span></code> and the built libraries to <code class="docutils literal notranslate"><span class="pre">LD_LIBRARY_PATH</span></code>.</p>
-<p>To build SINGA with OpenCL support (tested on SINGA 1.1):</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cmake -DUSE_OPENCL=ON ..
-$ make
-</pre></div>
-</div>
-</div>
-<div class="section" id="use-mkldnn">
-<span id="use-mkldnn"></span><h4>USE_MKLDNN<a class="headerlink" href="#use-mkldnn" title="Permalink to this headline">¶</a></h4>
-<p>User can enable MKL-DNN to enhance the performance of CPU computation.</p>
-<p>Installation guide of MKL-DNN could be found <a class="reference external" href="https://github.com/intel/mkl-dnn#installation">here</a>.</p>
-<p>SINGA has been tested over MKL-DNN v0.17.2.</p>
-<p>To build SINGA with MKL-DNN support:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># Dependent libs are installed already
-$ cmake -DUSE_MKLDNN=ON ..
-$ make
-</pre></div>
-</div>
-</div>
-<div class="section" id="package">
-<span id="package"></span><h4>PACKAGE<a class="headerlink" href="#package" title="Permalink to this headline">¶</a></h4>
-<p>This setting is used to build the Debian package. Set PACKAGE=ON and build the package with make command like this:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cmake -DPACKAGE=ON
-$ make package
+<p>If there is no error message from</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"from singa import tensor"</span>
</pre></div>
</div>
+<p>then SINGA is installed successfully.</p>
</div>
-</div>
-</div>
-<div class="section" id="faq">
-<span id="faq"></span><h2>FAQ<a class="headerlink" href="#faq" title="Permalink to this headline">¶</a></h2>
-<ul>
-<li><p class="first">Q: Error from ‘import singa’ using PySINGA installed from wheel.</p>
-<p>A: Please check the detailed error from <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-c</span> <span class="pre">"from</span> <span class="pre">singa</span> <span class="pre">import</span> <span class="pre">_singa_wrap"</span></code>. Sometimes it is
-caused by the dependent libraries, e.g. there are multiple versions of protobuf, missing of cudnn, numpy version mismatch. Following
-steps show the solutions for different cases</p>
+<div class="section" id="using-docker">
+<h2>Using Docker<a class="headerlink" href="#using-docker" title="Permalink to this headline">¶</a></h2>
+<p>Install Docker on your local host machine following the <a class="reference external" href="https://docs.docker.com/install/">instructions</a>. Add your user into the <a class="reference external" href="https://docs.docker.com/install/linux/linux-postinstall/">docker group</a> to run docker commands without <code class="docutils literal notranslate"><span class="pre">sudo</span></code>.</p>
<ol>
-<li><p class="first">Check the cudnn and cuda and gcc versions, cudnn5 and cuda7.5 and gcc4.8/4.9 are preferred. if gcc is 5.0, then downgrade it.
-If cudnn is missing or not match with the wheel version, you can download the correct version of cudnn into ~/local/cudnn/ and</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ echo "export LD_LIBRARY_PATH=/home/<yourname>/local/cudnn/lib64:$LD_LIBRARY_PATH" >> ~/.bashrc
+<li><p>CPU-only.</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">nightly</span><span class="o">-</span><span class="n">cpu</span> <span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">bash</span>
</pre></div>
</div>
</li>
-<li><p class="first">If it is the problem related to protobuf, then download the newest whl files which have <a class="reference external" href="https://issues.apache.org/jira/browse/SINGA-255">compiled protobuf and openblas into the whl</a> file of PySINGA.
-Or you can install protobuf from source into a local folder, say ~/local/;
-Decompress the tar file, and then</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ ./configure --prefix=/home/<yourname>local
- $ make && make install
- $ echo "export LD_LIBRARY_PATH=/home/<yourname>/local/lib:$LD_LIBRARY_PATH" >> ~/.bashrc
- $ source ~/.bashrc
+<li><p>With GPU enabled. Install <a class="reference external" href="https://github.com/NVIDIA/nvidia-docker">Nvidia-Docker</a> after install Docker.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">nvidia</span><span class="o">-</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">nightly</span><span class="o">-</span><span class="n">gpu</span> <span class="o">/</span><span class="nb">bin</span><span clas [...]
</pre></div>
</div>
</li>
-<li><p class="first">If it cannot find other libs including python, then create virtual env using pip or conda;</p>
-</li>
-<li><p class="first">If it is not caused by the above reasons, go to the folder of <code class="docutils literal notranslate"><span class="pre">_singa_wrap.so</span></code>,</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ python
- >> import importlib
- >> importlib.import_module('_singa_wrap')
+<li><p>For the complete list of SINGA Docker images (tags), visit the <a class="reference external" href="https://hub.docker.com/r/apache/singa/">docker hub site</a>. For each docker image, the tag is named as</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">version</span><span class="o">-</span><span class="p">(</span><span class="n">cpu</span><span class="o">|</span><span class="n">gpu</span><span class="p">)[</span><span class="o">-</span><span class="n">devel</span><span class="p">]</span>
</pre></div>
</div>
+<p>| Tag | Description| Example value|
+| — | — | — |
+| <code class="docutils literal notranslate"><span class="pre">version</span></code>| SINGA version | ‘nightly’, ‘2.0.0’, ‘1.2.0’|
+| <code class="docutils literal notranslate"><span class="pre">cpu</span></code> | the image cannot run on GPUs | ‘cpu’ |
+| <code class="docutils literal notranslate"><span class="pre">gpu</span></code> | the image can run on Nvidia GPUs| ‘gpu’, or ‘cudax.x-cudnnx.x’ e.g., ‘cuda10.0-cudnn7.3’|
+| <code class="docutils literal notranslate"><span class="pre">devel</span></code>| indicator for development|if absent SINGA Python package is installed for runtime only; if present, the building environment is also created, you can recompile SINGA from source at ‘/root/incubator-singa’
+|</p>
</li>
</ol>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Check</span> <span class="n">the</span> <span class="n">error</span> <span class="n">message</span><span class="o">.</span> <span class="n">For</span> <span class="n">example</span><span class="p">,</span> <span class="k">if</span> <span class="n">the</span> <span class="n">numpy</span> <span class="n">version</span> <span class="n">mismatches</span><span class="p">,</span> <span class="n" [...]
-
- <span class="ne">RuntimeError</span><span class="p">:</span> <span class="n">module</span> <span class="n">compiled</span> <span class="n">against</span> <span class="n">API</span> <span class="n">version</span> <span class="mh">0xb</span> <span class="n">but</span> <span class="n">this</span> <span class="n">version</span> <span class="n">of</span> <span class="n">numpy</span> <span class="ow">is</span> <span class="mh">0xa</span>
-
-<span class="n">Then</span> <span class="n">you</span> <span class="n">need</span> <span class="n">to</span> <span class="n">upgrade</span> <span class="n">the</span> <span class="n">numpy</span><span class="o">.</span>
-</pre></div>
</div>
-</li>
-</ul>
-<ul>
-<li><p class="first">Q: Error from running <code class="docutils literal notranslate"><span class="pre">cmake</span> <span class="pre">..</span></code>, which cannot find the dependent libraries.</p>
-<p>A: If you haven’t installed the libraries, install them. If you installed
-the libraries in a folder that is outside of the system folder, e.g. /usr/local,
-you need to export the following variables</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ export CMAKE_INCLUDE_PATH=<path to your header file folder>
- $ export CMAKE_LIBRARY_PATH=<path to your lib file folder>
-</pre></div>
-</div>
-</li>
-</ul>
-<ul>
-<li><p class="first">Q: Error from <code class="docutils literal notranslate"><span class="pre">make</span></code>, e.g. the linking phase</p>
-<p>A: If your libraries are in other folders than system default paths, you need
-to export the following varaibles</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ export LIBRARY_PATH=<path to your lib file folder>
- $ export LD_LIBRARY_PATH=<path to your lib file folder>
-</pre></div>
+<div class="section" id="from-source">
+<h2>From source<a class="headerlink" href="#from-source" title="Permalink to this headline">¶</a></h2>
+<p>You can <a class="reference internal" href="../develop/build.html"><span class="doc">build and install SINGA</span></a> from the source code using native building tools or conda-build, on local host OS or in a Docker container.</p>
</div>
-</li>
-</ul>
+<div class="section" id="faq">
+<h2>FAQ<a class="headerlink" href="#faq" title="Permalink to this headline">¶</a></h2>
<ul>
-<li><p class="first">Q: Error from header files, e.g. ‘cblas.h no such file or directory exists’</p>
-<p>A: You need to include the folder of the cblas.h into CPLUS_INCLUDE_PATH,
-e.g.,</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ export CPLUS_INCLUDE_PATH=/opt/OpenBLAS/include:$CPLUS_INCLUDE_PATH
+<li><p>Q: Error from <code class="docutils literal notranslate"><span class="pre">from</span> <span class="pre">singa</span> <span class="pre">import</span> <span class="pre">tensor</span></code></p>
+<p>A: Check the detailed error from</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"from singa import _singa_wrap"</span>
+<span class="c1"># go to the folder of _singa_wrap.so</span>
+<span class="n">ldd</span> <span class="n">path</span> <span class="n">to</span> <span class="n">_singa_wrap</span><span class="o">.</span><span class="n">so</span>
+<span class="n">python</span>
+<span class="o">>></span> <span class="kn">import</span> <span class="nn">importlib</span>
+<span class="o">>></span> <span class="n">importlib</span><span class="o">.</span><span class="n">import_module</span><span class="p">(</span><span class="s1">'_singa_wrap'</span><span class="p">)</span>
</pre></div>
</div>
-</li>
-<li><p class="first">Q:While compiling SINGA, I get error <code class="docutils literal notranslate"><span class="pre">SSE2</span> <span class="pre">instruction</span> <span class="pre">set</span> <span class="pre">not</span> <span class="pre">enabled</span></code></p>
-<p>A:You can try following command:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ make CFLAGS='-msse2' CXXFLAGS='-msse2'
+<p>The folder of <code class="docutils literal notranslate"><span class="pre">_singa_wrap.so</span></code> is like ‘ ~/miniconda3/lib/python3.7/site-packages/singa’.
+Normally, the error is caused by the mismatch or missing of dependent libraries, e.g. cuDNN or protobuf. The solution is to create a new virtual environment and install SINGA in that environment, e.g.,</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">conda</span> <span class="n">create</span> <span class="o">-</span><span class="n">n</span> <span class="n">singa</span>
+ <span class="n">conda</span> <span class="n">activate</span> <span class="n">singa</span>
+ <span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">nusdbsystem</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">singa</span><span class="o">-</span><span class="n">cpu</span>
</pre></div>
</div>
</li>
-<li><p class="first">Q:I get <code class="docutils literal notranslate"><span class="pre">ImportError:</span> <span class="pre">cannot</span> <span class="pre">import</span> <span class="pre">name</span> <span class="pre">enum_type_wrapper</span></code> from google.protobuf.internal when I try to import .py files.</p>
-<p>A: You need to install the python binding of protobuf, which could be installed via</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ sudo apt-get install protobuf
-</pre></div>
-</div>
-<p>or from source</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ cd /PROTOBUF/SOURCE/FOLDER
- $ cd python
- $ python setup.py build
- $ python setup.py install
-</pre></div>
-</div>
+<li><p>Q: When using virtual environment, every time I install SINGA, numpy would be reinstalled. However, the numpy is not used when I run <code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">numpy</span></code></p>
+<p>A: It could be caused by the <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code> environment variable which should be set to empty when you are using virtual environment to avoid the conflicts with the path of the virtual environment.</p>
</li>
-<li><p class="first">Q: When I build OpenBLAS from source, I am told that I need a Fortran compiler.</p>
-<p>A: You can compile OpenBLAS by</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ make ONLY_CBLAS=1
-</pre></div>
-</div>
-<p>or install it using</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ sudo apt-get install libopenblas-dev
-</pre></div>
-</div>
-</li>
-<li><p class="first">Q: When I build protocol buffer, it reports that GLIBC++_3.4.20 not found in /usr/lib64/libstdc++.so.6.</p>
-<p>A: This means the linker found libstdc++.so.6 but that library
-belongs to an older version of GCC than was used to compile and link the
-program. The program depends on code defined in
-the newer libstdc++ that belongs to the newer version of GCC, so the linker
-must be told how to find the newer libstdc++ shared library.
-The simplest way to fix this is to find the correct libstdc++ and export it to
-LD_LIBRARY_PATH. For example, if GLIBC++_3.4.20 is listed in the output of the
-following command,</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ strings /usr/local/lib64/libstdc++.so.6|grep GLIBC++
-</pre></div>
-</div>
-<p>then you just set your environment variable as</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ export LD_LIBRARY_PATH=/usr/local/lib64:$LD_LIBRARY_PATH
-</pre></div>
-</div>
-</li>
-<li><p class="first">Q: When I build glog, it reports that “src/logging_unittest.cc:83:20: error: ‘gflags’ is not a namespace-name”</p>
-<p>A: It maybe that you have installed gflags with a different namespace such as “google”. so glog can’t find ‘gflags’ namespace.
-Because it is not necessary to have gflags to build glog. So you can change the configure.ac file to ignore gflags.</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="mf">1.</span> <span class="n">cd</span> <span class="n">to</span> <span class="n">glog</span> <span class="n">src</span> <span class="n">directory</span>
- <span class="mf">2.</span> <span class="n">change</span> <span class="n">line</span> <span class="mi">125</span> <span class="n">of</span> <span class="n">configure</span><span class="o">.</span><span class="n">ac</span> <span class="n">to</span> <span class="s2">"AC_CHECK_LIB(gflags, main, ac_cv_have_libgflags=0, ac_cv_have_libgflags=0)"</span>
- <span class="mf">3.</span> <span class="n">autoreconf</span>
-</pre></div>
-</div>
-<p>After this, you can build glog again.</p>
-</li>
-<li><p class="first">Q: When using virtual environment, everytime I run pip install, it would reinstall numpy. However, the numpy would not be used when I <code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">numpy</span></code></p>
-<p>A: It could be caused by the <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code> which should be set to empty when you are using virtual environment to avoid the conflicts with the path of
-the virtual environment.</p>
-</li>
-<li><p class="first">Q: When compiling PySINGA from source, there is a compilation error due to the missing of <numpy/objectarray.h></p>
-<p>A: Please install numpy and export the path of numpy header files as</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ export CPLUS_INCLUDE_PATH=`python -c "import numpy; print numpy.get_include()"`:$CPLUS_INCLUDE_PATH
-</pre></div>
-</div>
-</li>
-<li><p class="first">Q: When I run PySINGA in Mac OS X, I got the error “Fatal Python error: PyThreadState_Get: no current thread Abort trap: 6”</p>
-<p>A: This error happens typically when you have multiple version of Python on your system and you installed SINGA via pip (this problem is resolved for installation via conda),
-e.g, the one comes with the OS and the one installed by Homebrew. The Python linked by PySINGA must be the same as the Python interpreter.
-You can check your interpreter by <code class="docutils literal notranslate"><span class="pre">which</span> <span class="pre">python</span></code> and check the Python linked by PySINGA via <code class="docutils literal notranslate"><span class="pre">otool</span> <span class="pre">-L</span> <span class="pre"><path</span> <span class="pre">to</span> <span class="pre">_singa_wrap.so></span></code>.
-To fix this error, compile SINGA with the correct version of Python.
-In particular, if you build PySINGA from source, you need to specify the paths when invoking <a class="reference external" href="http://stackoverflow.com/questions/15291500/i-have-2-versions-of-python-installed-but-cmake-is-using-older-version-how-do">cmake</a></p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ cmake -DPYTHON_LIBRARY=`python-config --prefix`/lib/libpython2.7.dylib -DPYTHON_INCLUDE_DIR=`python-config --prefix`/include/python2.7/ ..
-</pre></div>
-</div>
-<p>If installed PySINGA from binary packages, e.g. debian or wheel, then you need to change the python interpreter, e.g., reset the $PATH to put the correct path of Python at the front position.</p>
+<li><p>Q: When I run SINGA in Mac OS X, I got the error “Fatal Python error: PyThreadState_Get: no current thread Abort trap: 6”</p>
+<p>A: This error happens typically when you have multiple versions of Python in your system, e.g, the one comes with the OS and the one installed by Homebrew. The Python linked by SINGA must be the same as the Python interpreter. You can check your interpreter by <code class="docutils literal notranslate"><span class="pre">which</span> <span class="pre">python</span></code> and check the Python linked by SINGA via <code class="docutils literal notranslate"><span class="pre">otool</span> [...]
+This problem should be resolved if SINGA is installation via conda.</p>
</li>
</ul>
</div>
@@ -609,7 +331,7 @@ In particular, if you build PySINGA from source, you need to specify the paths w
<a href="software_stack.html" class="btn btn-neutral float-right" title="Software Stack" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="index.html" class="btn btn-neutral" title="Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="index.html" class="btn btn-neutral float-left" title="Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -618,7 +340,7 @@ In particular, if you build PySINGA from source, you need to specify the paths w
<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>
@@ -635,36 +357,17 @@ In particular, if you build PySINGA from source, you need to specify the paths w
-
-
- <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>
@@ -674,8 +377,8 @@ In particular, if you build PySINGA from source, you need to specify the paths w
<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>
+ <dd><a href="../.././index.html">English</a></dd>
+ <dd><a href="../.././zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
@@ -684,8 +387,14 @@ In particular, if you build PySINGA from source, you need to specify the paths w
</dl>
</div>
- <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
-
+ <a href="http://incubator.apache.org/"> <img src= "../../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
+ <a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
+ <a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
+ <a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
+ <a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
+ <br>
<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>
diff --git a/en/docs/layer.html b/en/docs/layer.html
index 0a3615d..03dfb43 100644
--- a/en/docs/layer.html
+++ b/en/docs/layer.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Layer — incubator-singa 1.1.0 documentation</title>
+ <title>Layer — incubator-singa 2.0.0 documentation</title>
@@ -18,22 +18,26 @@
-
-
+ <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="FeedForward Net" href="net.html" />
- <link rel="prev" title="Tensor" href="tensor.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="../../_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 {
@@ -44,21 +48,16 @@
}
</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" >
@@ -67,7 +66,7 @@
- <img src="../_static/singa.png" class="logo" alt="Logo"/>
+ <img src="../../_static/singa.png" class="logo" alt="Logo"/>
</a>
@@ -82,7 +81,7 @@
<div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <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" />
@@ -99,39 +98,13 @@
- <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 current"><a class="current reference internal" href="#">Layer</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#module-singa.layer">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="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>
+ <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>
+<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</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>
@@ -187,8 +160,6 @@
<li><a href="../index.html">Docs</a> »</li>
- <li><a href="index.html">Documentation</a> »</li>
-
<li>Layer</li>
@@ -208,1116 +179,8 @@
<div class="section" id="layer">
<h1>Layer<a class="headerlink" href="#layer" title="Permalink to this headline">¶</a></h1>
-<div class="section" id="module-singa.layer">
-<span id="python-api"></span><h2>Python API<a class="headerlink" href="#module-singa.layer" title="Permalink to this headline">¶</a></h2>
-<p>Python layers wrap the C++ layers to provide simpler construction APIs.</p>
-<p>Example usages:</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">layer</span>
-<span class="kn">from</span> <span class="nn">singa</span> <span class="k">import</span> <span class="n">tensor</span>
-<span class="kn">from</span> <span class="nn">singa</span> <span class="k">import</span> <span class="n">device</span>
-
-<span class="n">layer</span><span class="o">.</span><span class="n">engine</span> <span class="o">=</span> <span class="s1">'cudnn'</span> <span class="c1"># to use cudnn layers</span>
-<span class="n">dev</span> <span class="o">=</span> <span class="n">device</span><span class="o">.</span><span class="n">create_cuda_gpu</span><span class="p">()</span>
-
-<span class="c1"># create a convolution layer</span>
-<span class="n">conv</span> <span class="o">=</span> <span class="n">layer</span><span class="o">.</span><span class="n">Conv2D</span><span class="p">(</span><span class="s1">'conv'</span><span class="p">,</span> <span class="mi">32</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">pad</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">inpu [...]
-
-<span class="c1"># init param values</span>
-<span class="n">w</span><span class="p">,</span> <span class="n">b</span> <span class="o">=</span> <span class="n">conv</span><span class="o">.</span><span class="n">param_values</span><span class="p">()</span>
-<span class="n">w</span><span class="o">.</span><span class="n">guassian</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mf">0.01</span><span class="p">)</span>
-<span class="n">b</span><span class="o">.</span><span class="n">set_value</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
-<span class="n">conv</span><span class="o">.</span><span class="n">to_device</span><span class="p">(</span><span class="n">dev</span><span class="p">)</span> <span class="c1"># move the layer data onto a CudaGPU device</span>
-
-<span class="n">x</span> <span class="o">=</span> <span class="n">tensor</span><span class="o">.</span><span class="n">Tensor</span><span class="p">((</span><span class="mi">3</span><span class="p">,</span> <span class="mi">32</span><span class="p">,</span> <span class="mi">32</span><span class="p">),</span> <span class="n">dev</span><span class="p">)</span>
-<span class="n">x</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
-<span class="n">y</span> <span class="o">=</span> <span class="n">conv</span><span class="o">.</span><span class="n">foward</span><span class="p">(</span><span class="kc">True</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
-
-<span class="n">dy</span> <span class="o">=</span> <span class="n">tensor</span><span class="o">.</span><span class="n">Tensor</span><span class="p">()</span>
-<span class="n">dy</span><span class="o">.</span><span class="n">reset_like</span><span class="p">(</span><span class="n">y</span><span class="p">)</span>
-<span class="n">dy</span><span class="o">.</span><span class="n">set_value</span><span class="p">(</span><span class="mf">0.1</span><span class="p">)</span>
-<span class="c1"># dp is a list of tensors for parameter gradients</span>
-<span class="n">dx</span><span class="p">,</span> <span class="n">dp</span> <span class="o">=</span> <span class="n">conv</span><span class="o">.</span><span class="n">backward</span><span class="p">(</span><span class="n">kTrain</span><span class="p">,</span> <span class="n">dy</span><span class="p">)</span>
-</pre></div>
-</div>
-<dl class="data">
-<dt id="singa.layer.engine">
-<code class="descclassname">singa.layer.</code><code class="descname">engine</code><em class="property"> = 'cudnn'</em><a class="headerlink" href="#singa.layer.engine" title="Permalink to this definition">¶</a></dt>
-<dd><p>engine is the prefix of layer identifier.</p>
-<p>The value could be one of [<strong>‘cudnn’, ‘singacpp’, ‘singacuda’, ‘singacl’</strong>], for
-layers implemented using the cudnn library, Cpp, Cuda and OpenCL respectively.
-For example, CudnnConvolution layer is identified by ‘cudnn_convolution’;
-‘singacpp_convolution’ is for Convolution layer;
-Some layers’ implementation use only Tensor functions, thererfore they are
-transparent to the underlying devices. For threse layers, they would have
-multiple identifiers, e.g., singacpp_dropout, singacuda_dropout and
-singacl_dropout are all for the Dropout layer. In addition, it has an extra
-identifier ‘singa’, i.e. ‘singa_dropout’ also stands for the Dropout layer.</p>
-<p>engine is case insensitive. Each python layer would create the correct specific
-layer using the engine attribute.</p>
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.Layer">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">Layer</code><span class="sig-paren">(</span><em>name</em>, <em>conf=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Layer" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<p>Base Python layer class.</p>
-<dl class="docutils">
-<dt>Typically, the life cycle of a layer instance includes:</dt>
-<dd><ol class="first last arabic simple">
-<li>construct layer without input_sample_shapes, goto 2;
-construct layer with input_sample_shapes, goto 3;</li>
-<li>call setup to create the parameters and setup other meta fields</li>
-<li>call forward or access layer members</li>
-<li>call backward and get parameters for update</li>
-</ol>
-</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>name</strong> (<em>str</em>) – layer name</td>
-</tr>
-</tbody>
-</table>
-<dl class="method">
-<dt id="singa.layer.Layer.setup">
-<code class="descname">setup</code><span class="sig-paren">(</span><em>in_shapes</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Layer.setup" title="Permalink to this definition">¶</a></dt>
-<dd><p>Call the C++ setup function to create params and set some meta data.</p>
-<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>in_shapes</strong> – if the layer accepts a single input Tensor, in_shapes is
-a single tuple specifying the inpute Tensor shape; if the layer
-accepts multiple input Tensor (e.g., the concatenation layer),
-in_shapes is a tuple of tuples, each for one input Tensor</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Layer.caffe_layer">
-<code class="descname">caffe_layer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Layer.caffe_layer" title="Permalink to this definition">¶</a></dt>
-<dd><p>Create a singa layer based on caffe layer configuration.</p>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Layer.get_output_sample_shape">
-<code class="descname">get_output_sample_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Layer.get_output_sample_shape" title="Permalink to this definition">¶</a></dt>
-<dd><p>Called after setup to get the shape of the output sample(s).</p>
-<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">Returns:</th><td class="field-body">a tuple for a single output Tensor or a list of tuples if this layer
-has multiple outputs</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Layer.param_names">
-<code class="descname">param_names</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Layer.param_names" title="Permalink to this definition">¶</a></dt>
-<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">Returns:</th><td class="field-body">a list of strings, one for the name of one parameter Tensor</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Layer.param_values">
-<code class="descname">param_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Layer.param_values" title="Permalink to this definition">¶</a></dt>
-<dd><p>Return param value tensors.</p>
-<p>Parameter tensors are not stored as layer members because cpp Tensor
-could be moved onto diff devices due to the change of layer device,
-which would result in inconsistency.</p>
-<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">Returns:</th><td class="field-body">a list of tensors, one for each paramter</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Layer.forward">
-<code class="descname">forward</code><span class="sig-paren">(</span><em>flag</em>, <em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Layer.forward" title="Permalink to this definition">¶</a></dt>
-<dd><p>Forward propagate through this layer.</p>
-<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 simple">
-<li><strong>flag</strong> – True (kTrain) for training (kEval); False for evaluating;
-other values for furture use.</li>
-<li><strong>x</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a><em> or </em><em>list<Tensor></em>) – an input tensor if the layer is
-connected from a single layer; a list of tensors if the layer
-is connected from multiple layers.</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a tensor if the layer is connected to a single layer; a list of
-tensors if the layer is connected to multiple layers;</p>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Layer.backward">
-<code class="descname">backward</code><span class="sig-paren">(</span><em>flag</em>, <em>dy</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Layer.backward" title="Permalink to this definition">¶</a></dt>
-<dd><p>Backward propagate gradients through this layer.</p>
-<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 simple">
-<li><strong>flag</strong> (<em>int</em>) – for future use.</li>
-<li><strong>dy</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a><em> or </em><em>list<Tensor></em>) – the gradient tensor(s) y w.r.t the
-objective loss</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><dx, <dp1, dp2..>>, dx is a (set of) tensor(s) for the gradient of x
-, dpi is the gradient of the i-th parameter</p>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Layer.to_device">
-<code class="descname">to_device</code><span class="sig-paren">(</span><em>device</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Layer.to_device" title="Permalink to this definition">¶</a></dt>
-<dd><p>Move layer state tensors onto the given device.</p>
-<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>device</strong> – swig converted device, created using singa.device</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Layer.as_type">
-<code class="descname">as_type</code><span class="sig-paren">(</span><em>dtype</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Layer.as_type" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.Dummy">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">Dummy</code><span class="sig-paren">(</span><em>name</em>, <em>input_sample_shape=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Dummy" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Layer" title="singa.layer.Layer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Layer</span></code></a></p>
-<p>A dummy layer that does nothing but just forwards/backwards the data
-(the input/output is a single tensor).</p>
-<dl class="method">
-<dt id="singa.layer.Dummy.get_output_sample_shape">
-<code class="descname">get_output_sample_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Dummy.get_output_sample_shape" title="Permalink to this definition">¶</a></dt>
-<dd><p>Called after setup to get the shape of the output sample(s).</p>
-<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">Returns:</th><td class="field-body">a tuple for a single output Tensor or a list of tuples if this layer
-has multiple outputs</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Dummy.setup">
-<code class="descname">setup</code><span class="sig-paren">(</span><em>input_sample_shape</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Dummy.setup" title="Permalink to this definition">¶</a></dt>
-<dd><p>Call the C++ setup function to create params and set some meta data.</p>
-<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>in_shapes</strong> – if the layer accepts a single input Tensor, in_shapes is
-a single tuple specifying the inpute Tensor shape; if the layer
-accepts multiple input Tensor (e.g., the concatenation layer),
-in_shapes is a tuple of tuples, each for one input Tensor</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Dummy.forward">
-<code class="descname">forward</code><span class="sig-paren">(</span><em>flag</em>, <em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Dummy.forward" title="Permalink to this definition">¶</a></dt>
-<dd><p>Return the input x</p>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Dummy.backward">
-<code class="descname">backward</code><span class="sig-paren">(</span><em>falg</em>, <em>dy</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Dummy.backward" title="Permalink to this definition">¶</a></dt>
-<dd><p>Return dy, []</p>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.Conv2D">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">Conv2D</code><span class="sig-paren">(</span><em>name</em>, <em>nb_kernels</em>, <em>kernel=3</em>, <em>stride=1</em>, <em>border_mode='same'</em>, <em>cudnn_prefer='fastest'</em>, <em>workspace_byte_limit=1024</em>, <em>data_format='NCHW'</em>, <em>use_bias=True</em>, <em>W_specs=None</em>, <em>b_specs=None</em>, <em>pad=None</em>, <em>input_sample_shape=None</em><span class="sig-paren" [...]
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Layer" title="singa.layer.Layer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Layer</span></code></a></p>
-<p>Construct a layer for 2D convolution.</p>
-<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>nb_kernels</strong> (<em>int</em>) – num of the channels (kernels) of the input Tensor</li>
-<li><strong>kernel</strong> – an integer or a pair of integers for kernel height and width</li>
-<li><strong>stride</strong> – an integer or a pair of integers for stride height and width</li>
-<li><strong>border_mode</strong> (<em>string</em>) – padding mode, case in-sensitive,
-‘valid’ -> padding is 0 for height and width
-‘same’ -> padding is half of the kernel (floor), the kernel must be
-odd number.</li>
-<li><strong>cudnn_prefer</strong> (<em>string</em>) – the preferred algorithm for cudnn convolution
-which could be ‘fastest’, ‘autotune’, ‘limited_workspace’ and
-‘no_workspace’</li>
-<li><strong>workspace_byte_limit</strong> (<em>int</em>) – max workspace size in MB (default is 512MB)</li>
-<li><strong>data_format</strong> (<em>string</em>) – either ‘NCHW’ or ‘NHWC’</li>
-<li><strong>use_bias</strong> (<em>bool</em>) – True or False</li>
-<li><strong>pad</strong> – an integer or a pair of integers for padding height and width</li>
-<li><strong>W_specs</strong> (<em>dict</em>) – used to specify the weight matrix specs, fields
-include,
-‘name’ for parameter name
-‘lr_mult’ for learning rate multiplier
-‘decay_mult’ for weight decay multiplier
-‘init’ for init method, which could be ‘gaussian’, ‘uniform’,
-‘xavier’ and ‘’
-‘std’, ‘mean’, ‘high’, ‘low’ for corresponding init methods
-TODO(wangwei) ‘clamp’ for gradient constraint, value is scalar
-‘regularizer’ for regularization, currently support ‘l2’</li>
-<li><strong>b_specs</strong> (<em>dict</em>) – hyper-parameters for bias vector, similar as W_specs</li>
-<li><strong>name</strong> (<em>string</em>) – layer name.</li>
-<li><strong>input_sample_shape</strong> – 3d tuple for the shape of the input Tensor
-without the batchsize, e.g., (channel, height, width) or
-(height, width, channel)</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-<dl class="method">
-<dt id="singa.layer.Conv2D.setup">
-<code class="descname">setup</code><span class="sig-paren">(</span><em>in_shape</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Conv2D.setup" title="Permalink to this definition">¶</a></dt>
-<dd><p>Set up the kernel, stride and padding; then call the C++ setup
-function to create params and set some meta data.</p>
-<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>is a tuple of int for the input sample shape</strong> (<em>in_shapes</em>) – </td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.Conv1D">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">Conv1D</code><span class="sig-paren">(</span><em>name</em>, <em>nb_kernels</em>, <em>kernel=3</em>, <em>stride=1</em>, <em>border_mode='same'</em>, <em>cudnn_prefer='fastest'</em>, <em>workspace_byte_limit=1024</em>, <em>use_bias=True</em>, <em>W_specs={'init': 'Xavier'}</em>, <em>b_specs={'init': 'Constant'</em>, <em>'value': 0}</em>, <em>pad=None</em>, <em>input_sample_shape=None</em>< [...]
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Conv2D" title="singa.layer.Conv2D"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Conv2D</span></code></a></p>
-<p>Construct a layer for 1D convolution.</p>
-<p>Most of the args are the same as those for Conv2D except the kernel,
-stride, pad, which is a scalar instead of a tuple.
-input_sample_shape is a tuple with a single value for the input feature
-length</p>
-<dl class="method">
-<dt id="singa.layer.Conv1D.get_output_sample_shape">
-<code class="descname">get_output_sample_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Conv1D.get_output_sample_shape" title="Permalink to this definition">¶</a></dt>
-<dd><p>Called after setup to get the shape of the output sample(s).</p>
-<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">Returns:</th><td class="field-body">a tuple for a single output Tensor or a list of tuples if this layer
-has multiple outputs</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.Pooling2D">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">Pooling2D</code><span class="sig-paren">(</span><em>name</em>, <em>mode</em>, <em>kernel=3</em>, <em>stride=2</em>, <em>border_mode='same'</em>, <em>pad=None</em>, <em>data_format='NCHW'</em>, <em>input_sample_shape=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Pooling2D" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Layer" title="singa.layer.Layer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Layer</span></code></a></p>
-<p>2D pooling layer providing max/avg pooling.</p>
-<p>All args are the same as those for Conv2D, except the following one</p>
-<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>mode</strong> – pooling type, model_pb2.PoolingConf.MAX or
-model_pb2.PoolingConf.AVE</td>
-</tr>
-</tbody>
-</table>
-<dl class="method">
-<dt id="singa.layer.Pooling2D.setup">
-<code class="descname">setup</code><span class="sig-paren">(</span><em>in_shape</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Pooling2D.setup" title="Permalink to this definition">¶</a></dt>
-<dd><p>Set up the kernel, stride and padding; then call the C++ setup
-function to create params and set some meta data.</p>
-<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>is a tuple of int for the input sample shape</strong> (<em>in_shapes</em>) – </td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.MaxPooling2D">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">MaxPooling2D</code><span class="sig-paren">(</span><em>name</em>, <em>kernel=3</em>, <em>stride=2</em>, <em>border_mode='same'</em>, <em>pad=None</em>, <em>data_format='NCHW'</em>, <em>input_sample_shape=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.MaxPooling2D" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Pooling2D" title="singa.layer.Pooling2D"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Pooling2D</span></code></a></p>
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.AvgPooling2D">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">AvgPooling2D</code><span class="sig-paren">(</span><em>name</em>, <em>kernel=3</em>, <em>stride=2</em>, <em>border_mode='same'</em>, <em>pad=None</em>, <em>data_format='NCHW'</em>, <em>input_sample_shape=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.AvgPooling2D" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Pooling2D" title="singa.layer.Pooling2D"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Pooling2D</span></code></a></p>
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.MaxPooling1D">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">MaxPooling1D</code><span class="sig-paren">(</span><em>name</em>, <em>kernel=3</em>, <em>stride=2</em>, <em>border_mode='same'</em>, <em>pad=None</em>, <em>data_format='NCHW'</em>, <em>input_sample_shape=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.MaxPooling1D" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.MaxPooling2D" title="singa.layer.MaxPooling2D"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.MaxPooling2D</span></code></a></p>
-<dl class="method">
-<dt id="singa.layer.MaxPooling1D.get_output_sample_shape">
-<code class="descname">get_output_sample_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.MaxPooling1D.get_output_sample_shape" title="Permalink to this definition">¶</a></dt>
-<dd><p>Called after setup to get the shape of the output sample(s).</p>
-<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">Returns:</th><td class="field-body">a tuple for a single output Tensor or a list of tuples if this layer
-has multiple outputs</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.AvgPooling1D">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">AvgPooling1D</code><span class="sig-paren">(</span><em>name</em>, <em>kernel=3</em>, <em>stride=2</em>, <em>border_mode='same'</em>, <em>pad=None</em>, <em>data_format='NCHW'</em>, <em>input_sample_shape=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.AvgPooling1D" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.AvgPooling2D" title="singa.layer.AvgPooling2D"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.AvgPooling2D</span></code></a></p>
-<dl class="method">
-<dt id="singa.layer.AvgPooling1D.get_output_sample_shape">
-<code class="descname">get_output_sample_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.AvgPooling1D.get_output_sample_shape" title="Permalink to this definition">¶</a></dt>
-<dd><p>Called after setup to get the shape of the output sample(s).</p>
-<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">Returns:</th><td class="field-body">a tuple for a single output Tensor or a list of tuples if this layer
-has multiple outputs</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.BatchNormalization">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">BatchNormalization</code><span class="sig-paren">(</span><em>name</em>, <em>momentum=0.9</em>, <em>beta_specs=None</em>, <em>gamma_specs=None</em>, <em>input_sample_shape=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.BatchNormalization" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Layer" title="singa.layer.Layer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Layer</span></code></a></p>
-<p>Batch-normalization.</p>
-<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>momentum</strong> (<em>float</em>) – for running average mean and variance.</li>
-<li><strong>beta_specs</strong> (<em>dict</em>) – dictionary includes the fields for the beta
-param:
-‘name’ for parameter name
-‘lr_mult’ for learning rate multiplier
-‘decay_mult’ for weight decay multiplier
-‘init’ for init method, which could be ‘gaussian’, ‘uniform’,
-‘xavier’ and ‘’
-‘std’, ‘mean’, ‘high’, ‘low’ for corresponding init methods
-‘clamp’ for gradient constraint, value is scalar
-‘regularizer’ for regularization, currently support ‘l2’</li>
-<li><strong>gamma_specs</strong> (<em>dict</em>) – similar to beta_specs, but for the gamma param.</li>
-<li><strong>name</strong> (<em>string</em>) – layer name</li>
-<li><strong>input_sample_shape</strong> (<em>tuple</em>) – with at least one integer</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.L2Norm">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">L2Norm</code><span class="sig-paren">(</span><em>name</em>, <em>input_sample_shape</em>, <em>epsilon=1e-08</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.L2Norm" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Layer" title="singa.layer.Layer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Layer</span></code></a></p>
-<p>Normalize each sample to have L2 norm = 1</p>
-<dl class="method">
-<dt id="singa.layer.L2Norm.get_output_sample_shape">
-<code class="descname">get_output_sample_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.L2Norm.get_output_sample_shape" title="Permalink to this definition">¶</a></dt>
-<dd><p>Called after setup to get the shape of the output sample(s).</p>
-<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">Returns:</th><td class="field-body">a tuple for a single output Tensor or a list of tuples if this layer
-has multiple outputs</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.L2Norm.forward">
-<code class="descname">forward</code><span class="sig-paren">(</span><em>is_train</em>, <em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.L2Norm.forward" title="Permalink to this definition">¶</a></dt>
-<dd><p>Forward propagate through this layer.</p>
-<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 simple">
-<li><strong>flag</strong> – True (kTrain) for training (kEval); False for evaluating;
-other values for furture use.</li>
-<li><strong>x</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a><em> or </em><em>list<Tensor></em>) – an input tensor if the layer is
-connected from a single layer; a list of tensors if the layer
-is connected from multiple layers.</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a tensor if the layer is connected to a single layer; a list of
-tensors if the layer is connected to multiple layers;</p>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.L2Norm.backward">
-<code class="descname">backward</code><span class="sig-paren">(</span><em>is_train</em>, <em>dy</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.L2Norm.backward" title="Permalink to this definition">¶</a></dt>
-<dd><p>Backward propagate gradients through this layer.</p>
-<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 simple">
-<li><strong>flag</strong> (<em>int</em>) – for future use.</li>
-<li><strong>dy</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a><em> or </em><em>list<Tensor></em>) – the gradient tensor(s) y w.r.t the
-objective loss</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><dx, <dp1, dp2..>>, dx is a (set of) tensor(s) for the gradient of x
-, dpi is the gradient of the i-th parameter</p>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.LRN">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">LRN</code><span class="sig-paren">(</span><em>name</em>, <em>size=5</em>, <em>alpha=1</em>, <em>beta=0.75</em>, <em>mode='cross_channel'</em>, <em>k=1</em>, <em>input_sample_shape=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.LRN" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Layer" title="singa.layer.Layer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Layer</span></code></a></p>
-<p>Local response normalization.</p>
-<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>size</strong> (<em>int</em>) – # of channels to be crossed
-normalization.</li>
-<li><strong>mode</strong> (<em>string</em>) – ‘cross_channel’</li>
-<li><strong>input_sample_shape</strong> (<em>tuple</em>) – 3d tuple, (channel, height, width)</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.Dense">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">Dense</code><span class="sig-paren">(</span><em>name</em>, <em>num_output</em>, <em>use_bias=True</em>, <em>W_specs=None</em>, <em>b_specs=None</em>, <em>W_transpose=False</em>, <em>input_sample_shape=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Dense" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Layer" title="singa.layer.Layer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Layer</span></code></a></p>
-<p>Apply linear/affine transformation, also called inner-product or
-fully connected layer.</p>
-<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_output</strong> (<em>int</em>) – output feature length.</li>
-<li><strong>use_bias</strong> (<em>bool</em>) – add a bias vector or not to the transformed feature</li>
-<li><strong>W_specs</strong> (<em>dict</em>) – specs for the weight matrix
-‘name’ for parameter name
-‘lr_mult’ for learning rate multiplier
-‘decay_mult’ for weight decay multiplier
-‘init’ for init method, which could be ‘gaussian’, ‘uniform’,
-‘xavier’ and ‘’
-‘std’, ‘mean’, ‘high’, ‘low’ for corresponding init methods
-‘clamp’ for gradient constraint, value is scalar
-‘regularizer’ for regularization, currently support ‘l2’</li>
-<li><strong>b_specs</strong> (<em>dict</em>) – specs for the bias vector, same fields as W_specs.</li>
-<li><strong>W_transpose</strong> (<em>bool</em>) – if true, output=x*W.T+b;</li>
-<li><strong>input_sample_shape</strong> (<em>tuple</em>) – input feature length</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.Dropout">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">Dropout</code><span class="sig-paren">(</span><em>name</em>, <em>p=0.5</em>, <em>input_sample_shape=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Dropout" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Layer" title="singa.layer.Layer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Layer</span></code></a></p>
-<p>Droput layer.</p>
-<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>p</strong> (<em>float</em>) – probability for dropping out the element, i.e., set to 0</li>
-<li><strong>name</strong> (<em>string</em>) – layer name</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.Activation">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">Activation</code><span class="sig-paren">(</span><em>name</em>, <em>mode='relu'</em>, <em>input_sample_shape=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Activation" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Layer" title="singa.layer.Layer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Layer</span></code></a></p>
-<p>Activation layers.</p>
-<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>name</strong> (<em>string</em>) – layer name</li>
-<li><strong>mode</strong> (<em>string</em>) – ‘relu’, ‘sigmoid’, or ‘tanh’</li>
-<li><strong>input_sample_shape</strong> (<em>tuple</em>) – shape of a single sample</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.Softmax">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">Softmax</code><span class="sig-paren">(</span><em>name</em>, <em>axis=1</em>, <em>input_sample_shape=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Softmax" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Layer" title="singa.layer.Layer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Layer</span></code></a></p>
-<p>Apply softmax.</p>
-<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>axis</strong> (<em>int</em>) – reshape the input as a matrix with the dimension
-[0,axis) as the row, the [axis, -1) as the column.</li>
-<li><strong>input_sample_shape</strong> (<em>tuple</em>) – shape of a single sample</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.Flatten">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">Flatten</code><span class="sig-paren">(</span><em>name</em>, <em>axis=1</em>, <em>input_sample_shape=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Flatten" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Layer" title="singa.layer.Layer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Layer</span></code></a></p>
-<p>Reshape the input tensor into a matrix.</p>
-<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>axis</strong> (<em>int</em>) – reshape the input as a matrix with the dimension
-[0,axis) as the row, the [axis, -1) as the column.</li>
-<li><strong>input_sample_shape</strong> (<em>tuple</em>) – shape for a single sample</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.Merge">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">Merge</code><span class="sig-paren">(</span><em>name</em>, <em>input_sample_shape=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Merge" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Layer" title="singa.layer.Layer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Layer</span></code></a></p>
-<p>Sum all input tensors.</p>
-<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>input_sample_shape</strong> – sample shape of the input. The sample shape of all
-inputs should be the same.</td>
-</tr>
-</tbody>
-</table>
-<dl class="method">
-<dt id="singa.layer.Merge.setup">
-<code class="descname">setup</code><span class="sig-paren">(</span><em>in_shape</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Merge.setup" title="Permalink to this definition">¶</a></dt>
-<dd><p>Call the C++ setup function to create params and set some meta data.</p>
-<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>in_shapes</strong> – if the layer accepts a single input Tensor, in_shapes is
-a single tuple specifying the inpute Tensor shape; if the layer
-accepts multiple input Tensor (e.g., the concatenation layer),
-in_shapes is a tuple of tuples, each for one input Tensor</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Merge.get_output_sample_shape">
-<code class="descname">get_output_sample_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Merge.get_output_sample_shape" title="Permalink to this definition">¶</a></dt>
-<dd><p>Called after setup to get the shape of the output sample(s).</p>
-<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">Returns:</th><td class="field-body">a tuple for a single output Tensor or a list of tuples if this layer
-has multiple outputs</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Merge.forward">
-<code class="descname">forward</code><span class="sig-paren">(</span><em>flag</em>, <em>inputs</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Merge.forward" title="Permalink to this definition">¶</a></dt>
-<dd><p>Merge all input tensors by summation.</p>
-<p>TODO(wangwei) do element-wise merge operations, e.g., avg, count
-:param flag: not used.
-:param inputs: a list of tensors
-:type inputs: list</p>
-<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">Returns:</th><td class="field-body">A single tensor as the sum of all input tensors</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Merge.backward">
-<code class="descname">backward</code><span class="sig-paren">(</span><em>flag</em>, <em>grad</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Merge.backward" title="Permalink to this definition">¶</a></dt>
-<dd><p>Replicate the grad for each input source layer.</p>
-<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>grad</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) – </td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A list of replicated grad, one per source layer</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.Split">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">Split</code><span class="sig-paren">(</span><em>name</em>, <em>num_output</em>, <em>input_sample_shape=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Split" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Layer" title="singa.layer.Layer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Layer</span></code></a></p>
-<p>Replicate the input tensor.</p>
-<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_output</strong> (<em>int</em>) – number of output tensors to generate.</li>
-<li><strong>input_sample_shape</strong> – includes a single integer for the input sample
-feature size.</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-<dl class="method">
-<dt id="singa.layer.Split.setup">
-<code class="descname">setup</code><span class="sig-paren">(</span><em>in_shape</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Split.setup" title="Permalink to this definition">¶</a></dt>
-<dd><p>Call the C++ setup function to create params and set some meta data.</p>
-<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>in_shapes</strong> – if the layer accepts a single input Tensor, in_shapes is
-a single tuple specifying the inpute Tensor shape; if the layer
-accepts multiple input Tensor (e.g., the concatenation layer),
-in_shapes is a tuple of tuples, each for one input Tensor</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Split.get_output_sample_shape">
-<code class="descname">get_output_sample_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Split.get_output_sample_shape" title="Permalink to this definition">¶</a></dt>
-<dd><p>Called after setup to get the shape of the output sample(s).</p>
-<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">Returns:</th><td class="field-body">a tuple for a single output Tensor or a list of tuples if this layer
-has multiple outputs</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Split.forward">
-<code class="descname">forward</code><span class="sig-paren">(</span><em>flag</em>, <em>input</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Split.forward" title="Permalink to this definition">¶</a></dt>
-<dd><p>Replicate the input tensor into mutiple tensors.</p>
-<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 simple">
-<li><strong>flag</strong> – not used</li>
-<li><strong>input</strong> – a single input tensor</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list a output tensor (each one is a copy of the input)</p>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Split.backward">
-<code class="descname">backward</code><span class="sig-paren">(</span><em>flag</em>, <em>grads</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Split.backward" title="Permalink to this definition">¶</a></dt>
-<dd><p>Sum all grad tensors to generate a single output tensor.</p>
-<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>grads</strong> (<em>list of Tensor</em>) – </td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a single tensor as the sum of all grads</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.Concat">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">Concat</code><span class="sig-paren">(</span><em>name</em>, <em>axis</em>, <em>input_sample_shapes=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Concat" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Layer" title="singa.layer.Layer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Layer</span></code></a></p>
-<p>Concatenate tensors vertically (axis = 0) or horizontally (axis = 1).</p>
-<p>Currently, only support tensors with 2 dimensions.</p>
-<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>axis</strong> (<em>int</em>) – 0 for concat row; 1 for concat columns;</li>
-<li><strong>input_sample_shapes</strong> – a list of sample shape tuples, one per input tensor</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-<dl class="method">
-<dt id="singa.layer.Concat.forward">
-<code class="descname">forward</code><span class="sig-paren">(</span><em>flag</em>, <em>inputs</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Concat.forward" title="Permalink to this definition">¶</a></dt>
-<dd><p>Concatenate all input tensors.</p>
-<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 simple">
-<li><strong>flag</strong> – same as Layer::forward()</li>
-<li><strong>input</strong> – a list of tensors</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a single concatenated tensor</p>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Concat.backward">
-<code class="descname">backward</code><span class="sig-paren">(</span><em>flag</em>, <em>dy</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Concat.backward" title="Permalink to this definition">¶</a></dt>
-<dd><p>Backward propagate gradients through this layer.</p>
-<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 simple">
-<li><strong>flag</strong> – same as Layer::backward()</li>
-<li><strong>dy</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) – the gradient tensors of y w.r.t objective loss</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><dl class="docutils">
-<dt><dx, []>, dx is a list tensors for the gradient of the inputs; []</dt>
-<dd><p class="first last">is an empty list.</p>
-</dd>
-</dl>
-</p>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.Slice">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">Slice</code><span class="sig-paren">(</span><em>name</em>, <em>axis</em>, <em>slice_point</em>, <em>input_sample_shape=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Slice" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Layer" title="singa.layer.Layer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Layer</span></code></a></p>
-<p>Slice the input tensor into multiple sub-tensors vertially (axis=0) or
-horizontally (axis=1).</p>
-<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>axis</strong> (<em>int</em>) – 0 for slice rows; 1 for slice columns;</li>
-<li><strong>slice_point</strong> (<em>list</em>) – positions along the axis to do slice; there are n-1
-points for n sub-tensors;</li>
-<li><strong>input_sample_shape</strong> – input tensor sample shape</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-<dl class="method">
-<dt id="singa.layer.Slice.get_output_sample_shape">
-<code class="descname">get_output_sample_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Slice.get_output_sample_shape" title="Permalink to this definition">¶</a></dt>
-<dd><p>Called after setup to get the shape of the output sample(s).</p>
-<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">Returns:</th><td class="field-body">a tuple for a single output Tensor or a list of tuples if this layer
-has multiple outputs</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Slice.forward">
-<code class="descname">forward</code><span class="sig-paren">(</span><em>flag</em>, <em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Slice.forward" title="Permalink to this definition">¶</a></dt>
-<dd><p>Slice the input tensor on the given axis.</p>
-<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 simple">
-<li><strong>flag</strong> – same as Layer::forward()</li>
-<li><strong>x</strong> – a single input tensor</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list a output tensor</p>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="method">
-<dt id="singa.layer.Slice.backward">
-<code class="descname">backward</code><span class="sig-paren">(</span><em>flag</em>, <em>grads</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Slice.backward" title="Permalink to this definition">¶</a></dt>
-<dd><p>Concate all grad tensors to generate a single output tensor</p>
-<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 simple">
-<li><strong>flag</strong> – same as Layer::backward()</li>
-<li><strong>grads</strong> – a list of tensors, one for the gradient of one sliced tensor</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><dl class="docutils">
-<dt>a single tensor for the gradient of the original user, and an empty</dt>
-<dd><p class="first last">list.</p>
-</dd>
-</dl>
-</p>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="singa.layer.RNN">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">RNN</code><span class="sig-paren">(</span><em>name</em>, <em>hidden_size</em>, <em>rnn_mode='lstm'</em>, <em>dropout=0.0</em>, <em>num_stacks=1</em>, <em>input_mode='linear'</em>, <em>bidirectional=False</em>, <em>param_specs=None</em>, <em>input_sample_shape=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.RNN" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#singa.layer.Layer" title="singa.layer.Layer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.layer.Layer</span></code></a></p>
-<p>Recurrent layer with 4 types of units, namely lstm, gru, tanh and relu.</p>
-<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>hidden_size</strong> – hidden feature size, the same for all stacks of layers.</li>
-<li><strong>rnn_mode</strong> – decides the rnn unit, which could be one of ‘lstm’, ‘gru’,
-‘tanh’ and ‘relu’, refer to cudnn manual for each mode.</li>
-<li><strong>num_stacks</strong> – num of stacks of rnn layers. It is different to the
-unrolling seqence length.</li>
-<li><strong>input_mode</strong> – ‘linear’ convert the input feature x by by a linear
-transformation to get a feature vector of size hidden_size;
-‘skip’ does nothing but requires the input feature size equals
-hidden_size</li>
-<li><strong>bidirection</strong> – True for bidirectional RNN</li>
-<li><strong>param_specs</strong> – config for initializing the RNN parameters.</li>
-<li><strong>input_sample_shape</strong> – includes a single integer for the input sample
-feature size.</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-<dl class="method">
-<dt id="singa.layer.RNN.forward">
-<code class="descname">forward</code><span class="sig-paren">(</span><em>flag</em>, <em>inputs</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.RNN.forward" title="Permalink to this definition">¶</a></dt>
-<dd><p>Forward inputs through the RNN.</p>
-<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 simple">
-<li><strong>flag</strong> – True(kTrain) for training; False(kEval) for evaluation;
-others values for future use.</li>
-<li><strong><x1</strong><strong>, </strong><strong>x2</strong><strong>,</strong><strong>..xn</strong><strong>, </strong><strong>hx</strong><strong>, </strong><strong>cx></strong><strong>, </strong><strong>where xi is the input tensor for the</strong> (<em>inputs</em><em>,</em>) – i-th position, its shape is (batch_size, input_feature_length);
-the batch_size of xi must >= that of xi+1; hx is the initial
-hidden state of shape (num_stacks * bidirection?2:1, batch_size,
-hidden_size). cx is the initial cell state tensor of the same
-shape as hy. cx is valid for only lstm. For other RNNs there is
-no cx. Both hx and cx could be dummy tensors without shape and
-data.</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><dl class="docutils">
-<dt><y1, y2, … yn, hy, cy>, where yi is the output tensor for the i-th</dt>
-<dd><p class="first last">position, its shape is (batch_size,
-hidden_size * bidirection?2:1). hy is the final hidden state
-tensor. cx is the final cell state tensor. cx is only used for
-lstm.</p>
-</dd>
-</dl>
... 10006 lines suppressed ...