Added: incubator/singa/site/trunk/develop/how-to-release.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/develop/how-to-release.html?rev=1857927&view=auto ============================================================================== --- incubator/singa/site/trunk/develop/how-to-release.html (added) +++ incubator/singa/site/trunk/develop/how-to-release.html Sun Apr 21 22:05:49 2019 @@ -0,0 +1,474 @@ + + + +<!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 2.0.0 documentation</title> + + + + + + + + + <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <script type="text/javascript" src="../_static/language_data.js"></script> + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="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> + +</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="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> +<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 float-left" 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 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> + <span class="rst-current-version" data-toggle="rst-current-version"> + <span class="fa fa-book"> incubator-singa </span> + v: latest + <span class="fa fa-caret-down"></span> + </span> + <div class="rst-other-versions"> + <dl> + <dt>Languages</dt> + <dd><a href=".././index.html">English</a></dd> + <dd><a href=".././zh/index.html">ä¸æ</a></dd> + </dl> + <dl> + <dt>Versions</dt> + <dd><a href="http://singa.apache.org/v0.3.0/";>0.3</a></dd> + <dd><a href="http://singa.apache.org/v1.1.0/";>1.1</a></dd> + </dl> + + </div> + <a href="http://incubator.apache.org/";> <img src= "../_static/apache.png" style="background-color:white;"> </a> + + <a href="https://github.com/apache/incubator-singa"; class="fa fa-github" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://aws.amazon.com/marketplace/seller-profile?id=5bcac385-12c4-4802-aec7-351e09b77b4c"; class="fab fa-aws" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://hub.docker.com/r/apache/singa/"; class="fab fa-docker" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://www.linkedin.com/groups/13550034"; class="fa fa-linkedin" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://twitter.com/ApacheSinga"; class="fa fa-twitter" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://www.facebook.com/Apache-SINGA-347284219056544/"; class="fa fa-facebook" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://www.researchgate.net/project/Apache-SINGA"; class="fab fa-researchgate" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + +</div> + + <a href="https://github.com/apache/incubator-singa";> + <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;" + src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"; + alt="Fork me on GitHub"> +</a> + + + + +</body> +</html> \ No newline at end of file
Added: incubator/singa/site/trunk/develop/schedule.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/develop/schedule.html?rev=1857927&view=auto ============================================================================== --- incubator/singa/site/trunk/develop/schedule.html (added) +++ incubator/singa/site/trunk/develop/schedule.html Sun Apr 21 22:05:49 2019 @@ -0,0 +1,456 @@ + + + +<!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>Development Schedule — incubator-singa 2.0.0 documentation</title> + + + + + + + + + <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <script type="text/javascript" src="../_static/language_data.js"></script> + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="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="https://use.fontawesome.com/releases/v5.0.13/css/all.css"; integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous"> + <style> + .fa:hover { + opacity: 0.7; + } + .fab:hover { + opacity: 0.7; + } + </style> + +</head> + +<body class="wy-body-for-nav"> + + + <div class="wy-grid-for-nav"> + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../index.html" class="icon icon-home"> incubator-singa + + + + + <img src="../_static/singa.png" class="logo" alt="Logo"/> + + </a> + + + + + <div class="version"> + latest + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../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 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> +<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> +<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>Development Schedule</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="development-schedule"> +<h1>Development Schedule<a class="headerlink" href="#development-schedule" title="Permalink to this headline">¶</a></h1> +<table border="1" class="docutils"> +<colgroup> +<col width="33%" /> +<col width="33%" /> +<col 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> +</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> +</tr> +<tr class="row-odd"><td> </td> +<td> </td> +<td>RBM-like model, including RBM</td> +</tr> +<tr class="row-even"><td> </td> +<td> </td> +<td>Recurrent neural network, including standard RNN</td> +</tr> +<tr class="row-odd"><td> </td> +<td>Architecture</td> +<td>One worker group on single node (with data partition)</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> +<tr class="row-odd"><td> </td> +<td> </td> +<td>Distributed Hogwild</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> +<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> +<tr class="row-even"><td> </td> +<td> </td> +<td>Load-balance among servers</td> +</tr> +<tr class="row-odd"><td> </td> +<td>Failure recovery</td> +<td>Checkpoint and restore</td> +</tr> +<tr class="row-even"><td> </td> +<td>Tools</td> +<td>Installation with GNU auto Tools</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> +<tr class="row-even"><td> </td> +<td> </td> +<td>Recurrent neural network, including GRULayer and BPTT</td> +</tr> +<tr class="row-odd"><td> </td> +<td> </td> +<td>Model partition and hybrid partition</td> +</tr> +<tr class="row-even"><td> </td> +<td>Tools</td> +<td>Integration with Mesos for resource management</td> +</tr> +<tr class="row-odd"><td> </td> +<td> </td> +<td>Prepare Docker images for deployment</td> +</tr> +<tr class="row-even"><td> </td> +<td> </td> +<td>Visualization of neural net and debug information</td> +</tr> +<tr class="row-odd"><td> </td> +<td>Binding</td> +<td>Python binding for major components</td> +</tr> +<tr class="row-even"><td> </td> +<td>GPU</td> +<td>Single node with multiple GPUs</td> +</tr> +<tr class="row-odd"><td>v0.3 April 2016</td> +<td>GPU</td> +<td>Multiple nodes, each with multiple GPUs</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> +<tr class="row-odd"><td> </td> +<td> </td> +<td>Support cuDNN v4</td> +</tr> +<tr class="row-even"><td> </td> +<td>Installation</td> +<td>Remove dependency on ZeroMQ, CZMQ, Zookeeper for single node training</td> +</tr> +<tr class="row-odd"><td> </td> +<td>Updater</td> +<td>Add new SGD updaters including Adam, AdamMax and AdaDelta</td> +</tr> +<tr class="row-even"><td> </td> +<td>Binding</td> +<td>Enhance Python binding for training</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> +<tr class="row-even"><td> </td> +<td> </td> +<td>Updater for distributed parameter updating</td> +</tr> +<tr class="row-odd"><td> </td> +<td>Hardware</td> +<td>Use Cuda and Cudnn for Nvidia GPU</td> +</tr> +<tr class="row-even"><td> </td> +<td> </td> +<td>Use OpenCL for AMD GPU or other devices</td> +</tr> +<tr class="row-odd"><td> </td> +<td>Cross-platform</td> +<td>To extend from Linux to MacOS</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> +<tr class="row-odd"><td>v1.1 Jan 2017</td> +<td>Model Zoo</td> +<td>GoogleNet; Health-care models</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> +<tr class="row-odd"><td> </td> +<td>Model components</td> +<td>Add concat and slice layers; accept multiple inputs to the net</td> +</tr> +<tr class="row-even"><td> </td> +<td>Compilation and installation</td> +<td>Windows suppport</td> +</tr> +<tr class="row-odd"><td> </td> +<td> </td> +<td>Simplify the installation by compiling protobuf and openblas together with SINGA</td> +</tr> +<tr class="row-even"><td> </td> +<td> </td> +<td>Build python wheel automatically using Jenkins</td> +</tr> +<tr class="row-odd"><td> </td> +<td> </td> +<td>Install SINGA from Debian packages</td> +</tr> +<tr class="row-even"><td>v1.2 June 2018</td> +<td>AutoGrad</td> +<td>AutoGrad for BP</td> +</tr> +<tr class="row-odd"><td> </td> +<td>Python 3</td> +<td>Support Python 3 for PySinga</td> +</tr> +<tr class="row-even"><td> </td> +<td>Models</td> +<td>Add popular models, including VGG, ResNet, DenseNet, InceptionNet</td> +</tr> +</tbody> +</table> +</div> + + + </div> + + </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 float-left" 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. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> + <span class="rst-current-version" data-toggle="rst-current-version"> + <span class="fa fa-book"> incubator-singa </span> + v: latest + <span class="fa fa-caret-down"></span> + </span> + <div class="rst-other-versions"> + <dl> + <dt>Languages</dt> + <dd><a href=".././index.html">English</a></dd> + <dd><a href=".././zh/index.html">ä¸æ</a></dd> + </dl> + <dl> + <dt>Versions</dt> + <dd><a href="http://singa.apache.org/v0.3.0/";>0.3</a></dd> + <dd><a href="http://singa.apache.org/v1.1.0/";>1.1</a></dd> + </dl> + + </div> + <a href="http://incubator.apache.org/";> <img src= "../_static/apache.png" style="background-color:white;"> </a> + + <a href="https://github.com/apache/incubator-singa"; class="fa fa-github" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://aws.amazon.com/marketplace/seller-profile?id=5bcac385-12c4-4802-aec7-351e09b77b4c"; class="fab fa-aws" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://hub.docker.com/r/apache/singa/"; class="fab fa-docker" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://www.linkedin.com/groups/13550034"; class="fa fa-linkedin" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://twitter.com/ApacheSinga"; class="fa fa-twitter" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://www.facebook.com/Apache-SINGA-347284219056544/"; class="fa fa-facebook" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://www.researchgate.net/project/Apache-SINGA"; class="fab fa-researchgate" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + +</div> + + <a href="https://github.com/apache/incubator-singa";> + <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;" + src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"; + alt="Fork me on GitHub"> +</a> + + + + +</body> +</html> \ No newline at end of file Added: incubator/singa/site/trunk/docs.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/docs.html?rev=1857927&view=auto ============================================================================== --- incubator/singa/site/trunk/docs.html (added) +++ incubator/singa/site/trunk/docs.html Sun Apr 21 22:05:49 2019 @@ -0,0 +1,436 @@ + + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Documentation — incubator-singa 2.0.0 documentation</title> + + + + + + + + + <script type="text/javascript" src="_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/underscore.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + <script type="text/javascript" src="_static/language_data.js"></script> + + <script type="text/javascript" src="_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + <link href="_static/style.css" rel="stylesheet" type="text/css"> + <!--link href="_static/fontawesome-all.min.css" rel="stylesheet" type="text/css"--> + <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css"; integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous"> + <style> + .fa:hover { + opacity: 0.7; + } + .fab:hover { + opacity: 0.7; + } + </style> + +</head> + +<body class="wy-body-for-nav"> + + + <div class="wy-grid-for-nav"> + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="index.html" class="icon icon-home"> incubator-singa + + + + + <img src="_static/singa.png" class="logo" alt="Logo"/> + + </a> + + + + + <div class="version"> + latest + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="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> +<li class="toctree-l1"><a class="reference internal" href="develop/schedule.html">Development Schedule</a></li> +<li class="toctree-l1"><a class="reference internal" href="develop/how-contribute.html">How to Contribute to SINGA</a></li> +<li class="toctree-l1"><a class="reference internal" href="develop/how-contribute.html#how-to-become-a-singa-committer">How to become a SINGA committer</a></li> +<li class="toctree-l1"><a class="reference internal" href="develop/contribute-code.html">How to Contribute Code</a></li> +<li class="toctree-l1"><a class="reference internal" href="develop/contribute-docs.html">How to Contribute to Documentation</a></li> +<li class="toctree-l1"><a class="reference internal" href="develop/how-to-release.html">How to prepare a release</a></li> +</ul> +<p class="caption"><span class="caption-text">Community</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="community/source-repository.html">Source Repository</a></li> +<li class="toctree-l1"><a class="reference internal" href="community/mail-lists.html">Project Mailing Lists</a></li> +<li class="toctree-l1"><a class="reference internal" href="community/issue-tracking.html">Issue Tracking</a></li> +<li class="toctree-l1"><a class="reference internal" href="community/team-list.html">The SINGA Team</a></li> +</ul> + + + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">incubator-singa</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="index.html">Docs</a> »</li> + + <li>Documentation</li> + + + <li class="wy-breadcrumbs-aside"> + + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <div class="section" id="documentation"> +<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="docs/index.html">Documentation</a><ul> +<li class="toctree-l2"><a class="reference internal" href="docs/installation.html">Installation</a><ul> +<li class="toctree-l3"><a class="reference internal" href="docs/installation.html#from-conda">From Conda</a></li> +<li class="toctree-l3"><a class="reference internal" href="docs/installation.html#from-source">From source</a><ul> +<li class="toctree-l4"><a class="reference internal" href="docs/installation.html#use-conda-to-build-singa">Use Conda to build SINGA</a></li> +<li class="toctree-l4"><a class="reference internal" href="docs/installation.html#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="docs/installation.html#compile-singa-on-windows">Compile SINGA on Windows</a></li> +<li class="toctree-l4"><a class="reference internal" href="docs/installation.html#more-details-about-the-compilation-options">More details about the compilation options</a></li> +<li class="toctree-l4"><a class="reference internal" href="docs/installation.html#use-modules">USE_MODULES</a><ul> +<li class="toctree-l5"><a class="reference internal" href="docs/installation.html#use-python">USE_PYTHON</a></li> +<li class="toctree-l5"><a class="reference internal" href="docs/installation.html#use-cuda">USE_CUDA</a></li> +<li class="toctree-l5"><a class="reference internal" href="docs/installation.html#use-opencl">USE_OPENCL</a></li> +<li class="toctree-l5"><a class="reference internal" href="docs/installation.html#use-mkldnn">USE_MKLDNN</a></li> +<li class="toctree-l5"><a class="reference internal" href="docs/installation.html#package">PACKAGE</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="docs/installation.html#faq">FAQ</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="docs/software_stack.html">Software Stack</a><ul> +<li class="toctree-l3"><a class="reference internal" href="docs/software_stack.html#core">Core</a></li> +<li class="toctree-l3"><a class="reference internal" href="docs/software_stack.html#model">Model</a></li> +<li class="toctree-l3"><a class="reference internal" href="docs/software_stack.html#io">IO</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="docs/device.html">Device</a><ul> +<li class="toctree-l3"><a class="reference internal" href="docs/device.html#specific-devices">Specific devices</a></li> +<li class="toctree-l3"><a class="reference internal" href="docs/device.html#python-api">Python API</a></li> +<li class="toctree-l3"><a class="reference internal" href="docs/device.html#cpp-api">CPP API</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="docs/tensor.html">Tensor</a><ul> +<li class="toctree-l3"><a class="reference internal" href="docs/tensor.html#tensor-implementation">Tensor implementation</a></li> +<li class="toctree-l3"><a class="reference internal" href="docs/tensor.html#python-api">Python API</a></li> +<li class="toctree-l3"><a class="reference internal" href="docs/tensor.html#cpp-api">CPP API</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="docs/layer.html">Layer</a><ul> +<li class="toctree-l3"><a class="reference internal" href="docs/layer.html#python-api">Python API</a></li> +<li class="toctree-l3"><a class="reference internal" href="docs/layer.html#cpp-api">CPP API</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="docs/net.html">FeedForward Net</a></li> +<li class="toctree-l2"><a class="reference internal" href="docs/initializer.html">Initializer</a><ul> +<li class="toctree-l3"><a class="reference internal" href="docs/initializer.html#python-api">Python API</a></li> +<li class="toctree-l3"><a class="reference internal" href="docs/initializer.html#cpp-api">CPP API</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="docs/loss.html">Loss</a></li> +<li class="toctree-l2"><a class="reference internal" href="docs/metric.html">Metric</a></li> +<li class="toctree-l2"><a class="reference internal" href="docs/optimizer.html">Optimizer</a></li> +<li class="toctree-l2"><a class="reference internal" href="docs/autograd.html">Autograd in Singa</a><ul> +<li class="toctree-l3"><a class="reference internal" href="docs/autograd.html#relevant-modules">Relevant Modules</a><ul> +<li class="toctree-l4"><a class="reference internal" href="docs/autograd.html#tensor">Tensor</a></li> +<li class="toctree-l4"><a class="reference internal" href="docs/autograd.html#operation">Operation</a></li> +<li class="toctree-l4"><a class="reference internal" href="docs/autograd.html#layer">Layer</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="docs/autograd.html#examples">Examples</a><ul> +<li class="toctree-l4"><a class="reference internal" href="docs/autograd.html#operation-only">Operation only</a><ul> +<li class="toctree-l5"><a class="reference internal" href="docs/autograd.html#import-packages">Import packages</a></li> +<li class="toctree-l5"><a class="reference internal" href="docs/autograd.html#create-weight-matrix-and-bias-vector">Create weight matrix and bias vector</a></li> +<li class="toctree-l5"><a class="reference internal" href="docs/autograd.html#training">Training</a></li> +</ul> +</li> +<li class="toctree-l4"><a class="reference internal" href="docs/autograd.html#operation-layer">Operation + Layer</a><ul> +<li class="toctree-l5"><a class="reference internal" href="docs/autograd.html#create-the-layers">Create the layers</a></li> +<li class="toctree-l5"><a class="reference internal" href="docs/autograd.html#define-the-forward-function">Define the forward function</a></li> +<li class="toctree-l5"><a class="reference internal" href="docs/autograd.html#id1">Training</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="docs/data.html">Data</a></li> +<li class="toctree-l2"><a class="reference internal" href="docs/image_tool.html">Image Tool</a></li> +<li class="toctree-l2"><a class="reference internal" href="docs/snapshot.html">Snapshot</a></li> +<li class="toctree-l2"><a class="reference internal" href="docs/converter.html">Caffe Converter</a></li> +<li class="toctree-l2"><a class="reference internal" href="docs/utils.html">Utils</a></li> +<li class="toctree-l2"><a class="reference internal" href="docs/model_zoo/index.html">Model Zoo</a><ul> +<li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/cifar10/README.html">Train CNN over Cifar-10</a><ul> +<li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/cifar10/README.html#instructions">Instructions</a><ul> +<li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/cifar10/README.html#singa-installation">SINGA installation</a></li> +<li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/cifar10/README.html#data-preparation">Data preparation</a></li> +<li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/cifar10/README.html#training">Training</a></li> +<li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/cifar10/README.html#prediction">Prediction</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/char-rnn/README.html">Train Char-RNN over plain text</a><ul> +<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> +<li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/imagenet/alexnet/README.html#data-download">Data download</a></li> +<li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/imagenet/alexnet/README.html#data-preprocessing">Data preprocessing</a></li> +<li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/imagenet/alexnet/README.html#training">Training</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/imagenet/densenet/README.html">name: DenseNet models on ImageNet +SINGA version: 1.1.1 +SINGA commit: +license: https://github.com/pytorch/vision/blob/master/torchvision/models/densenet.py</a></li> +<li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/imagenet/densenet/README.html#image-classification-using-densenet">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">name: GoogleNet on ImageNet +SINGA version: 1.0.1 +SINGA commit: 8c990f7da2de220e8a012c6a8ecc897dc7532744 +parameter_url: https://s3-ap-southeast-1.amazonaws.com/dlfile/bvlc_googlenet.tar.gz +parameter_sha1: 0a88e8948b1abca3badfd8d090d6be03f8d7655d +license: unrestricted https://github.com/BVLC/caffe/tree/master/models/bvlc_googlenet</a></li> +<li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/imagenet/googlenet/README.html#image-classification-using-googlenet">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">name: Inception V4 on ImageNet +SINGA version: 1.1.1 +SINGA commit: +parameter_url: https://s3-ap-southeast-1.amazonaws.com/dlfile/inception_v4.tar.gz +parameter_sha1: 5fdd6f5d8af8fd10e7321d9b38bb87ef14e80d56 +license: https://github.com/tensorflow/models/tree/master/slim</a></li> +<li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/imagenet/inception/README.html#image-classification-using-inception-v4">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">name: Resnets on ImageNet +SINGA version: 1.1 +SINGA commit: 45ec92d8ffc1fa1385a9307fdf07e21da939ee2f +parameter_url: https://s3-ap-southeast-1.amazonaws.com/dlfile/resnet/resnet-18.tar.gz +license: Apache V2, https://github.com/facebook/fb.resnet.torch/blob/master/LICENSE</a></li> +<li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/imagenet/resnet/README.html#image-classification-using-residual-networks">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">name: VGG models on ImageNet +SINGA version: 1.1.1 +SINGA commit: +license: https://github.com/pytorch/vision/blob/master/torchvision/models/vgg.py</a></li> +<li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/imagenet/vgg/README.html#image-classification-using-vgg">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> +</div> +</div> + + + </div> + + </div> + <footer> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> + <span class="rst-current-version" data-toggle="rst-current-version"> + <span class="fa fa-book"> incubator-singa </span> + v: latest + <span class="fa fa-caret-down"></span> + </span> + <div class="rst-other-versions"> + <dl> + <dt>Languages</dt> + <dd><a href="./index.html">English</a></dd> + <dd><a href="./zh/index.html">ä¸æ</a></dd> + </dl> + <dl> + <dt>Versions</dt> + <dd><a href="http://singa.apache.org/v0.3.0/";>0.3</a></dd> + <dd><a href="http://singa.apache.org/v1.1.0/";>1.1</a></dd> + </dl> + + </div> + <a href="http://incubator.apache.org/";> <img src= "_static/apache.png" style="background-color:white;"> </a> + + <a href="https://github.com/apache/incubator-singa"; class="fa fa-github" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://aws.amazon.com/marketplace/seller-profile?id=5bcac385-12c4-4802-aec7-351e09b77b4c"; class="fab fa-aws" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://hub.docker.com/r/apache/singa/"; class="fab fa-docker" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://www.linkedin.com/groups/13550034"; class="fa fa-linkedin" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://twitter.com/ApacheSinga"; class="fa fa-twitter" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://www.facebook.com/Apache-SINGA-347284219056544/"; class="fa fa-facebook" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + <a href="https://www.researchgate.net/project/Apache-SINGA"; class="fab fa-researchgate" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> + +</div> + + <a href="https://github.com/apache/incubator-singa";> + <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;" + src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"; + alt="Fork me on GitHub"> +</a> + + + + +</body> +</html> \ No newline at end of file
![https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"](https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"){kind=link}