You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@singa.apache.org by wa...@apache.org on 2018/12/13 04:18:18 UTC
svn commit: r1848817 [2/7] - in /incubator/singa/site/trunk: en/
en/_sources/ en/_sources/community/ en/_sources/develop/ en/_sources/docs/
en/_sources/docs/model_zoo/ en/_sources/docs/model_zoo/examples/caffe/
en/_sources/docs/model_zoo/examples/char-...
Added: incubator/singa/site/trunk/en/develop/how-to-release.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/develop/how-to-release.html?rev=1848817&view=auto
==============================================================================
--- incubator/singa/site/trunk/en/develop/how-to-release.html (added)
+++ incubator/singa/site/trunk/en/develop/how-to-release.html Thu Dec 13 04:18:16 2018
@@ -0,0 +1,491 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>How to prepare a release — incubator-singa 1.1.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <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 rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous">
+ <style>
+ .fa:hover {
+ opacity: 0.7;
+ }
+ .fab:hover {
+ opacity: 0.7;
+ }
+ </style>
+
+
+
+ <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">
+
+
+
+ <a href="../index.html" class="icon icon-home"> incubator-singa
+
+
+
+
+ <img src="../_static/singa.png" class="logo" alt="Logo"/>
+
+ </a>
+
+
+
+
+ <div class="version">
+ latest
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../docs/index.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Development</span></p>
+<ul 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="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>
+<li class="toctree-l2"><a class="reference internal" href="#select-a-release-manager">Select a release manager</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#prepare-license-file">Prepare LICENSE file</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#prepare-notice-file">Prepare NOTICE file</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#prepare-release-notes-file">Prepare RELEASE_NOTES file</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#prepare-readme-file">Prepare README file</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#prepare-disclaimer-file">Prepare DISCLAIMER file</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#package-the-release">Package the release</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#upload-the-release">Upload the release</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#roll-out-artifacts-to-mirrors">Roll out artifacts to mirrors</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#update-the-download-page">Update the Download page</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#make-the-internal-announcements">Make the internal announcements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#call-a-vote-in-dev">Call a vote in dev</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#vote-check">Vote Check</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#call-for-a-vote-in-apache-ipmc">Call for a vote in Apache IPMC</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#vote-result-mail">Vote result mail</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#publish-release">Publish release</a></li>
+</ul>
+</li>
+</ul>
+<p class="caption"><span class="caption-text">Community</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../community/source-repository.html">Source Repository</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/mail-lists.html">Project Mailing Lists</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/issue-tracking.html">Issue Tracking</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/team-list.html">The SINGA Team</a></li>
+</ul>
+
+
+
+ </div>
+ </div>
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" aria-label="top navigation">
+
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">incubator-singa</a>
+
+ </nav>
+
+
+ <div class="wy-nav-content">
+
+ <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+ <ul class="wy-breadcrumbs">
+
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li>How to prepare a release</li>
+
+
+ <li class="wy-breadcrumbs-aside">
+
+
+
+ </li>
+
+ </ul>
+
+
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="how-to-prepare-a-release">
+<h1>How to prepare a release<a class="headerlink" href="#how-to-prepare-a-release" title="Permalink to this headline">¶</a></h1>
+<p>This is a guide for the release preparing process in SINGA.</p>
+<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/dev/release-signing.html</a></p>
+<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>
+</ul>
+</dd>
+</dl>
+</div>
+<div class="section" id="prepare-license-file">
+<h2>Prepare LICENSE file<a class="headerlink" href="#prepare-license-file" title="Permalink to this headline">¶</a></h2>
+<p>copy and paste this <a class="reference external" href="http://apache.org/licenses/LICENSE-2.0.txt">http://apache.org/licenses/LICENSE-2.0.txt</a></p>
+</div>
+<div class="section" id="prepare-notice-file">
+<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>
+</ul>
+</div></blockquote>
+</div>
+<div class="section" id="prepare-release-notes-file">
+<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>
+</ul>
+</div></blockquote>
+</div>
+<div class="section" id="prepare-readme-file">
+<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>
+</ul>
+</div></blockquote>
+</div>
+<div class="section" id="prepare-disclaimer-file">
+<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>
+</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>
+</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>
+</ul>
+</dd>
+</dl>
+</div>
+<div class="section" id="roll-out-artifacts-to-mirrors">
+<h2>Roll out artifacts to mirrors<a class="headerlink" href="#roll-out-artifacts-to-mirrors" title="Permalink to this headline">¶</a></h2>
+<p>svn add to âdist/release/incubator/singaâ</p>
+<p>Delete old artifacts (automatically archived)</p>
+</div>
+<div class="section" id="update-the-download-page">
+<h2>Update the Download page<a class="headerlink" href="#update-the-download-page" title="Permalink to this headline">¶</a></h2>
+<p>The tar.gz file MUST be downloaded from mirror, using closer.cgi script
+other artifacts MUST be downloaded from main Apache site
+Good idea to update EC2 image and make it available for download as well</p>
+</div>
+<div class="section" id="make-the-internal-announcements">
+<h2>Make the internal announcements<a class="headerlink" href="#make-the-internal-announcements" title="Permalink to this headline">¶</a></h2>
+<p>Template for singa-dev@ voting:</p>
+<p>To: <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>
+Subject: [VOTE] Release apache-singa-X.Y.Z-incubating (release candidate N)</p>
+<p>Hi all,</p>
+<p>I have created a build for Apache SINGA X.Y.Z-incubating, release candidate N.</p>
+<p>The artifacts to be voted on are located here:
+<a class="reference external" href="https://dist.apache.org/repos/dist/dev/incubator/singa/apache-singa-X.Y.Z-incubating-rcN/">https://dist.apache.org/repos/dist/dev/incubator/singa/apache-singa-X.Y.Z-incubating-rcN/</a></p>
+<p>The hashes of the artifacts are as follows:
+apache-singa-X.Y.Z-incubating.tar.gz.md5 XXXX
+apache-singa-X.Y.Z-incubating.tar.gz.sha256 XXXX</p>
+<p>Release artifacts are signed with the following key:
+<a class="reference external" href="https://people.apache.org/keys/committer">https://people.apache.org/keys/committer</a>/{Apache ID of the Release Manager}.asc</p>
+<p>and the signature file is:
+apache-singa-X.Y.Z-incubating.tar.gz.asc</p>
+<p>Please vote on releasing this package. The vote is open for at least 72 hours and passes if a majority of at least three +1 votes are cast.</p>
+<p>[ ] +1 Release this package as Apache SINGA X.Y.Z-incubating
+[ ] 0 I donât feel strongly about it, but Iâm okay with the release
+[ ] -1 Do not release this package becauseâ¦</p>
+<p>Here is my vote:</p>
+<p>+1</p>
+<p>{SINGA Team Member Name}</p>
+<p>Wait at least 48 hours for test responses</p>
+<p>Any PPMC, committer or contributor can test features for releasing, and feedback. Based on that, PPMC will decide whether start a vote.</p>
+</div>
+<div class="section" id="call-a-vote-in-dev">
+<h2>Call a vote in dev<a class="headerlink" href="#call-a-vote-in-dev" title="Permalink to this headline">¶</a></h2>
+<p>Call a vote in <a class="reference external" href="mailto:dev%40singa.apache.org">dev<span>@</span>singa<span>.</span>apache<span>.</span>org</a></p>
+</div>
+<div class="section" id="vote-check">
+<h2>Vote Check<a class="headerlink" href="#vote-check" title="Permalink to this headline">¶</a></h2>
+<p>All PPMC members and committers should check these before vote +1 :</p>
+</div>
+<div class="section" id="call-for-a-vote-in-apache-ipmc">
+<h2>Call for a vote in Apache IPMC<a class="headerlink" href="#call-for-a-vote-in-apache-ipmc" title="Permalink to this headline">¶</a></h2>
+<p>Call a vote in <a class="reference external" href="mailto:general%40incubator.apache.org">general<span>@</span>incubator<span>.</span>apache<span>.</span>org</a></p>
+</div>
+<div class="section" id="vote-result-mail">
+<h2>Vote result mail<a class="headerlink" href="#vote-result-mail" title="Permalink to this headline">¶</a></h2>
+<p>Template for singa-dev@ voting (results):</p>
+<p>Subject: [RESULT] [VOTE] Release apache-singa-X.Y.Z-incubating (release candidate N)
+To: <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>
+<p>Thanks to everyone who has voted and given their comments. The tally is as follows.</p>
+<p>N binding +1s:
+<names></p>
+<p>N non-binding +1s:
+<names></p>
+<p>No 0s or -1s.</p>
+<p>I am delighted to announce that the proposal to release
+Apache SINGA X.Y.Z-incubating has passed.</p>
+<p>Iâll now start a vote on the general list. Those of you in the IPMC, please recast your vote on the new thread.</p>
+<p>{SINGA Team Member Name}</p>
+<p>Template for general@ voting - results</p>
+<p>To: <a class="reference external" href="mailto:general%40incubator.apache.org">general<span>@</span>incubator<span>.</span>apache<span>.</span>org</a>
+Subject: [RESULT] [VOTE] Release Apache SINGA X.Y.Z (incubating)</p>
+<p>Thanks everyone for their votes and comments.</p>
+<p>Iâm delighted to announce that this vote passes with the following results:</p>
+<p>N binding +1s:
+<names></p>
+<p>N non-binding +1s:
+<names></p>
+<p>No 0s or -1s.</p>
+<p>Weâll now roll the release out to the mirrors.</p>
+<p>{SINGA Team Member Name}</p>
+</div>
+<div class="section" id="publish-release">
+<h2>Publish release<a class="headerlink" href="#publish-release" title="Permalink to this headline">¶</a></h2>
+<p>Template for ANNOUNCING the release</p>
+<p>To: <a class="reference external" href="mailto:announce%40apache.org">announce<span>@</span>apache<span>.</span>org</a>, <a class="reference external" href="mailto:dev%40singa.apache.org">dev<span>@</span>singa<span>.</span>apache<span>.</span>org</a>
+Subject: [ANNOUNCE] Apache SINGA (incubating) X.Y.Z released</p>
+<p>We are pleased to announce that SINGA (incubating) X.Y.Z is released.</p>
+<p>SINGA is a general distributed deep learning platform for training big deep learning models over large datasets. It is designed with an intuitive programming model based on the layer abstraction. SINGA supports a wide variety of popular deep learning models.</p>
+<p>The release is available at:
+<a class="reference external" href="http://singa.incubator.apache.org/downloads.html">http://singa.incubator.apache.org/downloads.html</a></p>
+<p>The main features of this release include XXX</p>
+<p>We look forward to hearing your feedbacks, suggestions, and contributions to the project.</p>
+<p>On behalf of the SINGA team,
+{SINGA Team Member Name}</p>
+</div>
+</div>
+
+
+ </div>
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <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>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2018 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners..
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ 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>
+ v: latest
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Languages</dt>
+ <dd><a href="../../en/index.html">English</a></dd>
+ <dd><a href="../../zh/index.html">ä¸æ</a></dd>
+ </dl>
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="http://singa.apache.org/v0.3.0/">0.3</a></dd>
+ <dd><a href="http://singa.apache.org/v1.1.0/">1.1</a></dd>
+ </dl>
+
+ </div>
+ <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="https://github.com/apache/incubator-singa" class="fa fa-github" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://aws.amazon.com/marketplace/seller-profile?id=5bcac385-12c4-4802-aec7-351e09b77b4c" class="fab fa-aws" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://hub.docker.com/r/nusdbsystem/singa/" class="fab fa-docker" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.linkedin.com/groups/13550034" class="fa fa-linkedin" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://twitter.com/ApacheSinga" class="fa fa-twitter" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.facebook.com/Apache-SINGA-347284219056544/" class="fa fa-facebook" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.researchgate.net/project/Apache-SINGA" class="fab fa-researchgate" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+
+</div>
+
+ <a href="https://github.com/apache/incubator-singa">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"
+ alt="Fork me on GitHub">
+</a>
+
+
+
+
+</body>
+</html>
\ No newline at end of file
Modified: incubator/singa/site/trunk/en/develop/schedule.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/develop/schedule.html?rev=1848817&r1=1848816&r2=1848817&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/develop/schedule.html (original)
+++ incubator/singa/site/trunk/en/develop/schedule.html Thu Dec 13 04:18:16 2018
@@ -109,6 +109,7 @@
<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="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>
Modified: incubator/singa/site/trunk/en/docs.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs.html?rev=1848817&r1=1848816&r2=1848817&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs.html (original)
+++ incubator/singa/site/trunk/en/docs.html Thu Dec 13 04:18:16 2018
@@ -107,6 +107,7 @@
<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/contribute-code.html">How to Contribute Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="develop/contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="develop/how-to-release.html">How to prepare a release</a></li>
</ul>
<p class="caption"><span class="caption-text">Community</span></p>
<ul>
@@ -252,10 +253,6 @@
<li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/char-rnn/README.html#instructions">Instructions</a></li>
</ul>
</li>
-<li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/mnist/README.html">Train a RBM model against MNIST dataset</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/mnist/README.html#running-instructions">Running instructions</a></li>
-</ul>
-</li>
<li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/imagenet/alexnet/README.html">Train AlexNet over ImageNet</a><ul>
<li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/imagenet/alexnet/README.html#instructions">Instructions</a><ul>
<li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/imagenet/alexnet/README.html#compile-singa">Compile SINGA</a></li>
@@ -266,33 +263,14 @@
</li>
</ul>
</li>
-<li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/imagenet/densenet/README.html">Image Classification using DenseNet</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/imagenet/densenet/README.html#instructions">Instructions</a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/imagenet/densenet/README.html#details">Details</a></li>
-</ul>
-</li>
<li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/imagenet/googlenet/README.html">Image Classification using GoogleNet</a><ul>
<li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/imagenet/googlenet/README.html#instructions">Instructions</a></li>
<li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/imagenet/googlenet/README.html#details">Details</a></li>
</ul>
</li>
-<li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/imagenet/inception/README.html">Image Classification using Inception V4</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/imagenet/inception/README.html#instructions">Instructions</a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/imagenet/inception/README.html#details">Details</a></li>
-</ul>
-</li>
-<li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/imagenet/resnet/README.html">Image Classification using Residual Networks</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/imagenet/resnet/README.html#instructions">Instructions</a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/imagenet/resnet/README.html#details">Details</a></li>
-</ul>
-</li>
-<li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/imagenet/vgg/README.html">Image Classification using VGG</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/imagenet/vgg/README.html#instructions">Instructions</a></li>
-<li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/imagenet/vgg/README.html#details">Details</a></li>
-</ul>
-</li>
</ul>
</li>
+<li class="toctree-l2"><a class="reference internal" href="docs/security.html">Security</a></li>
</ul>
</li>
</ul>
Added: incubator/singa/site/trunk/en/docs/autograd.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/autograd.html?rev=1848817&view=auto
==============================================================================
--- incubator/singa/site/trunk/en/docs/autograd.html (added)
+++ incubator/singa/site/trunk/en/docs/autograd.html Thu Dec 13 04:18:16 2018
@@ -0,0 +1,423 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Autograd in Singa — incubator-singa 1.1.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <link href="../_static/style.css" rel="stylesheet" type="text/css">
+ <!--link href="../_static/fontawesome-all.min.css" rel="stylesheet" type="text/css"-->
+ <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous">
+ <style>
+ .fa:hover {
+ opacity: 0.7;
+ }
+ .fab:hover {
+ opacity: 0.7;
+ }
+ </style>
+
+
+
+ <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">
+
+
+
+ <a href="../index.html" class="icon icon-home"> incubator-singa
+
+
+
+
+ <img src="../_static/singa.png" class="logo" alt="Logo"/>
+
+ </a>
+
+
+
+
+ <div class="version">
+ latest
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="index.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Development</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../develop/schedule.html">Development Schedule</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-contribute.html">How to Contribute to SINGA</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-code.html">How to Contribute Code</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-to-release.html">How to prepare a release</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Community</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../community/source-repository.html">Source Repository</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/mail-lists.html">Project Mailing Lists</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/issue-tracking.html">Issue Tracking</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../community/team-list.html">The SINGA Team</a></li>
+</ul>
+
+
+
+ </div>
+ </div>
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" aria-label="top navigation">
+
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">incubator-singa</a>
+
+ </nav>
+
+
+ <div class="wy-nav-content">
+
+ <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+ <ul class="wy-breadcrumbs">
+
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li>Autograd in Singa</li>
+
+
+ <li class="wy-breadcrumbs-aside">
+
+
+
+ </li>
+
+ </ul>
+
+
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="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>
+<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 explained in details <a class="reference external" href="https://pytorch.org/docs/stable/notes/autograd.html">here</a>. We explain the relevant modules in Singa and give an example to illustrate the usage.</p>
+<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>
+<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>
+<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>
+</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="docutils literal notranslate"><span class="pre">requires_grad</span></code> must be true, not vice versa.</p>
+</div>
+<div class="section" id="operation">
+<span id="operation"></span><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>
+</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 literal notranslate"><span class="pre">Ctensor</span></code>s. To add a specific operation, subclass <code class="docutils literal notranslate"><span class="pre">operation</span></code> should implement their own <code class="docutils literal notranslate"><span class="pre">.forward()</span></code> and <code class="docutils literal notranslate"><span class="pre">.backward()</span></code>. The <code class="docutils literal notranslate"><span class="pre">backward()</span></code> function is called by the <c
ode class="docutils literal notranslate"><span class="pre">backward()</span></code> function of autograd automatically during backward propogation to compute the gradients of inputs (according to the <code class="docutils literal notranslate"><span class="pre">require_grad</span></code> field).</p>
+</div>
+<div class="section" id="layer">
+<span id="layer"></span><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 transformation.</p>
+</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>
+<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>
+<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>
+<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>
+</pre></div>
+</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>
+<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">stores_grad</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
+<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>
+<span class="n">b0</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">1</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">stores_grad</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
+<span class="n">b0</span><span class="o">.</span><span class="n">set_value</span><span class="p">(</span><span class="mf">0.0</span><span class="p">)</span>
+
+<span class="n">w1</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">3</span><span class="p">,</span> <span class="mi">2</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">stores_grad</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
+<span class="n">w1</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>
+<span class="n">b1</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">1</span><span class="p">,</span> <span class="mi">2</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">stores_grad</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
+<span class="n">b1</span><span class="o">.</span><span class="n">set_value</span><span class="p">(</span><span class="mf">0.0</span><span class="p">)</span>
+</pre></div>
+</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>
+<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>
+<span class="n">sgd</span> <span class="o">=</span> <span class="n">opt</span><span class="o">.</span><span class="n">SGD</span><span class="p">(</span><span class="mf">0.05</span><span class="p">)</span> <span class="c1"># optimizer</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="mi">10</span><span class="p">):</span>
+ <span class="n">x</span> <span class="o">=</span> <span class="n">autograd</span><span class="o">.</span><span class="n">matmul</span><span class="p">(</span><span class="n">inputs</span><span class="p">,</span> <span class="n">w0</span><span class="p">)</span> <span class="c1"># matrix multiplication</span>
+ <span class="n">x</span> <span class="o">=</span> <span class="n">autograd</span><span class="o">.</span><span class="n">add_bias</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">b0</span><span class="p">)</span> <span class="c1"># add the bias vector</span>
+ <span class="n">x</span> <span class="o">=</span> <span class="n">autograd</span><span class="o">.</span><span class="n">relu</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="c1"># ReLU activation operation</span>
+
+ <span class="n">x</span> <span class="o">=</span> <span class="n">autograd</span><span class="o">.</span><span class="n">matmul</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">w1</span><span class="p">)</span>
+ <span class="n">x</span> <span class="o">=</span> <span class="n">autograd</span><span class="o">.</span><span class="n">add_bias</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">b1</span><span class="p">)</span>
+
+ <span class="n">loss</span> <span class="o">=</span> <span class="n">autograd</span><span class="o">.</span><span class="n">softmax_cross_entropy</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">target</span><span class="p">)</span>
+
+ <span class="k">for</span> <span class="n">p</span><span class="p">,</span> <span class="n">g</span> <span class="ow">in</span> <span class="n">autograd</span><span class="o">.</span><span class="n">backward</span><span class="p">(</span><span class="n">loss</span><span class="p">):</span>
+ <span class="n">sgd</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">p</span><span class="p">,</span> <span class="n">g</span><span class="p">)</span>
+</pre></div>
+</div>
+</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>
+<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>
+<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> <span class="n">bias</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
+<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>
+<span class="n">conv21</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">32</span><span class="p">,</span> <span class="mi">16</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>
+<span class="n">conv22</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">32</span><span class="p">,</span> <span class="mi">16</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>
+<span class="n">bn2</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">linear</span> <span class="o">=</span> <span class="n">autograd</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">32</span> <span class="o">*</span> <span class="mi">28</span> <span class="o">*</span> <span class="mi">28</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>
+<span class="n">pooling2</span> <span class="o">=</span> <span class="n">autograd</span><span class="o">.</span><span class="n">AvgPool2d</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>
+</pre></div>
+</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>
+<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>
+ <span class="c1"># t the the label vector (a batch of integers)</span>
+ <span class="n">y</span> <span class="o">=</span> <span class="n">conv1</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="c1"># Conv layer </span>
+ <span class="n">y</span> <span class="o">=</span> <span class="n">autograd</span><span class="o">.</span><span class="n">relu</span><span class="p">(</span><span class="n">y</span><span class="p">)</span> <span class="c1"># ReLU operation</span>
+ <span class="n">y</span> <span class="o">=</span> <span class="n">bn1</span><span class="p">(</span><span class="n">y</span><span class="p">)</span> <span class="c1"># BN layer</span>
+ <span class="n">y</span> <span class="o">=</span> <span class="n">pooling1</span><span class="p">(</span><span class="n">y</span><span class="p">)</span> <span class="c1"># Pooling Layer</span>
+
+ <span class="c1"># two parallel convolution layers</span>
+ <span class="n">y1</span> <span class="o">=</span> <span class="n">conv21</span><span class="p">(</span><span class="n">y</span><span class="p">)</span>
+ <span class="n">y2</span> <span class="o">=</span> <span class="n">conv22</span><span class="p">(</span><span class="n">y</span><span class="p">)</span>
+ <span class="n">y</span> <span class="o">=</span> <span class="n">autograd</span><span class="o">.</span><span class="n">cat</span><span class="p">((</span><span class="n">y1</span><span class="p">,</span> <span class="n">y2</span><span class="p">),</span> <span class="mi">1</span><span class="p">)</span> <span class="c1"># cat operation</span>
+ <span class="n">y</span> <span class="o">=</span> <span class="n">autograd</span><span class="o">.</span><span class="n">relu</span><span class="p">(</span><span class="n">y</span><span class="p">)</span> <span class="c1"># ReLU operation</span>
+ <span class="n">y</span> <span class="o">=</span> <span class="n">bn2</span><span class="p">(</span><span class="n">y</span><span class="p">)</span>
+ <span class="n">y</span> <span class="o">=</span> <span class="n">pooling2</span><span class="p">(</span><span class="n">y</span><span class="p">)</span>
+
+ <span class="n">y</span> <span class="o">=</span> <span class="n">autograd</span><span class="o">.</span><span class="n">flatten</span><span class="p">(</span><span class="n">y</span><span class="p">)</span> <span class="c1"># flatten operation</span>
+ <span class="n">y</span> <span class="o">=</span> <span class="n">linear</span><span class="p">(</span><span class="n">y</span><span class="p">)</span> <span class="c1"># Linear layer</span>
+ <span class="n">loss</span> <span class="o">=</span> <span class="n">autograd</span><span class="o">.</span><span class="n">softmax_cross_entropy</span><span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="n">t</span><span class="p">)</span> <span class="c1"># operation </span>
+ <span class="k">return</span> <span class="n">loss</span><span class="p">,</span> <span class="n">y</span>
+</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="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>
+ <span class="n">inputs</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">device</span><span class="o">=</span><span class="n">dev</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">x_train</span><span class="p">[</span>
+ <span class="n">i</span> <span class="o">*</span> <span class="n">batch_sz</span><span class="p">:(</span><span class="mi">1</span> <span class="o">+</span> <span class="n">i</span><span class="p">)</span> <span class="o">*</span> <span class="n">batch_sz</span><span class="p">],</span> <span class="n">stores_grad</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
+ <span class="n">targets</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">device</span><span class="o">=</span><span class="n">dev</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">y_train</span><span class="p">[</span>
+ <span class="n">i</span> <span class="o">*</span> <span class="n">batch_sz</span><span class="p">:(</span><span class="mi">1</span> <span class="o">+</span> <span class="n">i</span><span class="p">)</span> <span class="o">*</span> <span class="n">batch_sz</span><span class="p">],</span> <span class="n">requires_grad</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">stores_grad</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
+
+ <span class="n">loss</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <span class="n">forward</span><span class="p">(</span><span class="n">inputs</span><span class="p">,</span> <span class="n">targets</span><span class="p">)</span> <span class="c1"># forward the net</span>
+
+ <span class="k">for</span> <span class="n">p</span><span class="p">,</span> <span class="n">gp</span> <span class="ow">in</span> <span class="n">autograd</span><span class="o">.</span><span class="n">backward</span><span class="p">(</span><span class="n">loss</span><span class="p">):</span> <span class="c1"># auto backward</span>
+ <span class="n">sgd</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">p</span><span class="p">,</span> <span class="n">gp</span><span class="p">)</span>
+</pre></div>
+</div>
+</div>
+</div>
+</div>
+</div>
+
+
+ </div>
+
+ </div>
+ <footer>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2018 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners..
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ 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>
+ v: latest
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Languages</dt>
+ <dd><a href="../../en/index.html">English</a></dd>
+ <dd><a href="../../zh/index.html">ä¸æ</a></dd>
+ </dl>
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="http://singa.apache.org/v0.3.0/">0.3</a></dd>
+ <dd><a href="http://singa.apache.org/v1.1.0/">1.1</a></dd>
+ </dl>
+
+ </div>
+ <a href="http://incubator.apache.org/"> <img src= "../_static/apache.png" style="background-color:white;"> </a>
+
+ <a href="https://github.com/apache/incubator-singa" class="fa fa-github" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://aws.amazon.com/marketplace/seller-profile?id=5bcac385-12c4-4802-aec7-351e09b77b4c" class="fab fa-aws" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://hub.docker.com/r/nusdbsystem/singa/" class="fab fa-docker" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.linkedin.com/groups/13550034" class="fa fa-linkedin" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://twitter.com/ApacheSinga" class="fa fa-twitter" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.facebook.com/Apache-SINGA-347284219056544/" class="fa fa-facebook" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+ <a href="https://www.researchgate.net/project/Apache-SINGA" class="fab fa-researchgate" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a>
+
+</div>
+
+ <a href="https://github.com/apache/incubator-singa">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"
+ alt="Fork me on GitHub">
+</a>
+
+
+
+
+</body>
+</html>
\ No newline at end of file
Modified: incubator/singa/site/trunk/en/docs/cnn.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/cnn.html?rev=1848817&r1=1848816&r2=1848817&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/cnn.html (original)
+++ incubator/singa/site/trunk/en/docs/cnn.html Thu Dec 13 04:18:16 2018
@@ -107,6 +107,7 @@
<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/contribute-code.html">How to Contribute Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-to-release.html">How to prepare a release</a></li>
</ul>
<p class="caption"><span class="caption-text">Community</span></p>
<ul>
Modified: incubator/singa/site/trunk/en/docs/converter.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/converter.html?rev=1848817&r1=1848816&r2=1848817&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/converter.html (original)
+++ incubator/singa/site/trunk/en/docs/converter.html Thu Dec 13 04:18:16 2018
@@ -117,6 +117,7 @@
<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>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
@@ -127,6 +128,7 @@
<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/contribute-code.html">How to Contribute Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-to-release.html">How to prepare a release</a></li>
</ul>
<p class="caption"><span class="caption-text">Community</span></p>
<ul>
Modified: incubator/singa/site/trunk/en/docs/data.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/data.html?rev=1848817&r1=1848816&r2=1848817&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/data.html (original)
+++ incubator/singa/site/trunk/en/docs/data.html Thu Dec 13 04:18:16 2018
@@ -117,6 +117,7 @@
<li class="toctree-l2"><a class="reference internal" href="converter.html">Caffe Converter</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="model_zoo/index.html">Model Zoo</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
@@ -127,6 +128,7 @@
<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/contribute-code.html">How to Contribute Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-to-release.html">How to prepare a release</a></li>
</ul>
<p class="caption"><span class="caption-text">Community</span></p>
<ul>
Modified: incubator/singa/site/trunk/en/docs/dependencies.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/dependencies.html?rev=1848817&r1=1848816&r2=1848817&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/dependencies.html (original)
+++ incubator/singa/site/trunk/en/docs/dependencies.html Thu Dec 13 04:18:16 2018
@@ -107,6 +107,7 @@
<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/contribute-code.html">How to Contribute Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-to-release.html">How to prepare a release</a></li>
</ul>
<p class="caption"><span class="caption-text">Community</span></p>
<ul>
Modified: incubator/singa/site/trunk/en/docs/device.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/device.html?rev=1848817&r1=1848816&r2=1848817&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/device.html (original)
+++ incubator/singa/site/trunk/en/docs/device.html Thu Dec 13 04:18:16 2018
@@ -122,6 +122,7 @@
<li class="toctree-l2"><a class="reference internal" href="converter.html">Caffe Converter</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="model_zoo/index.html">Model Zoo</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
@@ -132,6 +133,7 @@
<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/contribute-code.html">How to Contribute Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-to-release.html">How to prepare a release</a></li>
</ul>
<p class="caption"><span class="caption-text">Community</span></p>
<ul>
Modified: incubator/singa/site/trunk/en/docs/docker.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/docker.html?rev=1848817&r1=1848816&r2=1848817&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/docker.html (original)
+++ incubator/singa/site/trunk/en/docs/docker.html Thu Dec 13 04:18:16 2018
@@ -107,6 +107,7 @@
<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/contribute-code.html">How to Contribute Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-to-release.html">How to prepare a release</a></li>
</ul>
<p class="caption"><span class="caption-text">Community</span></p>
<ul>
Modified: incubator/singa/site/trunk/en/docs/image_tool.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/image_tool.html?rev=1848817&r1=1848816&r2=1848817&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/image_tool.html (original)
+++ incubator/singa/site/trunk/en/docs/image_tool.html Thu Dec 13 04:18:16 2018
@@ -117,6 +117,7 @@
<li class="toctree-l2"><a class="reference internal" href="converter.html">Caffe Converter</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="model_zoo/index.html">Model Zoo</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
@@ -127,6 +128,7 @@
<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/contribute-code.html">How to Contribute Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-to-release.html">How to prepare a release</a></li>
</ul>
<p class="caption"><span class="caption-text">Community</span></p>
<ul>
Modified: incubator/singa/site/trunk/en/docs/index.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/index.html?rev=1848817&r1=1848816&r2=1848817&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/index.html (original)
+++ incubator/singa/site/trunk/en/docs/index.html Thu Dec 13 04:18:16 2018
@@ -117,6 +117,7 @@
<li class="toctree-l2"><a class="reference internal" href="converter.html">Caffe Converter</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="model_zoo/index.html">Model Zoo</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
@@ -127,6 +128,7 @@
<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/contribute-code.html">How to Contribute Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-to-release.html">How to prepare a release</a></li>
</ul>
<p class="caption"><span class="caption-text">Community</span></p>
<ul>
@@ -271,10 +273,6 @@
<li class="toctree-l3"><a class="reference internal" href="model_zoo/char-rnn/README.html#instructions">Instructions</a></li>
</ul>
</li>
-<li class="toctree-l2"><a class="reference internal" href="model_zoo/mnist/README.html">Train a RBM model against MNIST dataset</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="model_zoo/mnist/README.html#running-instructions">Running instructions</a></li>
-</ul>
-</li>
<li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/alexnet/README.html">Train AlexNet over ImageNet</a><ul>
<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/alexnet/README.html#instructions">Instructions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="model_zoo/imagenet/alexnet/README.html#compile-singa">Compile SINGA</a></li>
@@ -285,33 +283,14 @@
</li>
</ul>
</li>
-<li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/densenet/README.html">Image Classification using DenseNet</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/densenet/README.html#instructions">Instructions</a></li>
-<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/densenet/README.html#details">Details</a></li>
-</ul>
-</li>
<li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/googlenet/README.html">Image Classification using GoogleNet</a><ul>
<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/googlenet/README.html#instructions">Instructions</a></li>
<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/googlenet/README.html#details">Details</a></li>
</ul>
</li>
-<li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/inception/README.html">Image Classification using Inception V4</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/inception/README.html#instructions">Instructions</a></li>
-<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/inception/README.html#details">Details</a></li>
-</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/resnet/README.html">Image Classification using Residual Networks</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/resnet/README.html#instructions">Instructions</a></li>
-<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/resnet/README.html#details">Details</a></li>
-</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="model_zoo/imagenet/vgg/README.html">Image Classification using VGG</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/vgg/README.html#instructions">Instructions</a></li>
-<li class="toctree-l3"><a class="reference internal" href="model_zoo/imagenet/vgg/README.html#details">Details</a></li>
-</ul>
-</li>
</ul>
</li>
+<li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li>
</ul>
</div>
</div>
Modified: incubator/singa/site/trunk/en/docs/initializer.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/initializer.html?rev=1848817&r1=1848816&r2=1848817&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/initializer.html (original)
+++ incubator/singa/site/trunk/en/docs/initializer.html Thu Dec 13 04:18:16 2018
@@ -121,6 +121,7 @@
<li class="toctree-l2"><a class="reference internal" href="converter.html">Caffe Converter</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="model_zoo/index.html">Model Zoo</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li>
@@ -131,6 +132,7 @@
<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/contribute-code.html">How to Contribute Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-to-release.html">How to prepare a release</a></li>
</ul>
<p class="caption"><span class="caption-text">Community</span></p>
<ul>
Modified: incubator/singa/site/trunk/en/docs/install_macos1013.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/install_macos1013.html?rev=1848817&r1=1848816&r2=1848817&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/install_macos1013.html (original)
+++ incubator/singa/site/trunk/en/docs/install_macos1013.html Thu Dec 13 04:18:16 2018
@@ -107,6 +107,7 @@
<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/contribute-code.html">How to Contribute Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-to-release.html">How to prepare a release</a></li>
</ul>
<p class="caption"><span class="caption-text">Community</span></p>
<ul>
Modified: incubator/singa/site/trunk/en/docs/install_win.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/install_win.html?rev=1848817&r1=1848816&r2=1848817&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/install_win.html (original)
+++ incubator/singa/site/trunk/en/docs/install_win.html Thu Dec 13 04:18:16 2018
@@ -107,6 +107,7 @@
<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/contribute-code.html">How to Contribute Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="../develop/contribute-docs.html">How to Contribute to Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../develop/how-to-release.html">How to prepare a release</a></li>
</ul>
<p class="caption"><span class="caption-text">Community</span></p>
<ul>
@@ -215,7 +216,7 @@
<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 dependecies folder. Add the path to protoc executable to the system path, or use full path when calling it.</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>
@@ -227,7 +228,7 @@
<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 dependecies folder.</li>
+<li>Extract the source in the dependencies folder.</li>
<li>If you donât have Perl installed, download a perl environment such as Strawberry Perl (<a class="reference external" href="http://strawberryperl.com/">http://strawberryperl.com/</a>)</li>
<li>Build the Visual Studio solution by running this command in the source folder:</li>
</ul>
@@ -528,7 +529,7 @@ SingaEnv<span class="se">\S</span>cripts
<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 projcet of type âCUDA 9.1 Runtimeâ. Give it a name such as singa-kernel.</p>
+<li><p class="first">Create a new Visual Studio project of type âCUDA 9.1 Runtimeâ. Give it a name such as singa-kernel.</p>
</li>
<li><p class="first">The project comes with an initial file called kernel.cu. Remove this file from the project.</p>
</li>
@@ -537,7 +538,7 @@ SingaEnv<span class="se">\S</span>cripts
<li><p class="first">In the project settings:</p>
<blockquote>
<div><ul class="simple">
-<li>Set Platfrom Toolset to âVisual Studio 2015 (v140)â</li>
+<li>Set Platform Toolset to âVisual Studio 2015 (v140)â</li>
<li>Set Configuration Type to â Static Library (.lib)â</li>
<li>In the Include Directories, add build/include.</li>
</ul>