Repository: incubator-singa Updated Branches: refs/heads/master 6a4a0f7d3 -> 9b2d16134
update docs for the release of v1.1. Project: http://git-wip-us.apache.org/repos/asf/incubator-singa/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-singa/commit/9b2d1613 Tree: http://git-wip-us.apache.org/repos/asf/incubator-singa/tree/9b2d1613 Diff: http://git-wip-us.apache.org/repos/asf/incubator-singa/diff/9b2d1613 Branch: refs/heads/master Commit: 9b2d161344c3d69e55778f720f8334b6535ec642 Parents: 6a4a0f7 Author: Wei Wang <[email protected]> Authored: Mon Feb 13 10:55:11 2017 +0800 Committer: Wei Wang <[email protected]> Committed: Mon Feb 13 12:08:47 2017 +0800 ---------------------------------------------------------------------- doc/Doxyfile | 4 +-- doc/README.md | 10 ++++-- doc/_templates/layout.html | 30 +++++++++--------- doc/conf.py | 2 +- doc/en/downloads.md | 29 +++++++++++++++-- doc/en/index.rst | 8 +++-- doc/en/releases/RELEASE_NOTES_1.1.0.md | 49 +++++++++++++++++++++++++++++ 7 files changed, 105 insertions(+), 27 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/9b2d1613/doc/Doxyfile ---------------------------------------------------------------------- diff --git a/doc/Doxyfile b/doc/Doxyfile index 47a819a..9acf824 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -104,11 +104,11 @@ WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = NO WARN_FORMAT = "$file:$line: $text" WARN_LOGFILE = -INPUT = "../include" +INPUT = ../include ../build/include INPUT_ENCODING = UTF-8 FILE_PATTERNS = RECURSIVE = YES -EXCLUDE = +EXCLUDE = ../build/include/singa/proto/caffe.pb.h EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = EXCLUDE_SYMBOLS = http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/9b2d1613/doc/README.md ---------------------------------------------------------------------- diff --git a/doc/README.md b/doc/README.md index 7253b23..dac708a 100644 --- a/doc/README.md +++ b/doc/README.md @@ -4,16 +4,20 @@ ## Website This document gives step-by-step instructions for deploying [Singa website](http://singa.incubator.apache.org). -Singa website is built by [Sphinx](http://www.sphinx-doc.org) 1.4.4 from a source tree stored in git: https://github.com/apache/incubator-singa/tree/master/doc. +Singa website is built by [Sphinx](http://www.sphinx-doc.org) >=1.4.4 from a source tree stored in git: https://github.com/apache/incubator-singa/tree/master/doc. -To install Sphinx on Ubuntu: +To install Sphinx: - $ apt-get install python-sphinx + $ pip install -U Sphinx To install the markdown support for Sphinx: $ pip install recommonmark +To install the rtd theme: + + $ pip install sphinx_rtd_theme + You can build the website by executing the following command from the doc folder: $ ./build.sh html http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/9b2d1613/doc/_templates/layout.html ---------------------------------------------------------------------- diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html index b149652..3dca570 100755 --- a/doc/_templates/layout.html +++ b/doc/_templates/layout.html @@ -24,27 +24,25 @@ {% block footer %} <div class="rst-versions shift-up" data-toggle="rst-versions" role="note" aria-label="versions"> -<a href="http://incubator.apache.org/";> -<img src= "{{pathto('_static/'+ 'apache.jpg' , 1) }}"> -</a> - <span class="rst-current-version" data-toggle="rst-current-version"> <span class="fa fa-book"> incubator-singa </span> v: {{ version }} <span class="fa fa-caret-down"></span> </span> - <div class="rst-other-versions"> - <dl> - <dt>Languages</dt> - <dd><a href="{{ pathto('../en/index.html', 1) }}">English</a></dd> - <dd><a href="{{ pathto('../zh/index.html', 1) }}">ä¸æ</a></dd> - </dl> - <dl> - <dt>Versions</dt> - <dd><a href="http://singa.apache.org/v0.3.0/";>0.3</a></dd> - </dl> - - </div> + <div class="rst-other-versions"> + <dl> + <dt>Languages</dt> + <dd><a href="{{ pathto('../en/index.html', 1) }}">English</a></dd> + <dd><a href="{{ pathto('../zh/index.html', 1) }}">ä¸æ</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= "{{pathto('_static/'+ 'apache.jpg' , 1) }}"> </a> </div> <a href="https://github.com/apache/incubator-singa";> http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/9b2d1613/doc/conf.py ---------------------------------------------------------------------- diff --git a/doc/conf.py b/doc/conf.py index 17f1949..150084d 100755 --- a/doc/conf.py +++ b/doc/conf.py @@ -79,7 +79,7 @@ author = u'moaz' # built documents. # # The short X.Y version. -version = u'1.1' +version = u'latest' # The full version, including alpha/beta/rc tags. release = u'1.1.0' http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/9b2d1613/doc/en/downloads.md ---------------------------------------------------------------------- diff --git a/doc/en/downloads.md b/doc/en/downloads.md index 61654b1..a7d5189 100644 --- a/doc/en/downloads.md +++ b/doc/en/downloads.md @@ -2,10 +2,33 @@ * Latest code: please clone the dev branch from [Github](https://github.com/apache/incubator-singa) +* v1.1.0 (12 February 2017): + * [Apache SINGA 1.1.0](http://www.apache.org/dyn/closer.cgi/incubator/singa/1.1.0/apache-singa-incubating-1.1.0.tar.gz) + [\[MD5\]](https://dist.apache.org/repos/dist/release/incubator/singa/1.1.0/apache-singa-incubating-1.1.0.tar.gz.md5) + [\[KEYS\]](https://dist.apache.org/repos/dist/release/incubator/singa/1.1.0/KEYS) + * [Release Notes 1.1.0](releases/RELEASE_NOTES_1.1.0.html) + * New features and major updates, + * Create Docker images (CPU and GPU versions) + * Create Amazon AMI for SINGA (CPU version) + * Integrate with Jenkins for automatically generating Wheel and Debian packages (for installation), and updating the website. + * Enhance the FeedFowardNet, e.g., multiple inputs and verbose mode for debugging + * Add Concat and Slice layers + * Extend CrossEntropyLoss to accept instance with multiple labels + * Add image_tool.py with image augmentation methods + * Support model loading and saving via the Snapshot API + * Compile SINGA source on Windows + * Compile mandatory dependent libraries together with SINGA code + * Enable Java binding (basic) for SINGA + * Add version ID in checkpointing files + * Add Rafiki toolkit for providing RESTFul APIs + * Add examples pretrained from Caffe, including GoogleNet + + + * v1.0.0 (8 September 2016): - * [Apache SINGA 1.0.0](http://www.apache.org/dyn/closer.cgi/incubator/singa/1.0.0/apache-singa-incubating-1.0.0.tar.gz) - [\[MD5\]](https://dist.apache.org/repos/dist/release/incubator/singa/1.0.0/apache-singa-incubating-1.0.0.tar.gz.md5) - [\[KEYS\]](https://dist.apache.org/repos/dist/release/incubator/singa/1.0.0/KEYS) + * [Apache SINGA 1.0.0](https://archive.apache.org/dist/incubator/singa/1.0.0/apache-singa-incubating-1.0.0.tar.gz) + [\[MD5\]](https://archive.apache.org/dist/incubator/singa/1.0.0/apache-singa-incubating-1.0.0.tar.gz.md5) + [\[KEYS\]](https://archive.apache.org/dist/incubator/singa//1.0.0/KEYS) * [Release Notes 1.0.0](releases/RELEASE_NOTES_1.0.0.html) * New features and major updates, * Tensor abstraction for supporting more machine learning models. http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/9b2d1613/doc/en/index.rst ---------------------------------------------------------------------- diff --git a/doc/en/index.rst b/doc/en/index.rst index 6d17557..dd76d83 100755 --- a/doc/en/index.rst +++ b/doc/en/index.rst @@ -26,6 +26,10 @@ Welcome to Apache Singa Recent News ----------- +* **Version 1.1** is now available, 12 Feb, 2017. `Download SINGA v1.1.0 <downloads.html>`_ + +* A tutorial on SINGA V1 will be given at `SGInnovate <https://www.eventbrite.sg/e/ai-eveningssginnovate-apache-singa-tickets-31505061487>`_, on 23 March, 2017 + * **Version 1** is now available, 9 Sep, 2016. `Download SINGA v1.0.0 <downloads.html>`_ * SINGA will be presented at `REWORK <https://www.re-work.co/events/deep-learning-singapore/schedule>`_, 21 Oct, 2016. @@ -67,8 +71,8 @@ Getting Started Documentation ------------- -* Documentation and APIs are listed `here <docs.html>`_. - +* Documentation and Python APIs are listed `here <docs.html>`_. +* `C++ APIs <http://www.comp.nus.edu.sg/~dbsystem/singa/api/>`_ are generated by Doxygen. * Research publication list is available `here <http://www.comp.nus.edu.sg/~dbsystem/singa/research/publication/>`_. How to contribute http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/9b2d1613/doc/en/releases/RELEASE_NOTES_1.1.0.md ---------------------------------------------------------------------- diff --git a/doc/en/releases/RELEASE_NOTES_1.1.0.md b/doc/en/releases/RELEASE_NOTES_1.1.0.md new file mode 100644 index 0000000..612fb97 --- /dev/null +++ b/doc/en/releases/RELEASE_NOTES_1.1.0.md @@ -0,0 +1,49 @@ +#singa-incubating-1.1.0 Release Notes + +--- + +SINGA is a general distributed deep learning platform for training big deep +learning models over large datasets. + +This release includes following features: + + * Core components + * [SINGA-296] Add sign and to_host function for pysinga tensor module + + * Model components + * [SINGA-254] Implement Adam for V1 + * [SINGA-264] Extend the FeedForwardNet to accept multiple inputs + * [SINGA-267] Add spatial mode in batch normalization layer + * [SINGA-271] Add Concat and Slice layers + * [SINGA-275] Add Cross Entropy Loss for multiple labels + * [SINGA-278] Convert trained caffe parameters to singa + * [SINGA-287] Add memory size check for cudnn convolution + + * Utility functions and CI + * [SINGA-242] Compile all source files into a single library. + * [SINGA-244] Separating swig interface and python binding files + * [SINGA-246] Imgtool for image augmentation + * [SINGA-247] Add windows support for singa + * [SINGA-251] Implement image loader for pysinga + * [SINGA-252] Use the snapshot methods to dump and load models for pysinga + * [SINGA-255] Compile mandatory dependent libaries together with SINGA code + * [SINGA-259] Add maven pom file for building java classes + * [SINGA-261] Add version ID into the checkpoint files + * [SINGA-266] Add Rafiki python toolkits + * [SINGA-273] Improve license and contributions + * [SINGA-284] Add python unittest into Jenkins and link static libs into whl file + * [SINGA-280] Jenkins CI support + * [SINGA-288] Publish wheel of PySINGA generated by Jenkins to public servers + + * Documentation and usability + * [SINGA-263] Create Amazon Machine Image + * [SINGA-268] Add IPython notebooks to the documentation + * [SINGA-276] Create docker images + * [SINGA-289] Update SINGA website automatically using Jenkins + * [SINGA-295] Add an example of image classification using GoogleNet + + * Bugs fixed + * [SINGA-245] float as the first operand can not multiply with a tensor object + * [SINGA-293] Bug from compiling PySINGA on Mac OS X with multiple version of Python + +
