| |
| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>Documentation — incubator-singa 1.1.0 documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
| |
| |
| |
| |
| |
| <link rel="top" title="incubator-singa 1.1.0 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"> |
| latest |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="downloads.html">Download SINGA</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="docs/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>Documentation</li> |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="documentation"> |
| <h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="docs/index.html">Documentation</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="docs/installation.html">Installation</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="docs/installation.html#from-wheel">From wheel</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="docs/installation.html#pre-requisite">Pre-requisite</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="docs/installation.html#virtual-environment">Virtual environment</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="docs/installation.html#instructions">Instructions</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/installation.html#from-debian-package">From Debian Package</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/installation.html#from-source">From source</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="docs/installation.html#pre-requisite">Pre-requisite</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="docs/installation.html#instructions">Instructions</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="docs/installation.html#linux-and-mac-os">Linux and Mac OS</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="docs/installation.html#compile-with-use-modules-on">Compile with USE_MODULES=ON</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/installation.html#compile-with-use-python-on">Compile with USE_PYTHON=ON</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/installation.html#compile-singa-with-use-cuda-on">Compile SINGA with USE_CUDA=ON</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/installation.html#compile-singa-with-use-opencl-on">Compile SINGA with USE_OPENCL=ON</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="docs/installation.html#compile-singa-on-windows">Compile SINGA on Windows</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/installation.html#faq">FAQ</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/software_stack.html">Software Stack</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="docs/software_stack.html#core">Core</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/software_stack.html#model">Model</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/software_stack.html#io">IO</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/device.html">Device</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="docs/device.html#specific-devices">Specific devices</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/device.html#module-singa.device">Python API</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/device.html#cpp-api">CPP API</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/tensor.html">Tensor</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="docs/tensor.html#tensor-implementation">Tensor implementation</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/tensor.html#module-singa.tensor">Python API</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/tensor.html#cpp-api">CPP API</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/layer.html">Layer</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="docs/layer.html#module-singa.layer">Python API</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/layer.html#cpp-api">CPP API</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/net.html">FeedForward Net</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/initializer.html">Initializer</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="docs/initializer.html#module-singa.initializer">Python API</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/initializer.html#cpp-api">CPP API</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/loss.html">Loss</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/metric.html">Metric</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/optimizer.html">Optimizer</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/data.html">Data</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/image_tool.html">Image Tool</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/snapshot.html">Snapshot</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/converter.html">Caffe Converter</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/utils.html">Utils</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/model_zoo/index.html">Model Zoo</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/cifar10/README.html">Train CNN over Cifar-10</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/cifar10/README.html#instructions">Instructions</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/cifar10/README.html#singa-installation">SINGA installation</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/cifar10/README.html#data-preparation">Data preparation</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/cifar10/README.html#training">Training</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/cifar10/README.html#prediction">Prediction</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/char-rnn/README.html">Train Char-RNN over plain text</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/char-rnn/README.html#instructions">Instructions</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/imagenet/alexnet/README.html">Train AlexNet over ImageNet</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/imagenet/alexnet/README.html#instructions">Instructions</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/imagenet/alexnet/README.html#compile-singa">Compile SINGA</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/imagenet/alexnet/README.html#data-download">Data download</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/imagenet/alexnet/README.html#data-preprocessing">Data preprocessing</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/imagenet/alexnet/README.html#training">Training</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/imagenet/googlenet/README.html">Image Classification using GoogleNet</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/imagenet/googlenet/README.html#instructions">Instructions</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/imagenet/googlenet/README.html#details">Details</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| |
| |
| </div> |
| </div> |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © Copyright 2017 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.1.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"> |
| <span class="rst-current-version" data-toggle="rst-current-version"> |
| <span class="fa fa-book"> incubator-singa </span> |
| v: latest |
| <span class="fa fa-caret-down"></span> |
| </span> |
| <div class="rst-other-versions"> |
| <dl> |
| <dt>Languages</dt> |
| <dd><a href="../en/index.html">English</a></dd> |
| <dd><a href="../zh/index.html">中文</a></dd> |
| </dl> |
| <dl> |
| <dt>Versions</dt> |
| <dd><a href="http://singa.apache.org/v0.3.0/">0.3</a></dd> |
| <dd><a href="http://singa.apache.org/v1.1.0/">1.1</a></dd> |
| </dl> |
| |
| </div> |
| <a href="http://incubator.apache.org/"> <img src= "_static/apache.jpg"> </a> |
| </div> |
| |
| <a href="https://github.com/apache/incubator-singa"> |
| <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;" |
| src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" |
| alt="Fork me on GitHub"> |
| </a> |
| |
| |
| |
| |
| </body> |
| </html> |
