blob: 9b0cc132d638c04ee233b1245747c9137f2f9028 [file] [log] [blame]
<!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>Welcome to Apache SINGA &mdash; incubator-singa 2.0.0 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'2.0.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>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Documentation" href="docs/index.html" />
<link href="_static/style.css" rel="stylesheet" type="text/css">
<!--link href="_static/fontawesome-all.min.css" rel="stylesheet" type="text/css"-->
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous">
<style>
.fa:hover {
opacity: 0.7;
}
.fab:hover {
opacity: 0.7;
}
</style>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" 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>
<li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>
<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="#">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="#">Docs</a> &raquo;</li>
<li>Welcome to Apache SINGA</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="welcome-to-apache-singa">
<h1>Welcome to Apache SINGA<a class="headerlink" href="#welcome-to-apache-singa" title="Permalink to this headline"></a></h1>
<div class="section" id="recent-news">
<h2>Recent News<a class="headerlink" href="#recent-news" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>SINGA has graduated as a Top-Level Project (TLP) of the Apache Software Foundation on 16 Oct 2019.</li>
<li>Food(lg), the mobile app to <a class="reference external" href="https://ssi.nus.edu.sg/ntfgh/">help patients with prediabetes</a>, is powered by SINGA and this app can now be downloaded on the <a class="reference external" href="https://apps.apple.com/us/app/food-lg/id1213299378">APP Store</a> or <a class="reference external" href="https://play.google.com/store/apps/details?id=com.nusidmi.foodlg&amp;hl=en_SG">Google Play</a>. Watch this <a class="reference external" href="https://www.youtube.com/watch?v=MHp-saJiP-0">video</a> of Food(lg) for more details.</li>
<li>A tutorial on SINGA was given at Singapore Infocomm Media Development Authority (IMDA), 16 August, 2019. Snapshots of the tutorial:</li>
</ul>
<a class="reference internal image-reference" href="_static/images/imda2019_1.png"><img alt="_static/images/imda2019_1.png" src="_static/images/imda2019_1.png" style="width: 45%;" /></a>
<a class="reference internal image-reference" href="_static/images/imda2019_2.png"><img alt="_static/images/imda2019_2.png" src="_static/images/imda2019_2.png" style="width: 45%;" /></a>
<ul class="simple">
<li>SINGA participated in mentoring the Google Summer of Code 2019 project <a class="reference external" href="https://summerofcode.withgoogle.com/projects/#5612088771215360">SpamAssassin : Statistical Classifier Plugin</a> .</li>
<li>SINGA participated at <a class="reference external" href="https://eufossa.github.io/apache-hackathon-2019/">EU FOSSA Apache Hackathon</a> in Brussels on 4 and 5 May 2019.</li>
<li><strong>Version 2.0.0</strong> is now available, 20 April, 2019. <a class="reference external" href="downloads.html">Download SINGA v2.0.0</a></li>
<li>SINGA was presented at <a class="reference external" href="https://www.disi.unitn.it/">DISI, University of Trento, Italy</a> on 14 December 2018.</li>
<li>SINGA was presented at <a class="reference external" href="https://www.dibris.unige.it/">DIBRIS, University of Genoa, Italy</a> on 16 July 2018.</li>
<li><strong>Version 1.2.0</strong> is now available, 6 June, 2018. <a class="reference external" href="downloads.html">Download SINGA v1.2.0</a></li>
<li><strong>Version 1.1.0</strong> is now available, 12 Feb, 2017. <a class="reference external" href="downloads.html">Download SINGA v1.1.0</a></li>
<li>A tutorial on SINGA V1 will be given at <a class="reference external" href="https://www.eventbrite.sg/e/ai-eveningssginnovate-apache-singa-tickets-31505061487">SGInnovate</a>, on 23 March, 2017</li>
<li><strong>Version 1.0.0</strong> is now available, 9 Sep, 2016. <a class="reference external" href="downloads.html">Download SINGA v1.0.0</a></li>
<li>SINGA will be presented at <a class="reference external" href="https://www.re-work.co/events/deep-learning-singapore/schedule">REWORK</a>, 21 Oct, 2016.</li>
<li>SINGA was presented at <a class="reference external" href="http://www.meetup.com/PyData-SG/events/229691286/">PyDataSG</a>, 16 Aug, 2016.</li>
<li><strong>Version 0.3.0</strong> is now available, 20 April, 2016. <a class="reference external" href="downloads.html">Download SINGA v0.3.0</a></li>
<li><strong>Version 0.2.0</strong> is now available, 14 Jan, 2016. <a class="reference external" href="downloads.html">Download SINGA v0.2.0</a>.</li>
<li>SINGA will be presented at <a class="reference external" href="http://strataconf.com/big-data-conference-sg-2015/public/schedule/detail/45123">Strata+Hadoop</a> on 2 Dec, 2015</li>
<li>SINGA was presented at <a class="reference external" href="http://www.acmmm.org/2015/at-a-glance/">ACM Multimedia</a> Best Paper session and Open Source Software Competition session, 26-30 Oct, 2015 (<a class="reference external" href="http://www.comp.nus.edu.sg/~dbsystem/singa//assets/file/mm2015.ppt">Slides</a>)</li>
<li><strong>Version 0.1.0</strong> is now available, 8 Oct, 2015. <a class="reference external" href="downloads.html">Download SINGA v0.1.0</a>.</li>
<li>SINGA was presented at <a class="reference external" href="http://www.comp.nus.edu.sg/~dbsystem/singa/workshop">workshop on deep learning</a> held on 16 Sep, 2015</li>
<li>SINGA was presented at <a class="reference external" href="http://boss.dima.tu-berlin.de/">BOSS</a> of <a class="reference external" href="http://www.vldb.org/2015/">VLDB 2015</a> at Hawaii, 4 Sep, 2015. (slides: <a class="reference external" href="http://www.comp.nus.edu.sg/~dbsystem/singa/assets/file/singa-vldb-boss.pptx">overview</a>, <a class="reference external" href="http://www.comp.nus.edu.sg/~dbsystem/singa/assets/file/basic-user-guide.pptx">basic</a>, <a class="reference external" href="http://www.comp.nus.edu.sg/~dbsystem/singa/assets/file/advanced-user-guide.pptx">advanced</a>)</li>
<li>SINGA was presented at <a class="reference external" href="http://adsc.illinois.edu/contact-us">ADSC/I2R Deep Learning Workshop</a>, 25 Aug, 2015.</li>
<li>A tutorial on SINGA was given at VLDB summer school at Tsinghua University, 25-31 July, 2015.</li>
<li>A half day tutorial on SINGA was given at I2R, 29 June, 2015.</li>
<li>SINGA was presented at <a class="reference external" href="http://danac.org/">DanaC</a> of <a class="reference external" href="http://www.sigmod2015.org/index.shtml">SIGMOD 2015</a> at Melbourne, 31 May - 4 June, 2015.</li>
<li>SINGA has been accepted by <a class="reference external" href="http://incubator.apache.org/">Apache Incubator</a>, 17 March, 2015.</li>
</ul>
</div>
<div class="section" id="getting-started">
<h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><a class="reference external" href="docs/installation.html">Install SINGA</a> via conda, apt-get, or from source.</li>
<li>Try SINGA on <a class="reference external" href="https://aws.amazon.com/marketplace/pp/B01NAUAWZW">AWS</a> or via <a class="reference external" href="https://hub.docker.com/r/apache/singa/">Docker</a>.</li>
<li>Refer to the <a class="reference external" href="http://nbviewer.jupyter.org/github/apache/incubator-singa/blob/master/doc/en/docs/notebook/index.ipynb">Jupyter notebooks</a> for some basic examples and the <a class="reference external" href="./docs/model_zoo/index.html">model zoo page</a> for more examples.</li>
</ul>
<table border="1" class="docutils">
<colgroup>
<col width="100%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference external" href="http://nbviewer.jupyter.org/github/apache/incubator-singa/blob/master/doc/en/docs/notebook/index.ipynb"><img alt="logo" class="align-middle" src="_static/jupyter.png" /></a></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="documentation">
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Documentation and Python APIs are listed <a class="reference external" href="docs.html">here</a>.</li>
<li><a class="reference external" href="doxygen/html/index.html">C++ APIs</a> are generated by Doxygen.</li>
<li>Research publication list is available <a class="reference external" href="http://www.comp.nus.edu.sg/~dbsystem/singa/research/publication/">here</a>.</li>
</ul>
</div>
<div class="section" id="how-to-contribute">
<h2>How to contribute<a class="headerlink" href="#how-to-contribute" title="Permalink to this headline"></a></h2>
<p>As with any open source project, there are several ways you can help:</p>
<ul class="simple">
<li>Join the [mailing list](<a class="reference external" href="http://singa.apache.org/en/community/mail-lists.html">http://singa.apache.org/en/community/mail-lists.html</a>) and answer other user&#8217;s questions.</li>
<li>[Help with the documentation](<a class="reference external" href="http://singa.apache.org/en/develop/contribute-docs.html">http://singa.apache.org/en/develop/contribute-docs.html</a>) by updating webpages that are lacking or unclear.</li>
<li>[Contribute code to SINGA](<a class="reference external" href="http://singa.apache.org/en/develop/contribute-code.html">http://singa.apache.org/en/develop/contribute-code.html</a>) by fixing errors or adding new features. [All issues are tracked](<a class="reference external" href="http://singa.apache.org/en/community/issue-tracking.html">http://singa.apache.org/en/community/issue-tracking.html</a>) on the JIRA system.</li>
</ul>
</div>
<div class="section" id="history">
<h2>History<a class="headerlink" href="#history" title="Permalink to this headline"></a></h2>
<p>SINGA was initiated by the DB System Group at National University of Singapore in 2014, in collaboration with the database group of Zhejiang University.
Please cite the following two papers if you use SINGA in your research:</p>
<ul class="simple">
<li>B. C. Ooi, K.-L. Tan, S. Wang, W. Wang, Q. Cai, G. Chen, J. Gao, Z. Luo, A. K. H. Tung, Y. Wang, Z. Xie, M. Zhang, and K. Zheng. <a class="reference external" href="http://www.comp.nus.edu.sg/~ooibc/singaopen-mm15.pdf">SINGA: A distributed deep learning platform</a>. ACM Multimedia (Open Source Software Competition) 2015 (<a class="reference external" href="http://www.comp.nus.edu.sg/~dbsystem/singa//assets/file/bib-oss.txt">BibTex</a>).</li>
<li>W. Wang, G. Chen, T. T. A. Dinh, B. C. Ooi, K.-L.Tan, J. Gao, and S. Wang. <a class="reference external" href="http://www.comp.nus.edu.sg/~ooibc/singa-mm15.pdf">SINGA: putting deep learning in the hands of multimedia users</a>. ACM Multimedia 2015 (<a class="reference external" href="http://www.comp.nus.edu.sg/~dbsystem/singa//assets/file/bib-singa.txt">BibTex</a>, <a class="reference external" href="http://www.comp.nus.edu.sg/~dbsystem/singa/assets/file/mm2015.ppt">Slides</a>).</li>
</ul>
<p>Rafiki is a sub module of SINGA. Please cite the following paper if you use Rafiki in your research:</p>
<ul class="simple">
<li>Wei Wang, Jinyang Gao, Meihui Zhang, Sheng Wang, Gang Chen, Teck Khim Ng, Beng Chin Ooi, Jie Shao, Moaz Reyad. <a class="reference external" href="http://www.vldb.org/pvldb/vol12/p128-wang.pdf">Rafiki: Machine Learning as an Analytics Service System</a>. <a class="reference external" href="http://vldb.org/2019/">VLDB 2019</a> (<a class="reference external" href="https://dblp.org/rec/bib2/journals/pvldb/WangWGZCNOS18.bib">BibTex</a>).</li>
</ul>
<p>Companies like <a class="reference external" href="http://tech.163.com/17/0602/17/CLUL016I00098GJ5.html">NetEase</a>, <a class="reference external" href="http://www.yzbigdata.com/en/index.html">yzBigData</a>, <a class="reference external" href="https://shentilium.com/">Shentilium</a>, <a class="reference external" href="http://www.foodlg.com/">Foodlg</a> and <a class="reference external" href="https://medilot.com/technologies">Medilot</a> are using SINGA for their applications.</p>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h2>
<p>SINGA is released under <a class="reference external" href="http://www.apache.org/licenses/LICENSE-2.0">Apache License Version 2.0</a>.</p>
</div>
<div class="section" id="disclaimers">
<h2>Disclaimers<a class="headerlink" href="#disclaimers" title="Permalink to this headline"></a></h2>
<p>Apache SINGA is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="docs/index.html" class="btn btn-neutral float-right" title="Documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> incubator-singa </span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Languages</dt>
<dd><a href="./index.html">English</a></dd>
<dd><a href="./zh/index.html">中文</a></dd>
</dl>
<dl>
<dt>Versions</dt>
<dd><a href="http://singa.apache.org/v0.3.0/">0.3</a></dd>
<dd><a href="http://singa.apache.org/v1.1.0/">1.1</a></dd>
</dl>
</div>
<a href="http://incubator.apache.org/"> <img src= "_static/apache.png" style="background-color:white;"> </a>
<a href="http://www.apache.org" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Foundation</a>
<a href="http://www.apache.org/events/current-event" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Events</a>
<a href="http://www.apache.org/foundation/thanks.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Thanks</a>
<a href="http://www.apache.org/foundation/sponsorship.html" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">Sponsorship</a>
<a href="http://www.apache.org/licenses/" style="color:lightblue;padding: 5px; font-size: 10px; text-align: center; text-decoration: none; margin: 5px 2px;">License</a>
<br>
<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>