udpate docs for v1 release.
Project: http://git-wip-us.apache.org/repos/asf/incubator-singa/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-singa/commit/bc699f4e Tree: http://git-wip-us.apache.org/repos/asf/incubator-singa/tree/bc699f4e Diff: http://git-wip-us.apache.org/repos/asf/incubator-singa/diff/bc699f4e Branch: refs/heads/master Commit: bc699f4e409c7c193d278a04cf3214800a4eaecd Parents: 8732021 Author: Wei Wang <[email protected]> Authored: Thu Sep 15 22:09:46 2016 +0800 Committer: Wei Wang <[email protected]> Committed: Thu Sep 15 22:09:46 2016 +0800 ---------------------------------------------------------------------- doc/en/community/team-list.rst | 89 ++++++++++++++--------------- doc/en/develop/contribute-docs.md | 2 +- doc/en/develop/how-contribute.md | 2 +- doc/en/develop/schedule.rst | 6 +- doc/en/docs/installation.md | 10 +++- doc/en/downloads.md | 29 ++++++++-- doc/en/index.rst | 12 +++- doc/en/releases/RELEASE_NOTES_0.3.0.md | 4 +- 8 files changed, 91 insertions(+), 63 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/bc699f4e/doc/en/community/team-list.rst ---------------------------------------------------------------------- diff --git a/doc/en/community/team-list.rst b/doc/en/community/team-list.rst index abff0a8..668810d 100644 --- a/doc/en/community/team-list.rst +++ b/doc/en/community/team-list.rst @@ -28,55 +28,52 @@ Mentors Name Email ================== ============ Daniel Dai [email protected] -Ted Dunning [email protected] -Alan Gates [email protected] -Thejas Nair [email protected] +Ted Dunning [email protected] +Alan Gates [email protected] +Thejas Nair [email protected] ================== ============ + Developers ---------- -+-------------------+--------------------------------+----------------------------------------------+ -| Name | Email | Organization | -+-------------------+--------------------------------+----------------------------------------------+ -|Gang Chen | [email protected] | Zhejiang University | -+-------------------+--------------------------------+----------------------------------------------+ -| Haibo Chen | [email protected] | NetEase | -+-------------------+--------------------------------+----------------------------------------------+ -| Anh Dinh | [email protected] | National University of Singapore | -+-------------------+--------------------------------+----------------------------------------------+ -| Jinyang Gao | [email protected] | National University of Singapore | -+-------------------+--------------------------------+----------------------------------------------+ -| Xing Ji | [email protected] | National University of Singapore | -+-------------------+--------------------------------+----------------------------------------------+ -| Chonho Lee | [email protected] | National University of Singapore | -+-------------------+--------------------------------+----------------------------------------------+ -| Zhaojing Luo | [email protected] | National University of Singapore | -+-------------------+--------------------------------+----------------------------------------------+ -| Beng Chin Ooi | [email protected] | National University of Singapore | -+-------------------+--------------------------------+----------------------------------------------+ -| Kian-Lee Tan | [email protected] | National University of Singapore | -+-------------------+--------------------------------+----------------------------------------------+ -|Anthony K. H. Tung | [email protected] | National University of Singapore | -+-------------------+--------------------------------+----------------------------------------------+ -| Ji Wang | [email protected] | National University of Singapore | -+-------------------+--------------------------------+----------------------------------------------+ -| Sheng Wang | [email protected] | National University of Singapore | -+-------------------+--------------------------------+----------------------------------------------+ -| Wei Wang | [email protected] | National University of Singapore | -+-------------------+--------------------------------+----------------------------------------------+ -| Yuan Wang | [email protected] | NetEase | -+-------------------+--------------------------------+----------------------------------------------+ -| Wenfeng Wu | [email protected] | National University of Singapore | -+-------------------+--------------------------------+----------------------------------------------+ -| Zhongle Xie | [email protected] | National University of Singapore | -+-------------------+--------------------------------+----------------------------------------------+ -| Meihui Zhang | [email protected] |Singapore University of Technology and Design | -+-------------------+--------------------------------+----------------------------------------------+ -| Kaiping Zheng | [email protected] | National University of Singapore | -+-------------------+--------------------------------+----------------------------------------------+ -| Ming Zhong | [email protected] | Zhejiang University | -+-------------------+--------------------------------+----------------------------------------------+ - - ++--------------------+--------------------------------+-----------------------------------------------+ +| Name | Email | Organization | ++====================+================================+===============================================+ +| Gang Chen | [email protected] | Zhejiang University | ++--------------------+--------------------------------+-----------------------------------------------+ +| Haibo Chen | [email protected] | NetEase | ++--------------------+--------------------------------+-----------------------------------------------+ +| Anh Dinh | [email protected] | National University of Singapore | ++--------------------+--------------------------------+-----------------------------------------------+ +| Jinyang Gao | [email protected] | National University of Singapore | ++--------------------+--------------------------------+-----------------------------------------------+ +| Xing Ji | [email protected] | National University of Singapore | ++--------------------+--------------------------------+-----------------------------------------------+ +| Chonho Lee | [email protected] | Osaka University | ++--------------------+--------------------------------+-----------------------------------------------+ +| Zhaojing Luo | [email protected] | National University of Singapore | ++--------------------+--------------------------------+-----------------------------------------------+ +| Beng Chin Ooi | [email protected] | National University of Singapore | ++--------------------+--------------------------------+-----------------------------------------------+ +| Kian-Lee Tan | [email protected] | National University of Singapore | ++--------------------+--------------------------------+-----------------------------------------------+ +| Anthony K. H. Tung | [email protected] | National University of Singapore | ++--------------------+--------------------------------+-----------------------------------------------+ +| Ji Wang | [email protected] | National University of Singapore | ++--------------------+--------------------------------+-----------------------------------------------+ +| Sheng Wang | [email protected] | National University of Singapore | ++--------------------+--------------------------------+-----------------------------------------------+ +| Wei Wang | [email protected] | National University of Singapore | ++--------------------+--------------------------------+-----------------------------------------------+ +| Yuan Wang | [email protected] | NetEase | ++--------------------+--------------------------------+-----------------------------------------------+ +| Wenfeng Wu | [email protected] | National University of Singapore | ++--------------------+--------------------------------+-----------------------------------------------+ +| Zhongle Xie | [email protected] | National University of Singapore | ++--------------------+--------------------------------+-----------------------------------------------+ +| Meihui Zhang | [email protected] | Singapore University of Technology and Design | ++--------------------+--------------------------------+-----------------------------------------------+ +| Kaiping Zheng | [email protected] | National University of Singapore | ++--------------------+--------------------------------+-----------------------------------------------+ http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/bc699f4e/doc/en/develop/contribute-docs.md ---------------------------------------------------------------------- diff --git a/doc/en/develop/contribute-docs.md b/doc/en/develop/contribute-docs.md index 5e21a0f..c32c623 100644 --- a/doc/en/develop/contribute-docs.md +++ b/doc/en/develop/contribute-docs.md @@ -18,7 +18,7 @@ To install the markdown support for Sphinx: You can build the website by executing the following command from the doc folder: - $ make html + $ ./build.sh html The procedure for contributing documentation is the same as [contributing code](contribute-code.html). http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/bc699f4e/doc/en/develop/how-contribute.md ---------------------------------------------------------------------- diff --git a/doc/en/develop/how-contribute.md b/doc/en/develop/how-contribute.md index 8687b5a..4e7670b 100644 --- a/doc/en/develop/how-contribute.md +++ b/doc/en/develop/how-contribute.md @@ -5,7 +5,7 @@ ___ As with any open source project, there are several ways you can help: * Join the [mailing list](../community/mail-lists.html) and answer other user's questions. -* [Build Singa](../quick-start.html) for yourself, in order to fix bugs. +* [Build Singa](../docs/installation.html) by yourself. * Report bugs, feature requests and other issues in the [issue tracking](../community/issue-tracking.html) application. * Check SINGA's [development schedule](schedule.html) and [contribute code](contribute-code.html) by providing patches. * [Help with the documentation](contribute-docs.html) by updating webpages that are lacking or unclear. http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/bc699f4e/doc/en/develop/schedule.rst ---------------------------------------------------------------------- diff --git a/doc/en/develop/schedule.rst b/doc/en/develop/schedule.rst index 73d713c..ef51496 100644 --- a/doc/en/develop/schedule.rst +++ b/doc/en/develop/schedule.rst @@ -47,11 +47,11 @@ Development Schedule " "," Installation "," Remove dependency on ZeroMQ, CZMQ, Zookeeper for single node training","done" " "," Updater "," Add new SGD updaters including Adam, AdamMax and AdaDelta","done" " "," Binding "," Enhance Python binding for training","done" - "1.0 Aug 2016 "," Programming abstraction ","Tensor with linear algebra, neural net and random operations "," " + "1.0 Sep 2016 "," Programming abstraction ","Tensor with linear algebra, neural net and random operations "," " " "," ","Updater for distributed parameter updating ","" - " "," Optimization "," Execution and memory optimization","" " "," Hardware "," Use Cuda and Cudnn for Nvidia GPU","" " "," "," Use OpenCL for AMD GPU or other devices","" - " "," Cross-platform "," To extend from Linux to MacOS and Windows","" + " "," Cross-platform "," To extend from Linux to MacOS","" " "," Examples "," Speech recognition example","" " "," ","Large image models, e.g., [VGG](https://arxiv.org/pdf/1409.1556.pdf) and [Residual Net](http://arxiv.org/abs/1512.03385)","" + "1.1 Dec 2016 "," ",""," " http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/bc699f4e/doc/en/docs/installation.md ---------------------------------------------------------------------- diff --git a/doc/en/docs/installation.md b/doc/en/docs/installation.md index 6dda3f4..e18447b 100755 --- a/doc/en/docs/installation.md +++ b/doc/en/docs/installation.md @@ -60,7 +60,7 @@ By default, openblas is installed into /usr/local/opt/openblas. To let the compi path, please export $ export CMAKE_INCLUDE_PATH=/usr/local/opt/openblas/include:$CMAKE_INCLUDE_PATH - $ export CMAKE_LIBRARY_PATH=/usr/local/opt/openblas/library:$CMAKE_LIBRARY_PATH + $ export CMAKE_LIBRARY_PATH=/usr/local/opt/openblas/lib:$CMAKE_LIBRARY_PATH To let the runtime know the openblas path, please export @@ -99,6 +99,12 @@ After installing the dependencies for SINGA and PySINGA, please download the cor # 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 + + # 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/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 @@ -116,7 +122,7 @@ to avoid the conflicts of system path and virtual environment path. ### From source -Please compile SINGA from source (see the next section) with the 'USE_PYTHON' option on, +Please compile SINGA from source (see the next section) with the 'USE_PYTHON' option on (`cmake -DUSE_PYTHON=ON ..`), and then run the following commands, # under the build directory http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/bc699f4e/doc/en/downloads.md ---------------------------------------------------------------------- diff --git a/doc/en/downloads.md b/doc/en/downloads.md index fe0c30a..61654b1 100644 --- a/doc/en/downloads.md +++ b/doc/en/downloads.md @@ -2,10 +2,29 @@ * Latest code: please clone the dev branch from [Github](https://github.com/apache/incubator-singa) +* 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) + * [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. + * Device abstraction for running on different hardware devices, including CPU, (Nvidia/AMD) GPU and FPGA (to be tested in later versions). + * Replace GNU autotool with cmake for compilation. + * Support Mac OS + * Improve Python binding, including installation and programming + * More deep learning models, including VGG and ResNet + * More IO classes for reading/writing files and encoding/decoding data + * New network communication components directly based on Socket. + * Cudnn V5 with Dropout and RNN layers. + * Replace website building tool from maven to Sphinx + * Integrate Travis-CI + + * v0.3.0 (20 April 2016): - * [Apache SINGA 0.3.0](http://www.apache.org/dyn/closer.cgi/incubator/singa/0.3.0/apache-singa-incubating-0.3.0.tar.gz) - [\[MD5\]](https://dist.apache.org/repos/dist/release/incubator/singa/0.3.0/apache-singa-incubating-0.3.0.tar.gz.md5) - [\[KEYS\]](https://dist.apache.org/repos/dist/release/incubator/singa/0.3.0/KEYS) + * [Apache SINGA 0.3.0](https://archive.apache.org/dist/incubator/singa/0.3.0/apache-singa-incubating-0.3.0.tar.gz) + [\[MD5\]](https://archive.apache.org/dist/incubator/singa/0.3.0/apache-singa-incubating-0.3.0.tar.gz.md5) + [\[KEYS\]](https://archive.apache.org/dist/incubator/singa/0.3.0/KEYS) * [Release Notes 0.3.0](releases/RELEASE_NOTES_0.3.0.html) * New features and major updates, * [Training on GPU cluster](v0.3.0/gpu.html) enables training of deep learning models over a GPU cluster. @@ -20,7 +39,7 @@ * v0.2.0 (14 January 2016): - * [Apache SINGA 0.2.0](http://www.apache.org/dyn/closer.cgi/incubator/singa/0.2.0/apache-singa-incubating-0.2.0.tar.gz) + * [Apache SINGA 0.2.0](https://archive.apache.org/dist/incubator/singa/0.2.0/apache-singa-incubating-0.2.0.tar.gz) [\[MD5\]](https://archive.apache.org/dist/incubator/singa/0.2.0/apache-singa-incubating-0.2.0.tar.gz.md5) [\[KEYS\]](https://archive.apache.org/dist/incubator/singa/0.2.0/KEYS) * [Release Notes 0.2.0](releases/RELEASE_NOTES_0.2.0.html) @@ -39,7 +58,7 @@ * v0.1.0 (8 October 2015): - * [Apache SINGA 0.1.0](http://www.apache.org/dyn/closer.cgi/incubator/singa/apache-singa-incubating-0.1.0.tar.gz) + * [Apache SINGA 0.1.0](https://archive.apache.org/dist/incubator/singa/apache-singa-incubating-0.1.0.tar.gz) [\[MD5\]](https://archive.apache.org/dist/incubator/singa/apache-singa-incubating-0.1.0.tar.gz.md5) [\[KEYS\]](https://archive.apache.org/dist/incubator/singa/KEYS) * [Amazon EC2 image](https://console.aws.amazon.com/ec2/v2/home?region=ap-southeast-1#LaunchInstanceWizard:ami=ami-b41001e6) http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/bc699f4e/doc/en/index.rst ---------------------------------------------------------------------- diff --git a/doc/en/index.rst b/doc/en/index.rst index bdf5b1d..284b919 100755 --- a/doc/en/index.rst +++ b/doc/en/index.rst @@ -26,19 +26,25 @@ Welcome to Apache Singa Recent News ----------- +* **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. + +* SINGA was presented at `PyDataSG <http://www.meetup.com/PyData-SG/events/229691286/>`_, 16 Aug, 2016. + * The **third release** is now available, 20 April, 2016. `Download SINGA v0.3.0 <downloads.html>`_ * The **second release** is now available, 14 Jan, 2016. `Download SINGA v0.2.0 <downloads.html>`_. * SINGA will be presented at `Strata+Hadoop <http://strataconf.com/big-data-conference-sg-2015/public/schedule/detail/45123>`_ on 2 Dec, 2015 -* SINGA was presented at `ACM Multimedia <http://www.acmmm.org/2015/at-a-glance/>`_ Best Paper session and Open Source Software Competition session, 26-30 Oct, 2015 (`Slides <files/mm2015.ppt>`_) +* SINGA was presented at `ACM Multimedia <http://www.acmmm.org/2015/at-a-glance/>`_ Best Paper session and Open Source Software Competition session, 26-30 Oct, 2015 (`Slides <http://www.comp.nus.edu.sg/~dbsystem/singa//assets/file/mm2015.ppt>`_) * The **first release** is now available, 8 Oct, 2015. `Download SINGA v0.1.0 <downloads.html>`_. * SINGA was presented at `workshop on deep learning <http://www.comp.nus.edu.sg/~dbsystem/singa/workshop>`_ held on 16 Sep, 2015 -* SINGA was presented at `BOSS <http://boss.dima.tu-berlin.de/>`_ of `VLDB 2015 <http://www.vldb.org/2015/>`_ at Hawaii, 4 Sep, 2015. (slides: `overview <files/singa-vldb-boss.pptx>`_, `basic <files/basic-user-guide.pptx>`_, `advanced <files/advanced-user-guide.pptx>`_) +* SINGA was presented at `BOSS <http://boss.dima.tu-berlin.de/>`_ of `VLDB 2015 <http://www.vldb.org/2015/>`_ at Hawaii, 4 Sep, 2015. (slides: `overview <http://www.comp.nus.edu.sg/~dbsystem/singa/assets/file/singa-vldb-boss.pptx>`_, `basic <http://www.comp.nus.edu.sg/~dbsystem/singa/assets/file/basic-user-guide.pptx>`_, `advanced <http://www.comp.nus.edu.sg/~dbsystem/singa/assets/file/advanced-user-guide.pptx>`_) * SINGA was presented at `ADSC/I2R Deep Learning Workshop <http://adsc.illinois.edu/contact-us>`_, 25 Aug, 2015. @@ -72,7 +78,7 @@ How to contribute * If you find any issues using SINGA, please report it to the `Issue Tracker <https://issues.apache.org/jira/browse/singa>`_. -* You can also contact with `SINGA committers <community.html>`_ directly. +* You can also contact with `SINGA committers <community/team-list.html>`_ directly. More details on contributing to SINGA is described `here <develop/how-contribute.html>`_ . http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/bc699f4e/doc/en/releases/RELEASE_NOTES_0.3.0.md ---------------------------------------------------------------------- diff --git a/doc/en/releases/RELEASE_NOTES_0.3.0.md b/doc/en/releases/RELEASE_NOTES_0.3.0.md index c169e12..d863e14 100644 --- a/doc/en/releases/RELEASE_NOTES_0.3.0.md +++ b/doc/en/releases/RELEASE_NOTES_0.3.0.md @@ -13,7 +13,7 @@ This release includes following features: * [SINGA-131] Implement and optimize hybrid training using both CPU and GPU * [SINGA-136] Support cuDNN v4 * [SINGA-134] Extend SINGA to run over a GPU cluster - * [Singa-157] Change the priority of cudnn library and install libsingagpu.so + * [SINGA-157] Change the priority of cudnn library and install libsingagpu.so * Remove Dependences * [SINGA-156] Remove the dependency on ZMQ for single process training @@ -32,6 +32,6 @@ This release includes following features: * [SINGA-150] Mesos Docker container failed * [SIGNA-141] Undesired Hash collision when locating process id to worker⦠* [SINGA-149] Docker build fail - * [Singa-143] The compilation cannot detect libsingagpu.so file + * [SINGA-143] The compilation cannot detect libsingagpu.so file
