You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@singa.apache.org by wa...@apache.org on 2016/10/25 11:42:45 UTC
svn commit: r1766516 [2/3] - in /incubator/singa/site/trunk/en: ./
_sources/docs/ _sources/docs/examples/cifar10/ docs/ docs/examples/
docs/examples/char-rnn/ docs/examples/cifar10/ docs/examples/imagenet/
Modified: incubator/singa/site/trunk/en/docs/installation.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/installation.html?rev=1766516&r1=1766515&r2=1766516&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/installation.html (original)
+++ incubator/singa/site/trunk/en/docs/installation.html Tue Oct 25 11:42:44 2016
@@ -92,25 +92,21 @@
<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 current"><a class="current reference internal" href="#">Installation</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#dependencies">Dependencies</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="#required">Required</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#optional">Optional</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#apt-get">apt-get</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#homebrew">homebrew</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#pip-and-anaconda-for-pysinga">pip and anaconda for PySINGA</a></li>
-</ul>
-</li>
<li class="toctree-l3"><a class="reference internal" href="#install-pysinga">Install PySINGA</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#install-dependent-libraries">Install dependent libraries</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#virtual-environment">Virtual environment</a></li>
<li class="toctree-l4"><a class="reference internal" href="#from-wheel">From wheel</a></li>
<li class="toctree-l4"><a class="reference internal" href="#from-source">From source</a></li>
</ul>
</li>
-<li class="toctree-l3"><a class="reference internal" href="#build-singa-from-source">Build SINGA from source</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="#linux-macos">Linux & MacOS</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#opencl-support-linux">OpenCL support (Linux)</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#windows">Windows</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#build-singa-on-linux-and-mac-os">Build SINGA on Linux and Mac OS</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#compile-singa-together-with-dependent-libraries">Compile SINGA together with dependent libraries</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#install-dependent-libraries-and-compile-singa">Install dependent libraries and compile SINGA</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#compile-singa-with-cuda-and-cudnn">Compile SINGA with CUDA and CUDNN</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#compile-singa-with-opencl-support-linux">Compile SINGA with OpenCL support (Linux)</a></li>
</ul>
</li>
+<li class="toctree-l3"><a class="reference internal" href="#build-singa-on-windows">Build SINGA on Windows</a></li>
<li class="toctree-l3"><a class="reference internal" href="#faq">FAQ</a></li>
</ul>
</li>
@@ -118,12 +114,16 @@
<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"><a class="reference internal" href="examples/index.html">Examples</a></li>
</ul>
</li>
@@ -187,193 +187,175 @@
<div class="section" id="installation">
<span id="installation"></span><h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
-<div class="section" id="dependencies">
-<span id="dependencies"></span><h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h2>
-<div class="section" id="required">
-<span id="required"></span><h3>Required<a class="headerlink" href="#required" title="Permalink to this headline">¶</a></h3>
-<ul class="simple">
-<li>google protobuf (>=2.5,<3)</li>
-<li>blas (tested with openblas >=0.2.10)</li>
-<li>cmake (>=2.6)</li>
-</ul>
-</div>
-<div class="section" id="optional">
-<span id="optional"></span><h3>Optional<a class="headerlink" href="#optional" title="Permalink to this headline">¶</a></h3>
-<ul class="simple">
-<li>cuda (tested with 6.5, 7.0 and 7.5)</li>
-<li>cudnn (v4 and v5)</li>
-<li>opencv (tested with 2.4.8)</li>
-<li>lmdb (tested with 0.9)</li>
-<li>glog</li>
-<li>opencl-headers and viennacl (version 1.7.1 or newer) for OpenCL support</li>
-</ul>
-<p>PySINGA (the Python binding) has additional dependencies</p>
-<ul class="simple">
-<li>python(==2.7)</li>
-<li>pip(>=1.5)</li>
-<li>swig(>=3.0.10)</li>
-<li>numpy(>=1.11.0)</li>
-</ul>
-<p>Users are encouraged to install the cuda and <a class="reference external" href="https://developer.nvidia.com/cudnn">cudnn</a> for running SINGA on GPUs to
-get better performance.
-Most of the dependent libraries could be installed from source or via package mangers like
-apt-get, homebrew, pip and anaconda. Please refer to FAQ for problems caused by the path setting of the dependent libraries.</p>
-</div>
-<div class="section" id="apt-get">
-<span id="apt-get"></span><h3>apt-get<a class="headerlink" href="#apt-get" title="Permalink to this headline">¶</a></h3>
-<p>The following instructions are tested on Ubuntu 14.04 for installing dependent libraries.</p>
-<div class="highlight-default"><div class="highlight"><pre># required libraries
-$ sudo apt-get install libprotobuf-dev libopenblas-dev protobuf-compiler
-
-# optional libraries
-$ sudo apt-get install python2.7-dev python-pip python-numpy
-$ sudo apt-get install libopencv-dev libgoogle-glog-dev liblmdb-dev
-</pre></div>
-</div>
-<p>Please note that PySINGA requires swig >=3.0, which could be installed via
-apt-get on Ubuntu 16.04; but it has to be installed from source for other Ubuntu versions including 14.04.</p>
-</div>
-<div class="section" id="homebrew">
-<span id="homebrew"></span><h3>homebrew<a class="headerlink" href="#homebrew" title="Permalink to this headline">¶</a></h3>
-<p>The following instructions are tested on Mac OS X Yosemite (10.10.5) for installing dependent libraries.</p>
-<div class="highlight-default"><div class="highlight"><pre># required libraries
-$ brew tap homebrew/science
-$ brew install openblas
-$ brew install protobuf260
+<div class="section" id="install-pysinga">
+<span id="install-pysinga"></span><h2>Install PySINGA<a class="headerlink" href="#install-pysinga" title="Permalink to this headline">¶</a></h2>
+<p>PySINGA has been tested on Linux (Ubunu 14.04 and 16.04) and Mac OS (10.11).</p>
+<div class="section" id="install-dependent-libraries">
+<span id="install-dependent-libraries"></span><h3>Install dependent libraries<a class="headerlink" href="#install-dependent-libraries" title="Permalink to this headline">¶</a></h3>
+<p>Python 2.7 is required to run PySINGA.</p>
+<div class="highlight-default"><div class="highlight"><pre># For Ubuntu
+$ sudo apt-get install python2.7-dev python-pip
-# optional libraries
+# For Mac
$ brew tap homebrew/python
$ brew install python
-$ brew install opencv
-$ brew install -vd glog lmdb
-</pre></div>
-</div>
-<p>By default, openblas is installed into /usr/local/opt/openblas. To let the compiler (and cmake) know the openblas
-path, please export</p>
-<div class="highlight-default"><div class="highlight"><pre>$ export CMAKE_INCLUDE_PATH=/usr/local/opt/openblas/include:$CMAKE_INCLUDE_PATH
-$ export CMAKE_LIBRARY_PATH=/usr/local/opt/openblas/lib:$CMAKE_LIBRARY_PATH
-</pre></div>
-</div>
-<p>To let the runtime know the openblas path, please export</p>
-<div class="highlight-default"><div class="highlight"><pre>$ export LD_LIBRARY_PATH=/usr/local/opt/openblas/library:$LD_LIBRARY_PATH
</pre></div>
</div>
</div>
-<div class="section" id="pip-and-anaconda-for-pysinga">
-<span id="pip-and-anaconda-for-pysinga"></span><h3>pip and anaconda for PySINGA<a class="headerlink" href="#pip-and-anaconda-for-pysinga" title="Permalink to this headline">¶</a></h3>
-<p>pip and anaconda could be used to install python packages, e.g. numpy.
-Python virtual environment is recommended to run PySINGA.
-To use pip with virtual environment,</p>
+<div class="section" id="virtual-environment">
+<span id="virtual-environment"></span><h3>Virtual environment<a class="headerlink" href="#virtual-environment" title="Permalink to this headline">¶</a></h3>
+<p>Users are recommended to use PySINGA in python virtual environment.</p>
+<p>To use pip with virtual environment,</p>
<div class="highlight-default"><div class="highlight"><pre># install virtualenv
$ pip install virtualenv
$ virtualenv pysinga
$ source pysinga/bin/activate
-$ pip install numpy
</pre></div>
</div>
<p>To use anaconda with virtual environment,</p>
<div class="highlight-default"><div class="highlight"><pre>$ conda create --name pysinga python=2
$ source activate pysinga
-$ conda install numpy
</pre></div>
</div>
-<p>After installing numpy, please export the header path of numpy.i as</p>
-<div class="highlight-default"><div class="highlight"><pre>$ export CPLUS_INCLUDE_PATH=`python -c "import numpy; print numpy.get_include()"`:$CPLUS_INCLUDE_PATH
-</pre></div>
-</div>
-</div>
+<p>Note that in python virtual environment, you may need to reset the <code class="docutils literal"><span class="pre">PYTHONPATH</span></code> to empty
+to avoid the conflicts of system path and virtual environment path.</p>
</div>
-<div class="section" id="install-pysinga">
-<span id="install-pysinga"></span><h2>Install PySINGA<a class="headerlink" href="#install-pysinga" title="Permalink to this headline">¶</a></h2>
<div class="section" id="from-wheel">
<span id="from-wheel"></span><h3>From wheel<a class="headerlink" href="#from-wheel" title="Permalink to this headline">¶</a></h3>
-<p>After installing the dependencies for SINGA and PySINGA, please download the correct binary:</p>
-<div class="highlight-default"><div class="highlight"><pre># Ubuntu/Linux 64-bit, CPU only, Python 2.7, Protobuf 2.5
-$ export SINGA_WHEEL_URL=http://comp.nus.edu.sg/~dbsystem/singa/assets/file/pb2.5/singa-1.0.0-cp27-none-linux_x86_64.whl
-
-# Ubuntu/Linux 64-bit, CPU only, Python 2.7, Protobuf 2.6
-$ export SINGA_WHEEL_URL=http://comp.nus.edu.sg/~dbsystem/singa/assets/file/pb2.6/singa-1.0.0-cp27-none-linux_x86_64.whl
-
-# Mac OSX (10.11), CPU only, Python 2.7, Protobuf 2.5
-$ export SINGA_WHEEL_URL=http://comp.nus.edu.sg/~dbsystem/singa/assets/file/pb2.5/singa-1.0.0-cp27-none-macosx_10_11_intel.whl
+<p>Currently, we have three versions of wheel files,</p>
+<div class="highlight-default"><div class="highlight"><pre># Ubuntu 14.04 64-bit, CPU only, Python 2.7
+$ pip install --upgrade http://comp.nus.edu.sg/~dbsystem/singa/assets/file/ubuntu1404/singa-1.0.0-cp27-none-linux_x86_64.whl
-# Mac OSX (10.11), CPU only, Python 2.7, Protobuf 2.6
-$ export SINGA_WHEEL_URL=http://comp.nus.edu.sg/~dbsystem/singa/assets/file/pb2.6/singa-1.0.0-cp27-none-macosx_10_11_intel.whl
+# Ubuntu 14.04 64-bit, GPU enabled, Python 2.7, CUDA toolkit 7.5 and CuDNN v5
+$ pip install --upgrade http://comp.nus.edu.sg/~dbsystem/singa/assets/file/ubuntu1404/cuda7.5-cudnn5/singa-1.0.0-cp27-none-linux_x86_64.whl
-# Ubuntu/Linux 64-bit, GPU enabled, Python 2.7, Protobuf 2.5, CUDA toolkit 7.5 and CuDNN v5
-$ export SINGA_WHEEL_URL=http://comp.nus.edu.sg/~dbsystem/singa/assets/file/pb2.5-cuda7.5-cudnn5/singa-1.0.0-cp27-none-linux_x86_64.whl
-
-# Ubuntu/Linux 64-bit, GPU enabled, Python 2.7, Protobuf 2.6, CUDA toolkit 7.5 and CuDNN v5
-$ export SINGA_WHEEL_URL=http://comp.nus.edu.sg/~dbsystem/singa/assets/file/pb2.6-cuda7.5-cudnn5/singa-1.0.0-cp27-none-linux_x86_64.whl
-</pre></div>
-</div>
-<p>Then, run the following command</p>
-<div class="highlight-default"><div class="highlight"><pre>$ sudo pip install --upgrade $SINGA_WHEEL_URL
+# Mac OSX (10.11), CPU only, Python 2.7
+$ pip install --upgrade http://comp.nus.edu.sg/~dbsystem/singa/assets/file/pb2.6/singa-1.0.0-cp27-none-macosx_10_11_intel.whl
</pre></div>
</div>
-<p>If you do not have sudo right, you can run <code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span></code> in a python virtual environment.
-Note that in python virtual environment, you may need to reset the <code class="docutils literal"><span class="pre">PYTHONPATH</span></code> to empty
-to avoid the conflicts of system path and virtual environment path.</p>
+<p>If you have sudo right, you can run the above commands using <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">pip</span> <span class="pre">install</span></code> without python virtual environment.
+You can also download the <code class="docutils literal"><span class="pre">.whl</span></code> file and run <code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre"><the</span> <span class="pre">whl</span> <span class="pre">file</span> <span class="pre">directly></span></code>.
+The option <code class="docutils literal"><span class="pre">--upgrade</span></code> may cause errors sometimes, in which case you can ignore it.</p>
</div>
<div class="section" id="from-source">
<span id="from-source"></span><h3>From source<a class="headerlink" href="#from-source" title="Permalink to this headline">¶</a></h3>
-<p>Please compile SINGA from source (see the next section) with the ‘USE_PYTHON’ option on (<code class="docutils literal"><span class="pre">cmake</span> <span class="pre">-DUSE_PYTHON=ON</span> <span class="pre">..</span></code>),
+<p>To build the PySINGA from source, the following dependent libraries are required,</p>
+<ul class="simple">
+<li>swig(>=3.0.10)</li>
+<li>numpy(>=1.11.0)</li>
+</ul>
+<p>They can be installed by</p>
+<div class="highlight-default"><div class="highlight"><pre>$ Ubuntu 14.04 and 16.04
+$ sudo apt-get install python-numpy
+# Ubuntu 16.04
+$ sudo apt-get install swig
+</pre></div>
+</div>
+<p>Note that swig has to be installed from source on Ubuntu 14.04.
+After installing numpy, please export the header path of numpy.i as</p>
+<div class="highlight-default"><div class="highlight"><pre>$ export CPLUS_INCLUDE_PATH=`python -c "import numpy; print numpy.get_include()"`:$CPLUS_INCLUDE_PATH
+</pre></div>
+</div>
+<p>Please compile SINGA from source (see the next section) with <code class="docutils literal"><span class="pre">cmake</span> <span class="pre">-DUSE_PYTHON=ON</span> <span class="pre">-DUSE_MODULES=ON</span> <span class="pre">..</span></code>,
and then run the following commands,</p>
<div class="highlight-default"><div class="highlight"><pre># under the build directory
$ cd python
-$ sudo pip install .
+$ pip install .
</pre></div>
</div>
-<p>If you are using a virtual environment, you can ignore the <code class="docutils literal"><span class="pre">sudo</span></code> keyword.</p>
<p>Developers can build the wheel file via</p>
<div class="highlight-default"><div class="highlight"><pre># under the build directory
$ cd python
$ python setup.py bdist_wheel
</pre></div>
</div>
-<p>The generated wheel file is under “dist” directory.
-To build cnmem into the wheel file, please change CMakeLists.txt by replacing
-‘SHARED’ with ‘STATIC’.</p>
+<p>The generated wheel file is under “dist” directory.</p>
</div>
</div>
-<div class="section" id="build-singa-from-source">
-<span id="build-singa-from-source"></span><h2>Build SINGA from source<a class="headerlink" href="#build-singa-from-source" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="build-singa-on-linux-and-mac-os">
+<span id="build-singa-on-linux-and-mac-os"></span><h2>Build SINGA on Linux and Mac OS<a class="headerlink" href="#build-singa-on-linux-and-mac-os" title="Permalink to this headline">¶</a></h2>
<p>The source files could be downloaded either as a <a class="reference external" href="https://dist.apache.org/repos/dist/dev/incubator/singa/1.0.0/apache-singa-incubating-1.0.0-RC2.tar.gz">tar.gz file</a>, or as a git repo</p>
<div class="highlight-default"><div class="highlight"><pre>$ git clone https://github.com/apache/incubator-singa.git
$ cd incubator-singa/
-
-# If you use CUDA, then CNMeM is necessary
-$ git submodule init
-$ git submodule update
</pre></div>
</div>
-<div class="section" id="linux-macos">
-<span id="linux-macos"></span><h3>Linux & MacOS<a class="headerlink" href="#linux-macos" title="Permalink to this headline">¶</a></h3>
+<p>cmake (>=2.8) is used for compile SINGA, which can be installed by</p>
+<div class="highlight-default"><div class="highlight"><pre># For Ubuntu 14.04 and 16.04
+$ sudo apt-get install cmake
+</pre></div>
+</div>
<p>GCC (>=4.8.1) is required to compile SINGA on Linux.
For Mac OS users, you can use either GCC or Clang.</p>
-<p>In SINGA_ROOT, execute the following commands for compiling SINGA,</p>
-<div class="highlight-default"><div class="highlight"><pre>$ mkdir build && cd build
-$ cmake ..
+<div class="section" id="compile-singa-together-with-dependent-libraries">
+<span id="compile-singa-together-with-dependent-libraries"></span><h3>Compile SINGA together with dependent libraries<a class="headerlink" href="#compile-singa-together-with-dependent-libraries" title="Permalink to this headline">¶</a></h3>
+<p>SINGA code uses CBLAS and Protobuf (>=2.5, <3).
+If they are not installed in your OS, you can compile SINGA together with them</p>
+<div class="highlight-default"><div class="highlight"><pre>$ In SINGA ROOT folder
+$ mkdir build
+$ cd build
+$ cmake -DUSE_MODULES=ON ..
$ make
-$ make install
</pre></div>
</div>
-<p>Note that if you are using CUDNN and it is not installed under system default
-folder, you need to let cmake know the paths to CUDNN,</p>
-<div class="highlight-default"><div class="highlight"><pre>$ export CMAKE_INCLUDE_PATH=<path to cudnn>/include:$CMAKE_INCLUDE_PATH
-$ export CMAKE_LIBRARY_PATH=<path to cudnn>/lib64:$CMAKE_LIBRARY_PATH
+<p>cmake would download OpenBlas and Protobuf (2.6.1) and compile them together
+with SINGA.</p>
+</div>
+<div class="section" id="install-dependent-libraries-and-compile-singa">
+<span id="install-dependent-libraries-and-compile-singa"></span><h3>Install dependent libraries and compile SINGA<a class="headerlink" href="#install-dependent-libraries-and-compile-singa" title="Permalink to this headline">¶</a></h3>
+<p>Users can also install the dependent libraries and link SINGA with them.</p>
+<p>The following libraries are required</p>
+<ul class="simple">
+<li>google protobuf (>=2.5,<3)</li>
+<li>blas (tested with openblas >=0.2.10)</li>
+</ul>
+<p>The following libraries are optional</p>
+<ul class="simple">
+<li>opencv (tested with 2.4.8)</li>
+<li>lmdb (tested with 0.9)</li>
+<li>glog</li>
+</ul>
+<p>Most of the dependent libraries could be installed from source or via package mangers like
+apt-get, yum, and homebrew. Please refer to FAQ for problems caused by the path setting of the dependent libraries.</p>
+<p>The following instructions are tested on Ubuntu 14.04 for installing dependent libraries.</p>
+<div class="highlight-default"><div class="highlight"><pre># required libraries
+$ sudo apt-get install libprotobuf-dev libopenblas-dev protobuf-compiler
+
+# optional libraries
+$ sudo apt-get install python2.7-dev python-pip python-numpy
+$ sudo apt-get install libopencv-dev libgoogle-glog-dev liblmdb-dev
</pre></div>
</div>
-<p>You can use <code class="docutils literal"><span class="pre">ccmake</span> <span class="pre">..</span></code> to configure the compilation options including using
-generating python binding and changing the installation folder. Alternatively,
-the options could be switched on by</p>
-<div class="highlight-default"><div class="highlight"><pre>$ cmake -DUSE_CUDA=ON -DUSE_PYTHON=ON ..
+<p>Please note that PySINGA requires swig >=3.0, which could be installed via
+apt-get on Ubuntu 16.04; but it has to be installed from source for other Ubuntu versions including 14.04.</p>
+<p>The following instructions are tested on Mac OS X Yosemite (10.10.5) for installing dependent libraries.</p>
+<div class="highlight-default"><div class="highlight"><pre># required libraries
+$ brew tap homebrew/science
+$ brew install openblas
+$ brew install protobuf260
+
+# optional libraries
+$ brew tap homebrew/python
+$ brew install python
+$ brew install opencv
+$ brew install -vd glog lmdb
</pre></div>
</div>
-<p>If the dependent libraries are not in the system default paths, you need to export
-the following environment variables</p>
-<div class="highlight-default"><div class="highlight"><pre><span class="n">export</span> <span class="n">CMAKE_INCLUDE_PATH</span><span class="o">=<</span><span class="n">path</span> <span class="n">to</span> <span class="n">your</span> <span class="n">header</span> <span class="n">file</span> <span class="n">folder</span><span class="o">></span>
-<span class="n">export</span> <span class="n">CMAKE_LIBRARY_PATH</span><span class="o">=<</span><span class="n">path</span> <span class="n">to</span> <span class="n">your</span> <span class="n">lib</span> <span class="n">file</span> <span class="n">folder</span><span class="o">></span>
+<p>By default, openblas is installed into /usr/local/opt/openblas. To let the compiler (and cmake) know the openblas
+path, please export</p>
+<div class="highlight-default"><div class="highlight"><pre>$ export CMAKE_INCLUDE_PATH=/usr/local/opt/openblas/include:$CMAKE_INCLUDE_PATH
+$ export CMAKE_LIBRARY_PATH=/usr/local/opt/openblas/lib:$CMAKE_LIBRARY_PATH
+</pre></div>
+</div>
+<p>To let the runtime know the openblas path, please export</p>
+<div class="highlight-default"><div class="highlight"><pre>$ export LD_LIBRARY_PATH=/usr/local/opt/openblas/library:$LD_LIBRARY_PATH
+</pre></div>
+</div>
+<p>With the dependent libraries installed, SINGA can be compiled via</p>
+<div class="highlight-default"><div class="highlight"><pre>$ mkdir build
+$ cd build
+$ cmake ..
+$ make
+$ make install
</pre></div>
</div>
<p>After compiling SINGA, you can run the unit tests by</p>
@@ -382,10 +364,46 @@ the following environment variables</p>
</div>
<p>You can see all the testing cases with testing results. If SINGA passes all
tests, then you have successfully installed SINGA. Please proceed to try the examples!</p>
+<p>You can use <code class="docutils literal"><span class="pre">ccmake</span> <span class="pre">..</span></code> to configure the compilation options.
+If some dependent libraries are not in the system default paths, you need to export
+the following environment variables</p>
+<div class="highlight-default"><div class="highlight"><pre><span class="n">export</span> <span class="n">CMAKE_INCLUDE_PATH</span><span class="o">=<</span><span class="n">path</span> <span class="n">to</span> <span class="n">the</span> <span class="n">header</span> <span class="n">file</span> <span class="n">folder</span><span class="o">></span>
+<span class="n">export</span> <span class="n">CMAKE_LIBRARY_PATH</span><span class="o">=<</span><span class="n">path</span> <span class="n">to</span> <span class="n">the</span> <span class="n">lib</span> <span class="n">file</span> <span class="n">folder</span><span class="o">></span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="compile-singa-with-cuda-and-cudnn">
+<span id="compile-singa-with-cuda-and-cudnn"></span><h3>Compile SINGA with CUDA and CUDNN<a class="headerlink" href="#compile-singa-with-cuda-and-cudnn" title="Permalink to this headline">¶</a></h3>
+<p>Users are encouraged to install the cuda and
+<a class="reference external" href="https://developer.nvidia.com/cudnn">cudnn</a> for running SINGA on GPUs to
+get better performance.</p>
+<p>SINGA has been tested over CUDA (7 and 7.5), and CUDNN (4-5.1). If CUDNN is
+decompressed into non-system folder, e.g. /home/bob/local/cudnn/, the following
+commands should be executed for cmake and the runtime to find it</p>
+<div class="highlight-default"><div class="highlight"><pre>$ export CMAKE_INCLUDE_PATH=/home/bob/local/cudnn/include:$CMAKE_INCLUDE_PATH
+$ export CMAKE_LIBRARY_PATH=/home/bob/local/cudnn/lib64:$CMAKE_LIBRARY_PATH
+$ export LD_LIBRARY_PATH=/home/bob/local/cudnn/lib64:$LD_LIBRARY_PATH
+</pre></div>
+</div>
+<p>The cmake options for CUDA and CUDNN should be switched on</p>
+<div class="highlight-default"><div class="highlight"><pre># Dependent libs are install already
+$ cmake -DUSE_CUDA=ON ..
+
+# Compile dependent libs together with SINGA
+$ cmake -DUSE_CUDA=ON -DUSE_MODULES=ON ..
+</pre></div>
+</div>
+</div>
+<div class="section" id="compile-singa-with-opencl-support-linux">
+<span id="compile-singa-with-opencl-support-linux"></span><h3>Compile SINGA with OpenCL support (Linux)<a class="headerlink" href="#compile-singa-with-opencl-support-linux" title="Permalink to this headline">¶</a></h3>
+<p>SINGA uses opencl-headers and viennacl (version 1.7.1 or newer) for OpenCL support, which
+can be installed using via</p>
+<div class="highlight-default"><div class="highlight"><pre># On Ubuntu 16.04
+$ sudo apt-get install opencl-headers, libviennacl-dev
+# On Fedora
+$ sudo yum install opencl-headers, viennacl
+</pre></div>
</div>
-<div class="section" id="opencl-support-linux">
-<span id="opencl-support-linux"></span><h3>OpenCL support (Linux)<a class="headerlink" href="#opencl-support-linux" title="Permalink to this headline">¶</a></h3>
-<p>Install <code class="docutils literal"><span class="pre">opencl-headers</span></code> and <code class="docutils literal"><span class="pre">libviennacl-dev</span></code> (Ubuntu 16) or <code class="docutils literal"><span class="pre">viennacl</span></code> (Fedora).</p>
<p>Additionally, you will need the OpenCL Installable Client Driver (ICD) for the platforms that you want to run OpenCL on.</p>
<ul class="simple">
<li>For AMD and nVidia GPUs, the driver package should also install the correct OpenCL ICD.</li>
@@ -398,14 +416,46 @@ tests, then you have successfully instal
<p>Clone <a class="reference external" href="https://github.com/viennacl/viennacl-dev">the repository from here</a>, checkout the <code class="docutils literal"><span class="pre">release-1.7.1</span></code> tag and build it.
Remember to add its directory to <code class="docutils literal"><span class="pre">PATH</span></code> and the built libraries to <code class="docutils literal"><span class="pre">LD_LIBRARY_PATH</span></code>.</p>
<p>To build SINGA with OpenCL support, you need to pass the flag during cmake:</p>
-<div class="highlight-default"><div class="highlight"><pre><span class="n">cmake</span> <span class="o">..</span> <span class="o">-</span><span class="n">DUSE_OPENCL</span><span class="o">=</span><span class="n">ON</span>
+<div class="highlight-default"><div class="highlight"><pre><span class="n">cmake</span> <span class="o">-</span><span class="n">DUSE_OPENCL</span><span class="o">=</span><span class="n">ON</span> <span class="o">..</span>
</pre></div>
</div>
</div>
-<div class="section" id="windows">
-<span id="windows"></span><h3>Windows<a class="headerlink" href="#windows" title="Permalink to this headline">¶</a></h3>
-<p>To be added.</p>
</div>
+<div class="section" id="build-singa-on-windows">
+<span id="build-singa-on-windows"></span><h2>Build SINGA on Windows<a class="headerlink" href="#build-singa-on-windows" title="Permalink to this headline">¶</a></h2>
+<p>For the dependent library installation, please refer to <a class="reference external" href="dependencies.md">Dependencies</a>.
+After all the dependencies are successfully installed, just run the following commands to
+generate the VS solution in cmd under singa folder:</p>
+<div class="highlight-default"><div class="highlight"><pre>$ md build && cd build
+$ cmake -G "Visual Studio 14" -DUSE_CUDA=OFF -DUSE_PYTHON=OFF ..
+</pre></div>
+</div>
+<p>The default project generated by the command is 32-bit version. You can also
+specify a 64-bit version project by:</p>
+<div class="highlight-default"><div class="highlight"><pre>$ md build && cd build
+$ cmake -G "Visual Studio 14 Win64" -DUSE_CUDA=OFF -DUSE_PYTHON=OFF ..
+</pre></div>
+</div>
+<p>If you get error outputs like “Could NOT find xxxxx” indicating a dependent
+library missing, please configure your library file and include path for cmake or the system.
+For example, you get an error “Could NOT find CBLAS” and suppose you installed
+openblas header files at “d:\include” and openblas library at “d:\lib”. You should run the
+following command to specify your cblas parameters in cmake:</p>
+<div class="highlight-default"><div class="highlight"><pre>$ cmake -G "Visual Studio 14" -DUSE_CUDA=OFF -DUSE_PYTHON=OFF -DCBLAS_INCLUDE_DIR="d:\include" -DCBLAS_LIBRARIES="d:\lib\libopenblas.lib" -DProtobuf_INCLUDE_DIR=<include dir of protobuf> -DProtobuf_LIBRARIES=<path to libprotobuf.lib> -DProtobuf_PROTOC_EXECUTABLE=<path to protoc.exe> -DGLOG_INCLUDE_DIR=<include dir of glog> -DGLOG_LIBRARIES=<path to libglog.lib> ..
+</pre></div>
+</div>
+<p>To find out the parameters you need to specify for some special libraries, you
+can run the following command:</p>
+<div class="highlight-default"><div class="highlight"><pre>$ cmake -LAH
+</pre></div>
+</div>
+<p>If you use cmake GUI tool in windows, please make sure you configure the right
+parameters for the singa solution by select “Advanced” box. After generating the VS project,
+please open the “singa.sln” project file under
+the “build” folder and compile it as a normal VS solution. You will find the
+unit tests file named “test_singa” in the project binary folder.
+If you get errors when running test_singa.exe due to libglog.dll/libopenblas.dll missing,
+please just copy the dll files into the same folder as test_singa.exe</p>
</div>
<div class="section" id="faq">
<span id="faq"></span><h2>FAQ<a class="headerlink" href="#faq" title="Permalink to this headline">¶</a></h2>
@@ -415,13 +465,14 @@ Remember to add its directory to <code c
caused by the dependent libraries, e.g. there are multiple versions of protobuf or missing of cudnn. Following
steps show the solutions for different cases</p>
<ol>
-<li><p class="first">check the cudnn and cuda and gcc versions, cudnn5 and cuda7.5 and gcc4.8/4.9 are preferred. if gcc is 5.0, then downgrade it.
-if cudnn is missing or not match with the wheel version, you can download the correct version of cudnn into ~/local/cudnn/ and</p>
+<li><p class="first">Check the cudnn and cuda and gcc versions, cudnn5 and cuda7.5 and gcc4.8/4.9 are preferred. if gcc is 5.0, then downgrade it.
+If cudnn is missing or not match with the wheel version, you can download the correct version of cudnn into ~/local/cudnn/ and</p>
<div class="highlight-default"><div class="highlight"><pre><span class="n">echo</span> <span class="s">"export LD_LIBRARY_PATH=/home/<yourname>/local/cudnn/lib64:$LD_LIBRARY_PATH"</span> <span class="o">>></span> <span class="o">~/.</span><span class="n">bashrc</span>
</pre></div>
</div>
</li>
-<li><p class="first">if it is the problem related to protobuf, then better install protobuf from source into a local folder, say ~/local/;
+<li><p class="first">If it is the problem related to protobuf, then please download the newest whl files which have <a class="reference external" href="https://issues.apache.org/jira/browse/SINGA-255">compiled protobuf and openblas into the whl</a> file of PySINGA.
+Or you can install protobuf from source into a local folder, say ~/local/;
Decompress the tar file, and then</p>
<div class="highlight-default"><div class="highlight"><pre><span class="o">./</span><span class="n">configure</span> <span class="o">--</span><span class="n">prefix</span><span class="o">=/</span><span class="n">home</span><span class="o">/<</span><span class="n">yourname</span><span class="o">></span><span class="n">local</span>
<span class="n">make</span> <span class="o">&&</span> <span class="n">make</span> <span class="n">install</span>
@@ -430,7 +481,7 @@ Decompress the tar file, and then</p>
</pre></div>
</div>
</li>
-<li><p class="first">if it cannot find other libs including python, then please create virtual env using pip or conda;
+<li><p class="first">If it cannot find other libs including python, then please create virtual env using pip or conda;
and then install SINGA via</p>
<div class="highlight-default"><div class="highlight"><pre><span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">upgrade</span> <span class="o"><</span><span class="n">url</span> <span class="n">of</span> <span class="n">singa</span> <span class="n">wheel</span><span class="o">></span>
</pre></div>
Modified: incubator/singa/site/trunk/en/docs/layer.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/layer.html?rev=1766516&r1=1766515&r2=1766516&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/layer.html (original)
+++ incubator/singa/site/trunk/en/docs/layer.html Tue Oct 25 11:42:44 2016
@@ -33,7 +33,7 @@
<link rel="top" title="incubator-singa 1.0.0 documentation" href="../index.html"/>
<link rel="up" title="Documentation" href="index.html"/>
- <link rel="next" title="Initializer" href="initializer.html"/>
+ <link rel="next" title="FeedForward Net" href="net.html"/>
<link rel="prev" title="Tensor" href="tensor.html"/>
<link href="../_static/style.css" rel="stylesheet" type="text/css">
@@ -100,12 +100,16 @@
<li class="toctree-l3"><a class="reference internal" href="#cpp-api">CPP API</a></li>
</ul>
</li>
+<li class="toctree-l2"><a class="reference internal" href="net.html">FeedForward Net</a></li>
<li class="toctree-l2"><a class="reference internal" href="initializer.html">Initializer</a></li>
<li class="toctree-l2"><a class="reference internal" href="loss.html">Loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="metric.html">Metric</a></li>
<li class="toctree-l2"><a class="reference internal" href="optimizer.html">Optimizer</a></li>
<li class="toctree-l2"><a class="reference internal" href="data.html">Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="image_tool.html">Image Tool</a></li>
+<li class="toctree-l2"><a class="reference internal" href="snapshot.html">Snapshot</a></li>
+<li class="toctree-l2"><a class="reference internal" href="converter.html">Caffe Converter</a></li>
+<li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/index.html">Examples</a></li>
</ul>
</li>
@@ -214,7 +218,7 @@ layer using the engine attribute.</p>
<dl class="class">
<dt id="singa.layer.Layer">
-<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">Layer</code><span class="sig-paren">(</span><em>name</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Layer" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">singa.layer.</code><code class="descname">Layer</code><span class="sig-paren">(</span><em>name</em>, <em>conf=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Layer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Base Python layer class.</p>
<dl class="docutils">
@@ -237,6 +241,12 @@ construct layer with input_sample_shapes
</tbody>
</table>
<dl class="method">
+<dt id="singa.layer.Layer.caffe_layer">
+<code class="descname">caffe_layer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Layer.caffe_layer" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create a singa layer based on caffe layer configuration.</p>
+</dd></dl>
+
+<dl class="method">
<dt id="singa.layer.Layer.param_names">
<code class="descname">param_names</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.layer.Layer.param_names" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
@@ -850,7 +860,7 @@ supported layers</p>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="initializer.html" class="btn btn-neutral float-right" title="Initializer" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="net.html" class="btn btn-neutral float-right" title="FeedForward Net" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="tensor.html" class="btn btn-neutral" title="Tensor" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
Modified: incubator/singa/site/trunk/en/docs/loss.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/loss.html?rev=1766516&r1=1766515&r2=1766516&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/loss.html (original)
+++ incubator/singa/site/trunk/en/docs/loss.html Tue Oct 25 11:42:44 2016
@@ -96,12 +96,16 @@
<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 current"><a class="current reference internal" href="#">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"><a class="reference internal" href="examples/index.html">Examples</a></li>
</ul>
</li>
Modified: incubator/singa/site/trunk/en/docs/metric.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/metric.html?rev=1766516&r1=1766515&r2=1766516&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/metric.html (original)
+++ incubator/singa/site/trunk/en/docs/metric.html Tue Oct 25 11:42:44 2016
@@ -96,12 +96,16 @@
<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 current"><a class="current reference internal" href="#">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"><a class="reference internal" href="examples/index.html">Examples</a></li>
</ul>
</li>
Added: incubator/singa/site/trunk/en/docs/net.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/net.html?rev=1766516&view=auto
==============================================================================
--- incubator/singa/site/trunk/en/docs/net.html (added)
+++ incubator/singa/site/trunk/en/docs/net.html Tue Oct 25 11:42:44 2016
@@ -0,0 +1,277 @@
+
+
+
+<!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>FeedForward Net — incubator-singa 1.0.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+
+
+ <link rel="top" title="incubator-singa 1.0.0 documentation" href="../index.html"/>
+ <link rel="up" title="Documentation" href="index.html"/>
+ <link rel="next" title="Initializer" href="initializer.html"/>
+ <link rel="prev" title="Layer" href="layer.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.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 current"><a class="current reference internal" href="#">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"><a class="reference internal" href="examples/index.html">Examples</a></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 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>FeedForward Net</li>
+ <li class="wy-breadcrumbs-aside">
+
+
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="module-singa.net">
+<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>
+</div>
+
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="initializer.html" class="btn btn-neutral float-right" title="Initializer" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="layer.html" class="btn btn-neutral" title="Layer" 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.0',
+ 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.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/optimizer.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/optimizer.html?rev=1766516&r1=1766515&r2=1766516&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/optimizer.html (original)
+++ incubator/singa/site/trunk/en/docs/optimizer.html Tue Oct 25 11:42:44 2016
@@ -96,12 +96,16 @@
<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 current"><a class="current reference internal" href="#">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"><a class="reference internal" href="examples/index.html">Examples</a></li>
</ul>
</li>
Added: incubator/singa/site/trunk/en/docs/snapshot.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/snapshot.html?rev=1766516&view=auto
==============================================================================
--- incubator/singa/site/trunk/en/docs/snapshot.html (added)
+++ incubator/singa/site/trunk/en/docs/snapshot.html Tue Oct 25 11:42:44 2016
@@ -0,0 +1,314 @@
+
+
+
+<!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>Snapshot — incubator-singa 1.0.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+
+
+ <link rel="top" title="incubator-singa 1.0.0 documentation" href="../index.html"/>
+ <link rel="up" title="Documentation" href="index.html"/>
+ <link rel="next" title="Caffe Converter" href="converter.html"/>
+ <link rel="prev" title="Image Tool" href="image_tool.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.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 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>
+</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 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>Snapshot</li>
+ <li class="wy-breadcrumbs-aside">
+
+
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="module-singa.snapshot">
+<span id="snapshot"></span><h1>Snapshot<a class="headerlink" href="#module-singa.snapshot" title="Permalink to this headline">¶</a></h1>
+<p>This script includes io::snapshot class and its methods.</p>
+<dl class="class">
+<dt id="singa.snapshot.Snapshot">
+<em class="property">class </em><code class="descclassname">singa.snapshot.</code><code class="descname">Snapshot</code><span class="sig-paren">(</span><em>f</em>, <em>mode</em>, <em>buffer_size=10</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.snapshot.Snapshot" title="Permalink to this definition">¶</a></dt>
+<dd><p>Class and member functions for singa::Snapshot.</p>
+<dl class="method">
+<dt id="singa.snapshot.Snapshot.read">
+<code class="descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.snapshot.Snapshot.read" title="Permalink to this definition">¶</a></dt>
+<dd><p>Call read method to load all (param_name, param_val)</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a dict of (parameter name, parameter Tensor)</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="singa.snapshot.Snapshot.write">
+<code class="descname">write</code><span class="sig-paren">(</span><em>param_name</em>, <em>param_val</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.snapshot.Snapshot.write" title="Permalink to this definition">¶</a></dt>
+<dd><p>Call Write method to write a parameter</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>param_name</strong> (<em>string</em>) – name of the parameter</li>
+<li><strong>param_val</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) – value tensor of the parameter</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="converter.html" class="btn btn-neutral float-right" title="Caffe Converter" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="image_tool.html" class="btn btn-neutral" title="Image Tool" 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.0',
+ 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.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/software_stack.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/software_stack.html?rev=1766516&r1=1766515&r2=1766516&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/software_stack.html (original)
+++ incubator/singa/site/trunk/en/docs/software_stack.html Tue Oct 25 11:42:44 2016
@@ -101,12 +101,16 @@
<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"><a class="reference internal" href="examples/index.html">Examples</a></li>
</ul>
</li>
Modified: incubator/singa/site/trunk/en/docs/tensor.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/tensor.html?rev=1766516&r1=1766515&r2=1766516&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/tensor.html (original)
+++ incubator/singa/site/trunk/en/docs/tensor.html Tue Oct 25 11:42:44 2016
@@ -101,12 +101,16 @@
</ul>
</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"><a class="reference internal" href="examples/index.html">Examples</a></li>
</ul>
</li>
@@ -212,7 +216,7 @@ type of Device.</p>
<span class="n">s</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">to_numpy</span><span class="p">()</span> <span class="c"># tensor -> numpy array, r must be on cpu</span>
</pre></div>
</div>
-<p>There are two set of tensor functions,</p>
+<p>There are two sets of tensor functions,</p>
<dl class="docutils">
<dt>Tensor member functions</dt>
<dd>which would change the internal state of the Tensor instance.</dd>
Modified: incubator/singa/site/trunk/en/docs/utils.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/utils.html?rev=1766516&r1=1766515&r2=1766516&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/docs/utils.html (original)
+++ incubator/singa/site/trunk/en/docs/utils.html Tue Oct 25 11:42:44 2016
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Misc. — incubator-singa 1.0.0 documentation</title>
+ <title>Utils — incubator-singa 1.0.0 documentation</title>
@@ -32,6 +32,9 @@
<link rel="top" title="incubator-singa 1.0.0 documentation" href="../index.html"/>
+ <link rel="up" title="Documentation" href="index.html"/>
+ <link rel="next" title="Examples" href="examples/index.html"/>
+ <link rel="prev" title="Caffe Converter" href="converter.html"/>
<link href="../_static/style.css" rel="stylesheet" type="text/css">
@@ -85,9 +88,27 @@
- <ul>
+ <ul class="current">
<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>
+<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 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>
+</ul>
+</li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>
@@ -132,7 +153,9 @@
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> »</li>
- <li>Misc.</li>
+ <li><a href="index.html">Documentation</a> »</li>
+
+ <li>Utils</li>
<li class="wy-breadcrumbs-aside">
@@ -145,7 +168,7 @@
<div itemprop="articleBody">
<div class="section" id="module-singa.utils">
-<span id="misc"></span><h1>Misc.<a class="headerlink" href="#module-singa.utils" title="Permalink to this headline">¶</a></h1>
+<span id="utils"></span><h1>Utils<a class="headerlink" href="#module-singa.utils" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="singa.utils.update_progress">
<code class="descclassname">singa.utils.</code><code class="descname">update_progress</code><span class="sig-paren">(</span><em>progress</em>, <em>info</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.utils.update_progress" title="Permalink to this definition">¶</a></dt>
@@ -171,6 +194,15 @@
</div>
<footer>
+ <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="converter.html" class="btn btn-neutral" title="Caffe Converter" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
<hr/>
Modified: incubator/singa/site/trunk/en/genindex.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/genindex.html?rev=1766516&r1=1766515&r2=1766516&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/genindex.html (original)
+++ incubator/singa/site/trunk/en/genindex.html Tue Oct 25 11:42:44 2016
@@ -166,6 +166,7 @@
| <a href="#S"><strong>S</strong></a>
| <a href="#T"><strong>T</strong></a>
| <a href="#U"><strong>U</strong></a>
+ | <a href="#W"><strong>W</strong></a>
</div>
<h2 id="A">A</h2>
@@ -352,6 +353,10 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
+ <dt><a href="docs/layer.html#singa.layer.Layer.caffe_layer">caffe_layer() (singa.layer.Layer method)</a>
+ </dt>
+
+
<dt><a href="docs/tensor.html#singa.tensor.Tensor.clone">clone() (singa.tensor.Tensor method)</a>
</dt>
@@ -810,6 +815,10 @@
</dt>
+ <dt><a href="docs/snapshot.html#singa.snapshot.Snapshot.read">read() (singa.snapshot.Snapshot method)</a>
+ </dt>
+
+
<dt><a href="docs/optimizer.html#singa.optimizer.Optimizer.register">register() (singa.optimizer.Optimizer method)</a>
</dt>
@@ -835,12 +844,12 @@
</dt>
</dl></dd>
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
<dt><a href="docs/image_tool.html#singa.image_tool.resize">resize() (in module singa.image_tool)</a>
</dt>
- </dl></td>
- <td style="width: 33%" valign="top"><dl>
<dt><a href="docs/image_tool.html#singa.image_tool.ImageTool.resize_by_list">resize_by_list() (singa.image_tool.ImageTool method)</a>
</dt>
@@ -898,6 +907,10 @@
</dt>
+ <dt><a href="docs/converter.html#module-singa.converter">singa.converter (module)</a>
+ </dt>
+
+
<dt><a href="docs/data.html#module-singa.data">singa.data (module)</a>
</dt>
@@ -926,20 +939,28 @@
</dt>
+ <dt><a href="docs/net.html#module-singa.net">singa.net (module)</a>
+ </dt>
+
+
<dt><a href="docs/optimizer.html#module-singa.optimizer">singa.optimizer (module)</a>
</dt>
- <dt><a href="docs/tensor.html#module-singa.tensor">singa.tensor (module)</a>
+ <dt><a href="docs/snapshot.html#module-singa.snapshot">singa.snapshot (module)</a>
</dt>
- <dt><a href="docs/utils.html#module-singa.utils">singa.utils (module)</a>
+ <dt><a href="docs/tensor.html#module-singa.tensor">singa.tensor (module)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
+ <dt><a href="docs/utils.html#module-singa.utils">singa.utils (module)</a>
+ </dt>
+
+
<dt><a href="docs/tensor.html#singa.tensor.Tensor.size">size() (singa.tensor.Tensor method)</a>
</dt>
@@ -948,6 +969,10 @@
</dt>
+ <dt><a href="docs/snapshot.html#singa.snapshot.Snapshot">Snapshot (class in singa.snapshot)</a>
+ </dt>
+
+
<dt><a href="docs/layer.html#singa.layer.Softmax">Softmax (class in singa.layer)</a>
</dt>
@@ -1056,6 +1081,16 @@
</dt>
</dl></td>
+</tr></table>
+
+<h2 id="W">W</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="docs/snapshot.html#singa.snapshot.Snapshot.write">write() (singa.snapshot.Snapshot method)</a>
+ </dt>
+
+ </dl></td>
</tr></table>
Modified: incubator/singa/site/trunk/en/objects.inv
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/objects.inv?rev=1766516&r1=1766515&r2=1766516&view=diff
==============================================================================
Binary files - no diff available.
Modified: incubator/singa/site/trunk/en/py-modindex.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/py-modindex.html?rev=1766516&r1=1766515&r2=1766516&view=diff
==============================================================================
--- incubator/singa/site/trunk/en/py-modindex.html (original)
+++ incubator/singa/site/trunk/en/py-modindex.html Tue Oct 25 11:42:44 2016
@@ -167,6 +167,11 @@
<tr class="cg-1">
<td></td>
<td>
+ <a href="docs/converter.html#module-singa.converter"><code class="xref">singa.converter</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
<a href="docs/data.html#module-singa.data"><code class="xref">singa.data</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
@@ -202,10 +207,20 @@
<tr class="cg-1">
<td></td>
<td>
+ <a href="docs/net.html#module-singa.net"><code class="xref">singa.net</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
<a href="docs/optimizer.html#module-singa.optimizer"><code class="xref">singa.optimizer</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
+ <td>
+ <a href="docs/snapshot.html#module-singa.snapshot"><code class="xref">singa.snapshot</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
<td>
<a href="docs/tensor.html#module-singa.tensor"><code class="xref">singa.tensor</code></a></td><td>
<em></em></td></tr>