Added: incubator/singa/site/trunk/en/docs/model_zoo/index.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/model_zoo/index.html?rev=1779877&view=auto ============================================================================== --- incubator/singa/site/trunk/en/docs/model_zoo/index.html (added) +++ incubator/singa/site/trunk/en/docs/model_zoo/index.html Mon Jan 23 04:55:46 2017 @@ -0,0 +1,308 @@ + + + +<!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>Model Zoo — incubator-singa 1.0.1 documentation</title> + + + + + + + + + + + + + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + + + + + + <link rel="top" title="incubator-singa 1.0.1 documentation" href="../../index.html"/> + <link rel="up" title="Documentation" href="../index.html"/> + <link rel="next" title="Train CNN over Cifar-10" href="cifar10/README.html"/> + <link rel="prev" title="Utils" href="../utils.html"/> + <link href="../../_static/style.css" rel="stylesheet" type="text/css"> + + + + <script src="../../_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <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" /> + + </a> + + + + + <div class="version"> + 1.0 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../downloads.html">Download SINGA</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../installation.html">Installation</a></li> +<li class="toctree-l2"><a class="reference internal" href="../software_stack.html">Software Stack</a></li> +<li class="toctree-l2"><a class="reference internal" href="../device.html">Device</a></li> +<li class="toctree-l2"><a class="reference internal" href="../tensor.html">Tensor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../layer.html">Layer</a></li> +<li class="toctree-l2"><a class="reference internal" href="../net.html">FeedForward Net</a></li> +<li class="toctree-l2"><a class="reference internal" href="../initializer.html">Initializer</a></li> +<li class="toctree-l2"><a class="reference internal" href="../loss.html">Loss</a></li> +<li class="toctree-l2"><a class="reference internal" href="../metric.html">Metric</a></li> +<li class="toctree-l2"><a class="reference internal" href="../optimizer.html">Optimizer</a></li> +<li class="toctree-l2"><a class="reference internal" href="../data.html">Data</a></li> +<li class="toctree-l2"><a class="reference internal" href="../image_tool.html">Image Tool</a></li> +<li class="toctree-l2"><a class="reference internal" href="../snapshot.html">Snapshot</a></li> +<li class="toctree-l2"><a class="reference internal" href="../converter.html">Caffe Converter</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utils.html">Utils</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="">Model Zoo</a><ul> +<li class="toctree-l3"><a class="reference internal" href="cifar10/README.html">Train CNN over Cifar-10</a></li> +<li class="toctree-l3"><a class="reference internal" href="char-rnn/README.html">Train Char-RNN over plain text</a></li> +<li class="toctree-l3"><a class="reference internal" href="imagenet/README.html">Train AlexNet over ImageNet</a></li> +</ul> +</li> +</ul> +</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> +</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" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">incubator-singa</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../index.html">Docs</a> »</li> + + <li><a href="../index.html">Documentation</a> »</li> + + <li>Model Zoo</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="model-zoo"> +<h1>Model Zoo<a class="headerlink" href="#model-zoo" title="Permalink to this headline">¶</a></h1> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="cifar10/README.html">Train CNN over Cifar-10</a><ul> +<li class="toctree-l2"><a class="reference internal" href="cifar10/README.html#instructions">Instructions</a><ul> +<li class="toctree-l3"><a class="reference internal" href="cifar10/README.html#singa-installation">SINGA installation</a></li> +<li class="toctree-l3"><a class="reference internal" href="cifar10/README.html#data-preparation">Data preparation</a></li> +<li class="toctree-l3"><a class="reference internal" href="cifar10/README.html#training">Training</a></li> +<li class="toctree-l3"><a class="reference internal" href="cifar10/README.html#prediction">Prediction</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="char-rnn/README.html">Train Char-RNN over plain text</a><ul> +<li class="toctree-l2"><a class="reference internal" href="char-rnn/README.html#instructions">Instructions</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="imagenet/README.html">Train AlexNet over ImageNet</a><ul> +<li class="toctree-l2"><a class="reference internal" href="imagenet/README.html#instructions">Instructions</a><ul> +<li class="toctree-l3"><a class="reference internal" href="imagenet/README.html#compile-singa">Compile SINGA</a></li> +<li class="toctree-l3"><a class="reference internal" href="imagenet/README.html#data-download">Data download</a></li> +<li class="toctree-l3"><a class="reference internal" href="imagenet/README.html#data-preprocessing">Data preprocessing</a></li> +<li class="toctree-l3"><a class="reference internal" href="imagenet/README.html#training">Training</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> + + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="cifar10/README.html" class="btn btn-neutral float-right" title="Train CNN over Cifar-10" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../utils.html" class="btn btn-neutral" title="Utils" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2016 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/snide/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.0.1', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </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.StickyNav.enable(); + }); + </script> + + +<div class="rst-versions shift-up" data-toggle="rst-versions" role="note" aria-label="versions"> +<a href="http://incubator.apache.org/";> +<img src= "../../_static/apache.jpg"> +</a> + + <span class="rst-current-version" data-toggle="rst-current-version"> + <span class="fa fa-book"> incubator-singa </span> + v: 1.0 + <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> + </dl> + + </div> +</div> + + <a href="https://github.com/apache/incubator-singa";> + <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;" + src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"; + alt="Fork me on GitHub"> +</a> + + + + +</body> +</html> \ No newline at end of file
Added: incubator/singa/site/trunk/en/docs/model_zoo/mnist/README.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/model_zoo/mnist/README.html?rev=1779877&view=auto ============================================================================== --- incubator/singa/site/trunk/en/docs/model_zoo/mnist/README.html (added) +++ incubator/singa/site/trunk/en/docs/model_zoo/mnist/README.html Mon Jan 23 04:55:46 2017 @@ -0,0 +1,263 @@ + + + +<!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>Train a RBM model against MNIST dataset — incubator-singa 1.0.1 documentation</title> + + + + + + + + + + + + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + + + + + + <link rel="top" title="incubator-singa 1.0.1 documentation" href="../../../index.html"/> + <link href="../../../_static/style.css" rel="stylesheet" type="text/css"> + + + + <script src="../../../_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <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" /> + + </a> + + + + + <div class="version"> + 1.0 + </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="../../../downloads.html">Download SINGA</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../index.html">Documentation</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> +</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" role="navigation" 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>Train a RBM model against MNIST dataset</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="train-a-rbm-model-against-mnist-dataset"> +<span id="train-a-rbm-model-against-mnist-dataset"></span><h1>Train a RBM model against MNIST dataset<a class="headerlink" href="#train-a-rbm-model-against-mnist-dataset" title="Permalink to this headline">¶</a></h1> +<p>This example is to train an RBM model using the +MNIST dataset. The RBM model and its hyper-parameters are set following +<a class="reference external" href="http://www.cs.toronto.edu/~hinton/science.pdf";>Hinton’s paper</a></p> +<div class="section" id="running-instructions"> +<span id="running-instructions"></span><h2>Running instructions<a class="headerlink" href="#running-instructions" title="Permalink to this headline">¶</a></h2> +<ol> +<li><p class="first">Download the pre-processed <a class="reference external" href="https://github.com/mnielsen/neural-networks-and-deep-learning/raw/master/data/mnist.pkl.gz";>MNIST dataset</a></p> +</li> +<li><p class="first">Start the training</p> +<div class="highlight-python"><div class="highlight"><pre> python train.py mnist.pkl.gz +</pre></div> +</div> +</li> +</ol> +<p>By default the training code would run on CPU. To run it on a GPU card, please start +the program with an additional argument</p> +<div class="highlight-python"><div class="highlight"><pre> python train.py mnist.pkl.gz --use_gpu +</pre></div> +</div> +</div> +</div> + + + </div> + </div> + <footer> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2016 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/snide/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.0.1', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </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.StickyNav.enable(); + }); + </script> + + +<div class="rst-versions shift-up" data-toggle="rst-versions" role="note" aria-label="versions"> +<a href="http://incubator.apache.org/";> +<img src= "../../../_static/apache.jpg"> +</a> + + <span class="rst-current-version" data-toggle="rst-current-version"> + <span class="fa fa-book"> incubator-singa </span> + v: 1.0 + <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> + </dl> + + </div> +</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/net.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/net.html?rev=1779877&r1=1779876&r2=1779877&view=diff ============================================================================== --- incubator/singa/site/trunk/en/docs/net.html (original) +++ incubator/singa/site/trunk/en/docs/net.html Mon Jan 23 04:55:46 2017 @@ -106,7 +106,7 @@ <li class="toctree-l2"><a class="reference internal" href="snapshot.html">Snapshot</a></li> <li class="toctree-l2"><a class="reference internal" href="converter.html">Caffe Converter</a></li> <li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li> -<li class="toctree-l2"><a class="reference internal" href="examples/index.html">Examples</a></li> +<li class="toctree-l2"><a class="reference internal" href="model_zoo/index.html">Model Zoo</a></li> </ul> </li> </ul> @@ -171,6 +171,202 @@ <span id="feedforward-net"></span><h1>FeedForward Net<a class="headerlink" href="#module-singa.net" title="Permalink to this headline">¶</a></h1> <p>Nerual net class for constructing the nets using layers and providing access functions for net info, e.g., parameters.</p> +<dl class="class"> +<dt id="singa.net.FeedForwardNet"> +<em class="property">class </em><code class="descclassname">singa.net.</code><code class="descname">FeedForwardNet</code><span class="sig-paren">(</span><em>loss=None</em>, <em>metric=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.net.FeedForwardNet" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> +<dl class="method"> +<dt id="singa.net.FeedForwardNet.to_device"> +<code class="descname">to_device</code><span class="sig-paren">(</span><em>dev</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.net.FeedForwardNet.to_device" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="singa.net.FeedForwardNet.add"> +<code class="descname">add</code><span class="sig-paren">(</span><em>lyr</em>, <em>src=None</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.net.FeedForwardNet.add" title="Permalink to this definition">¶</a></dt> +<dd><p>Append a layer into the layer list.</p> +<p>This function will get the sample shape from the src layers to setup the +newly added layer. For the first layer, it is setup outside. The calling +function should ensure the correctness of the layer order. If src is +None, the last layer is the src layer. If there are multiple src layers, +the src is a list of the src layers.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>lyr</strong> (<a class="reference internal" href="layer.html#singa.layer.Layer" title="singa.layer.Layer"><em>Layer</em></a>) – the layer to be added</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="singa.net.FeedForwardNet.param_values"> +<code class="descname">param_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.net.FeedForwardNet.param_values" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="singa.net.FeedForwardNet.param_specs"> +<code class="descname">param_specs</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.net.FeedForwardNet.param_specs" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="singa.net.FeedForwardNet.param_names"> +<code class="descname">param_names</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.net.FeedForwardNet.param_names" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="singa.net.FeedForwardNet.train"> +<code class="descname">train</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.net.FeedForwardNet.train" title="Permalink to this definition">¶</a></dt> +<dd><p>Run BP for one iteration.</p> +<p>Currently only support nets with a single output layer, and a single +loss objective and metric. +TODO(wangwei) consider multiple loss objectives and metrics.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>x</strong> – input data, a single input Tensor or a dict: layer name -> Tensor</li> +<li><strong>y</strong> – label data, a single input Tensor.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">gradients of parameters and the loss and metric values.</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="singa.net.FeedForwardNet.evaluate"> +<code class="descname">evaluate</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.net.FeedForwardNet.evaluate" title="Permalink to this definition">¶</a></dt> +<dd><p>Evaluate the loss and metric of the given data.</p> +<p>Currently only support nets with a single output layer, and a single +loss objective and metric. +TODO(wangwei) consider multiple loss objectives and metrics.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>x</strong> – input data, a single input Tensor or a dict: layer name -> Tensor</li> +<li><strong>y</strong> – label data, a single input Tensor.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="singa.net.FeedForwardNet.predict"> +<code class="descname">predict</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.net.FeedForwardNet.predict" title="Permalink to this definition">¶</a></dt> +<dd><p>Forward the input data through each layer to get the values of the +output layers.</p> +<p>Currently only support nets with a single output layer</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> – input data, a single input Tensor or a dict: layer name -> Tensor</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a single output tensor as the prediction result.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="singa.net.FeedForwardNet.topo_sort"> +<code class="descname">topo_sort</code><span class="sig-paren">(</span><em>layers</em>, <em>src_of_layer</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.net.FeedForwardNet.topo_sort" title="Permalink to this definition">¶</a></dt> +<dd><p>Topology sort of layers.</p> +<p>It would try to preserve the orders of the input layers.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>layers</strong> – a list of layers; the layers from the output of the same +layer (e.g., slice layer) should be added by users in correct +order; This function would not change their order.</li> +<li><strong>src_of_layer</strong> – a dictionary: src layer name -> a list of src layers</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A list of ordered layer</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="singa.net.FeedForwardNet.forward"> +<code class="descname">forward</code><span class="sig-paren">(</span><em>flag</em>, <em>x</em>, <em>output=[]</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.net.FeedForwardNet.forward" title="Permalink to this definition">¶</a></dt> +<dd><p>Forward the input(s) through every layer.</p> +<p>If a layer has inputs from other layers and from x, the data from x is +ordered before the data from other layers, e.g., if layer 1 -> layer 2, +and x[‘layer 2’] has data, then the input of layer 2 is +flatten([x[‘layer 2’], output of layer 1])</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>flag</strong> – True for training; False for evaluation; could also be +model_pb2.kTrain or model_pb2.kEval, or other values for future +use.</li> +<li><strong>x</strong> – a single SINGA tensor or a dictionary: layer name-> singa tensor</li> +<li><strong>output</strong> (<em>list</em>) – a list of layer names whose output would be returned +in addition to the default output</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">if there is only one output layer, return its output tensor(s); +else return a dictionary: layer name -> output tensor(s)</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="singa.net.FeedForwardNet.backward"> +<code class="descname">backward</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.net.FeedForwardNet.backward" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="singa.net.FeedForwardNet.save"> +<code class="descname">save</code><span class="sig-paren">(</span><em>f</em>, <em>buffer_size=10</em>, <em>use_pickle=False</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.net.FeedForwardNet.save" title="Permalink to this definition">¶</a></dt> +<dd><p>Save model parameters using io/snapshot.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>f</strong> – file name</li> +<li><strong>buffer_size</strong> – size (MB) of the IO, default setting is 10MB; Please +make sure it is larger than any single parameter object.</li> +<li><strong>use_pickle</strong> (<em>Boolean</em>) – if true, it would use pickle for dumping; +otherwise, it would use protobuf for serialization, which uses +less space.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="singa.net.FeedForwardNet.load"> +<code class="descname">load</code><span class="sig-paren">(</span><em>f</em>, <em>buffer_size=10</em>, <em>use_pickle=False</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.net.FeedForwardNet.load" title="Permalink to this definition">¶</a></dt> +<dd><p>Load model parameters using io/snapshot.</p> +<p>Please refer to the argument description in save().</p> +</dd></dl> + +</dd></dl> + </div> Modified: incubator/singa/site/trunk/en/docs/optimizer.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/optimizer.html?rev=1779877&r1=1779876&r2=1779877&view=diff ============================================================================== --- incubator/singa/site/trunk/en/docs/optimizer.html (original) +++ incubator/singa/site/trunk/en/docs/optimizer.html Mon Jan 23 04:55:46 2017 @@ -106,7 +106,7 @@ <li class="toctree-l2"><a class="reference internal" href="snapshot.html">Snapshot</a></li> <li class="toctree-l2"><a class="reference internal" href="converter.html">Caffe Converter</a></li> <li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li> -<li class="toctree-l2"><a class="reference internal" href="examples/index.html">Examples</a></li> +<li class="toctree-l2"><a class="reference internal" href="model_zoo/index.html">Model Zoo</a></li> </ul> </li> </ul> Modified: incubator/singa/site/trunk/en/docs/snapshot.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/snapshot.html?rev=1779877&r1=1779876&r2=1779877&view=diff ============================================================================== --- incubator/singa/site/trunk/en/docs/snapshot.html (original) +++ incubator/singa/site/trunk/en/docs/snapshot.html Mon Jan 23 04:55:46 2017 @@ -106,7 +106,7 @@ <li class="toctree-l2 current"><a class="current reference internal" href="">Snapshot</a></li> <li class="toctree-l2"><a class="reference internal" href="converter.html">Caffe Converter</a></li> <li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li> -<li class="toctree-l2"><a class="reference internal" href="examples/index.html">Examples</a></li> +<li class="toctree-l2"><a class="reference internal" href="model_zoo/index.html">Model Zoo</a></li> </ul> </li> </ul> Modified: incubator/singa/site/trunk/en/docs/software_stack.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/software_stack.html?rev=1779877&r1=1779876&r2=1779877&view=diff ============================================================================== --- incubator/singa/site/trunk/en/docs/software_stack.html (original) +++ incubator/singa/site/trunk/en/docs/software_stack.html Mon Jan 23 04:55:46 2017 @@ -111,7 +111,7 @@ <li class="toctree-l2"><a class="reference internal" href="snapshot.html">Snapshot</a></li> <li class="toctree-l2"><a class="reference internal" href="converter.html">Caffe Converter</a></li> <li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li> -<li class="toctree-l2"><a class="reference internal" href="examples/index.html">Examples</a></li> +<li class="toctree-l2"><a class="reference internal" href="model_zoo/index.html">Model Zoo</a></li> </ul> </li> </ul> Modified: incubator/singa/site/trunk/en/docs/tensor.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/tensor.html?rev=1779877&r1=1779876&r2=1779877&view=diff ============================================================================== --- incubator/singa/site/trunk/en/docs/tensor.html (original) +++ incubator/singa/site/trunk/en/docs/tensor.html Mon Jan 23 04:55:46 2017 @@ -111,7 +111,7 @@ <li class="toctree-l2"><a class="reference internal" href="snapshot.html">Snapshot</a></li> <li class="toctree-l2"><a class="reference internal" href="converter.html">Caffe Converter</a></li> <li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li> -<li class="toctree-l2"><a class="reference internal" href="examples/index.html">Examples</a></li> +<li class="toctree-l2"><a class="reference internal" href="model_zoo/index.html">Model Zoo</a></li> </ul> </li> </ul> Modified: incubator/singa/site/trunk/en/docs/utils.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/utils.html?rev=1779877&r1=1779876&r2=1779877&view=diff ============================================================================== --- incubator/singa/site/trunk/en/docs/utils.html (original) +++ incubator/singa/site/trunk/en/docs/utils.html Mon Jan 23 04:55:46 2017 @@ -33,7 +33,7 @@ <link rel="top" title="incubator-singa 1.0.1 documentation" href="../index.html"/> <link rel="up" title="Documentation" href="index.html"/> - <link rel="next" title="Examples" href="examples/index.html"/> + <link rel="next" title="Model Zoo" href="model_zoo/index.html"/> <link rel="prev" title="Caffe Converter" href="converter.html"/> <link href="../_static/style.css" rel="stylesheet" type="text/css"> @@ -106,7 +106,7 @@ <li class="toctree-l2"><a class="reference internal" href="snapshot.html">Snapshot</a></li> <li class="toctree-l2"><a class="reference internal" href="converter.html">Caffe Converter</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="">Utils</a></li> -<li class="toctree-l2"><a class="reference internal" href="examples/index.html">Examples</a></li> +<li class="toctree-l2"><a class="reference internal" href="model_zoo/index.html">Model Zoo</a></li> </ul> </li> </ul> @@ -196,7 +196,7 @@ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="examples/index.html" class="btn btn-neutral float-right" title="Examples" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + <a href="model_zoo/index.html" class="btn btn-neutral float-right" title="Model Zoo" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="converter.html" class="btn btn-neutral" title="Caffe Converter" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> Modified: incubator/singa/site/trunk/en/genindex.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/genindex.html?rev=1779877&r1=1779876&r2=1779877&view=diff ============================================================================== --- incubator/singa/site/trunk/en/genindex.html (original) +++ incubator/singa/site/trunk/en/genindex.html Mon Jan 23 04:55:46 2017 @@ -221,6 +221,12 @@ <dt><a href="docs/tensor.html#singa.tensor.add">add() (in module singa.tensor)</a> </dt> + <dd><dl> + + <dt><a href="docs/net.html#singa.net.FeedForwardNet.add">(singa.net.FeedForwardNet method)</a> + </dt> + + </dl></dd> <dt><a href="docs/tensor.html#singa.tensor.add_column">add_column() (in module singa.tensor)</a> </dt> @@ -366,6 +372,10 @@ <dt><a href="docs/loss.html#singa.loss.SquaredError.backward">(singa.loss.SquaredError method)</a> </dt> + + <dt><a href="docs/net.html#singa.net.FeedForwardNet.backward">(singa.net.FeedForwardNet method)</a> + </dt> + </dl></dd> <dt><a href="docs/layer.html#singa.layer.BatchNormalization">BatchNormalization (class in singa.layer)</a> @@ -552,6 +562,10 @@ <dt><a href="docs/metric.html#singa.metric.Metric.evaluate">(singa.metric.Metric method)</a> </dt> + + <dt><a href="docs/net.html#singa.net.FeedForwardNet.evaluate">(singa.net.FeedForwardNet method)</a> + </dt> + </dl></dd> <dt><a href="docs/tensor.html#singa.tensor.exp">exp() (in module singa.tensor)</a> @@ -564,6 +578,10 @@ <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%" valign="top"><dl> + <dt><a href="docs/net.html#singa.net.FeedForwardNet">FeedForwardNet (class in singa.net)</a> + </dt> + + <dt><a href="docs/layer.html#singa.layer.Flatten">Flatten (class in singa.layer)</a> </dt> @@ -614,6 +632,10 @@ <dt><a href="docs/metric.html#singa.metric.Metric.forward">(singa.metric.Metric method)</a> </dt> + + <dt><a href="docs/net.html#singa.net.FeedForwardNet.forward">(singa.net.FeedForwardNet method)</a> + </dt> + </dl></dd> <dt><a href="docs/tensor.html#singa.tensor.from_numpy">from_numpy() (in module singa.tensor)</a> @@ -749,6 +771,10 @@ <dt><a href="docs/tensor.html#singa.tensor.le">le() (in module singa.tensor)</a> </dt> + + <dt><a href="docs/net.html#singa.net.FeedForwardNet.load">load() (singa.net.FeedForwardNet method)</a> + </dt> + </dl></td> <td style="width: 33%" valign="top"><dl> @@ -855,10 +881,26 @@ <dt><a href="docs/layer.html#singa.layer.Layer.param_names">param_names() (singa.layer.Layer method)</a> </dt> + <dd><dl> + + <dt><a href="docs/net.html#singa.net.FeedForwardNet.param_names">(singa.net.FeedForwardNet method)</a> + </dt> + + </dl></dd> + + <dt><a href="docs/net.html#singa.net.FeedForwardNet.param_specs">param_specs() (singa.net.FeedForwardNet method)</a> + </dt> + <dt><a href="docs/layer.html#singa.layer.Layer.param_values">param_values() (singa.layer.Layer method)</a> </dt> + <dd><dl> + + <dt><a href="docs/net.html#singa.net.FeedForwardNet.param_values">(singa.net.FeedForwardNet method)</a> + </dt> + + </dl></dd> </dl></td> <td style="width: 33%" valign="top"><dl> @@ -869,6 +911,10 @@ <dt><a href="docs/tensor.html#singa.tensor.pow">pow() (in module singa.tensor)</a> </dt> + + <dt><a href="docs/net.html#singa.net.FeedForwardNet.predict">predict() (singa.net.FeedForwardNet method)</a> + </dt> + </dl></td> </tr></table> @@ -946,6 +992,10 @@ <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%" valign="top"><dl> + <dt><a href="docs/net.html#singa.net.FeedForwardNet.save">save() (singa.net.FeedForwardNet method)</a> + </dt> + + <dt><a href="docs/tensor.html#singa.tensor.Tensor.set_value">set_value() (singa.tensor.Tensor method)</a> </dt> @@ -1107,18 +1157,22 @@ <dt><a href="docs/tensor.html#singa.tensor.Tensor">Tensor (class in singa.tensor)</a> </dt> - </dl></td> - <td style="width: 33%" valign="top"><dl> <dt><a href="docs/layer.html#singa.layer.Layer.to_device">to_device() (singa.layer.Layer method)</a> </dt> <dd><dl> + <dt><a href="docs/net.html#singa.net.FeedForwardNet.to_device">(singa.net.FeedForwardNet method)</a> + </dt> + + <dt><a href="docs/tensor.html#singa.tensor.Tensor.to_device">(singa.tensor.Tensor method)</a> </dt> </dl></dd> + </dl></td> + <td style="width: 33%" valign="top"><dl> <dt><a href="docs/tensor.html#singa.tensor.Tensor.to_host">to_host() (singa.tensor.Tensor method)</a> </dt> @@ -1127,6 +1181,14 @@ <dt><a href="docs/tensor.html#singa.tensor.to_numpy">to_numpy() (in module singa.tensor)</a> </dt> + + <dt><a href="docs/net.html#singa.net.FeedForwardNet.topo_sort">topo_sort() (singa.net.FeedForwardNet method)</a> + </dt> + + + <dt><a href="docs/net.html#singa.net.FeedForwardNet.train">train() (singa.net.FeedForwardNet method)</a> + </dt> + </dl></td> </tr></table> Modified: incubator/singa/site/trunk/en/index.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/index.html?rev=1779877&r1=1779876&r2=1779877&view=diff ============================================================================== --- incubator/singa/site/trunk/en/index.html (original) +++ incubator/singa/site/trunk/en/index.html Mon Jan 23 04:55:46 2017 @@ -170,16 +170,15 @@ <div class="section" id="getting-started"> <h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2> <ul class="simple"> -<li>The <a class="reference external" href="docs/software_stack.html">Software stack</a> page gives an overview of SINGA.</li> -<li>The <a class="reference external" href="docs/installation.html">Installation</a> guide describes details on downloading and installing SINGA.</li> -<li>Please follow the <a class="reference external" href="docs/examples/index.html">Examples</a> guide to run simple applications on SINGA.</li> -<li>More exmaples in <a class="reference external" href="http://jupyter.org/";>Jupyter</a> (IPython) can be open in <a class="reference external" href="http://nbviewer.jupyter.org/github/apache/incubator-singa/blob/master/doc/en/docs/notebook/index.ipynb";>notebook viewer</a> .</li> +<li>Try SINGA on <a class="reference external" href="https://aws.amazon.com/marketplace/pp/B01NAUAWZW";>AWS</a> or via <a class="reference external" href="https://hub.docker.com/r/nusdbsystem/singa/";>Docker</a>.</li> +<li>Install SINGA via <a class="reference external" href="./docs/installation.html#from-wheel">python wheel files</a>, <a class="reference external" href="./docs/installation.html#from-debian-package">Debian packages</a> or from <a class="reference external" href="./docs/installation.html#from-source">source</a>.</li> +<li>Refer to the <a class="reference external" href="http://nbviewer.jupyter.org/github/apache/incubator-singa/blob/master/doc/en/docs/notebook/index.ipynb";>Jupyter notebooks</a> for some basic examples and the <a class="reference external" href="./docs/model_zoo/index.html">model zoo page</a> for more examples.</li> </ul> </div> <div class="section" id="documentation"> <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2> <ul class="simple"> -<li>Documentations are listed <a class="reference external" href="docs.html">here</a>.</li> +<li>Documentation and APIs are listed <a class="reference external" href="docs.html">here</a>.</li> <li>Research publication list is available <a class="reference external" href="http://www.comp.nus.edu.sg/~dbsystem/singa/research/publication/";>here</a>.</li> </ul> </div> Modified: incubator/singa/site/trunk/en/objects.inv URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/objects.inv?rev=1779877&r1=1779876&r2=1779877&view=diff ============================================================================== Binary files - no diff available.
![https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"](https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"){kind=link}