| |
| |
| |
| <!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="stylesheet" href="_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link href="_static/style.css" rel="stylesheet" type="text/css"> |
| <!--link href="_static/fontawesome-all.min.css" rel="stylesheet" type="text/css"--> |
| <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous"> |
| <style> |
| .fa:hover { |
| opacity: 0.7; |
| } |
| .fab:hover { |
| opacity: 0.7; |
| } |
| </style> |
| |
| |
| |
| <script src="_static/js/modernizr.min.js"></script> |
| |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search"> |
| |
| |
| |
| <a href="index.html" class="icon icon-home"> incubator-singa |
| |
| |
| |
| |
| <img src="_static/singa.png" class="logo" alt="Logo"/> |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| latest |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="docs/index.html">Documentation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="downloads.html">Download SINGA</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">Development</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="develop/schedule.html">Development Schedule</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="develop/how-contribute.html">How to Contribute to SINGA</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="develop/how-contribute.html#how-to-become-a-singa-committer">How to become a SINGA committer</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="develop/contribute-code.html">How to Contribute Code</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="develop/contribute-docs.html">How to Contribute to Documentation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="develop/how-to-release.html">How to prepare a release</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">Community</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="community/source-repository.html">Source Repository</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="community/mail-lists.html">Project Mailing Lists</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="community/issue-tracking.html">Issue Tracking</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="community/team-list.html">The SINGA Team</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="index.html">incubator-singa</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="index.html">Docs</a> »</li> |
| |
| <li>Documentation</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="documentation"> |
| <h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="docs/index.html">Documentation</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="docs/installation.html">Installation</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="docs/installation.html#from-conda">From Conda</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/installation.html#from-source">From source</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="docs/installation.html#use-conda-to-build-singa">Use Conda to build SINGA</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="docs/installation.html#use-native-tools-to-build-singa-on-ubuntu">Use native tools to build SINGA on Ubuntu</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="docs/installation.html#compile-singa-on-windows">Compile SINGA on Windows</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="docs/installation.html#more-details-about-the-compilation-options">More details about the compilation options</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="docs/installation.html#use-modules">USE_MODULES</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="docs/installation.html#use-python">USE_PYTHON</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/installation.html#use-cuda">USE_CUDA</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/installation.html#use-opencl">USE_OPENCL</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/installation.html#use-mkldnn">USE_MKLDNN</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/installation.html#package">PACKAGE</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/installation.html#faq">FAQ</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/software_stack.html">Software Stack</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="docs/software_stack.html#core">Core</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/software_stack.html#model">Model</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/software_stack.html#io">IO</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/device.html">Device</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="docs/device.html#specific-devices">Specific devices</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/device.html#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/autograd.html">Autograd in Singa</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="docs/autograd.html#relevant-modules">Relevant Modules</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="docs/autograd.html#tensor">Tensor</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="docs/autograd.html#operation">Operation</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="docs/autograd.html#layer">Layer</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/autograd.html#examples">Examples</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="docs/autograd.html#operation-only">Operation only</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="docs/autograd.html#import-packages">Import packages</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/autograd.html#create-weight-matrix-and-bias-vector">Create weight matrix and bias vector</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/autograd.html#training">Training</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="docs/autograd.html#operation-layer">Operation + Layer</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="docs/autograd.html#create-the-layers">Create the layers</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/autograd.html#define-the-forward-function">Define the forward function</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/autograd.html#training">Training</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/data.html">Data</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/image_tool.html">Image Tool</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/snapshot.html">Snapshot</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/converter.html">Caffe Converter</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/utils.html">Utils</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="docs/model_zoo/index.html">Model Zoo</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/cifar10/README.html">Train CNN over Cifar-10</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/cifar10/README.html#instructions">Instructions</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/cifar10/README.html#singa-installation">SINGA installation</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/cifar10/README.html#data-preparation">Data preparation</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/cifar10/README.html#training">Training</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="docs/model_zoo/cifar10/README.html#prediction">Prediction</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/char-rnn/README.html">Train Char-RNN over plain text</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="docs/model_zoo/char-rnn/README.html#instructions">Instructions</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="docs/model_zoo/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> |
| <li class="toctree-l2"><a class="reference internal" href="docs/security.html">Security</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.. |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'./', |
| VERSION:'1.1.0', |
| LANGUAGE:'None', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt' |
| }; |
| </script> |
| <script type="text/javascript" src="_static/jquery.js"></script> |
| <script type="text/javascript" src="_static/underscore.js"></script> |
| <script type="text/javascript" src="_static/doctools.js"></script> |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="_static/js/theme.js"></script> |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> |
| <span class="rst-current-version" data-toggle="rst-current-version"> |
| <span class="fa fa-book"> incubator-singa </span> |
| v: latest |
| <span class="fa fa-caret-down"></span> |
| </span> |
| <div class="rst-other-versions"> |
| <dl> |
| <dt>Languages</dt> |
| <dd><a href="../en/index.html">English</a></dd> |
| <dd><a href="../zh/index.html">中文</a></dd> |
| </dl> |
| <dl> |
| <dt>Versions</dt> |
| <dd><a href="http://singa.apache.org/v0.3.0/">0.3</a></dd> |
| <dd><a href="http://singa.apache.org/v1.1.0/">1.1</a></dd> |
| </dl> |
| |
| </div> |
| <a href="http://incubator.apache.org/"> <img src= "_static/apache.png" style="background-color:white;"> </a> |
| |
| <a href="https://github.com/apache/incubator-singa" class="fa fa-github" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> |
| <a href="https://aws.amazon.com/marketplace/seller-profile?id=5bcac385-12c4-4802-aec7-351e09b77b4c" class="fab fa-aws" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> |
| <a href="https://hub.docker.com/r/apache/singa/" class="fab fa-docker" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> |
| <a href="https://www.linkedin.com/groups/13550034" class="fa fa-linkedin" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> |
| <a href="https://twitter.com/ApacheSinga" class="fa fa-twitter" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> |
| <a href="https://www.facebook.com/Apache-SINGA-347284219056544/" class="fa fa-facebook" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> |
| <a href="https://www.researchgate.net/project/Apache-SINGA" class="fab fa-researchgate" style="padding: 10px; font-size: 20px; width: 30px; text-align: center; text-decoration: none; margin: 5px 2px;"></a> |
| |
| </div> |
| |
| <a href="https://github.com/apache/incubator-singa"> |
| <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;" |
| src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" |
| alt="Fork me on GitHub"> |
| </a> |
| |
| |
| |
| |
| </body> |
| </html> |
