You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@singa.apache.org by wa...@apache.org on 2020/10/21 02:28:28 UTC

[singa-doc] branch master updated (108f126 -> 0a2fc3f)

This is an automated email from the ASF dual-hosted git repository.

wangwei pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/singa-doc.git.


    from 108f126  Merge pull request #32 from pinpom/doc
     new 855b4b0  update instructions for installation and PMC list
     new 0a2fc3f  fix conflict

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 docs-site/docs/how-to-release.md | 129 +++++++++++++++++++++++----------------
 docs-site/docs/install-win.md    |   2 +
 docs-site/docs/installation.md   |   9 +--
 docs-site/docs/software-stack.md |  15 ++---
 docs-site/docs/team-list.md      |   2 +-
 docs-site/docs/wheel-cpu.md      |   8 +--
 docs-site/docs/wheel-gpu.md      |   8 +--
 7 files changed, 101 insertions(+), 72 deletions(-)


[singa-doc] 02/02: fix conflict

Posted by wa...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

wangwei pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/singa-doc.git

commit 0a2fc3f353accfed81f616a2b133679bea17f5de
Merge: 855b4b0 108f126
Author: wang wei <wa...@gmail.com>
AuthorDate: Wed Oct 21 10:28:01 2020 +0800

    fix conflict

 docs-site/docs/autograd.md        |  2 +-
 docs-site/docs/benchmark-train.md |  4 ++--
 docs-site/docs/build.md           |  2 +-
 docs-site/docs/graph.md           |  4 ++--
 docs-site/docs/install-win.md     | 28 ++++++++++++++--------------
 docs-site/docs/installation.md    |  2 +-
 docs-site/docs/software-stack.md  | 21 +++++++++++----------
 7 files changed, 32 insertions(+), 31 deletions(-)

diff --cc docs-site/docs/software-stack.md
index 05d8208,97c215b..f83453a
--- a/docs-site/docs/software-stack.md
+++ b/docs-site/docs/software-stack.md
@@@ -7,12 -7,12 +7,12 @@@ title: Software Stac
  
  SINGA's software stack includes two major levels, the low level backend classes
  and the Python interface level. Figure 1 illustrates them together with the
- hardware. The backend components provides basic data structures for deep
 -hardware. The backend components provide basic data structures for deep
--learning models, hardware abstractions for scheduling and executing operations,
--and communication components for distributed training. The Python interface
--wraps some CPP data structures and provides additional high-level classes for
--neural network training, which makes it convenient to implement complex neural
--network models.
++hardware. The backend components provide basic data structures for deep learning
++models, hardware abstractions for scheduling and executing operations, and
++communication components for distributed training. The Python interface wraps
++some CPP data structures and provides additional high-level classes for neural
++network training, which makes it convenient to implement complex neural network
++models.
  
  Next, we introduce the software stack in a bottom-up manner.
  
@@@ -72,7 -72,7 +72,8 @@@ The neural network specific operators a
  Typically, users create a `Device` instance and use it to create multiple
  `Tensor` instances. When users call the Tensor functions or neural network
  operations, the corresponding implementation for the resident device will be
- invoked In other words, the implementation of operators is transparent to users.
 -invoked. In other words, the implementation of operators is transparent to users.
++invoked. In other words, the implementation of operators is transparent to
++users.
  
  The Tensor and Device abstractions are extensible to support a wide range of
  hardware device using different programming languages. A new hardware device


[singa-doc] 01/02: update instructions for installation and PMC list

Posted by wa...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

wangwei pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/singa-doc.git

commit 855b4b0f3b472f9cef90d9fcba88d368f401fc1c
Author: wang wei <wa...@gmail.com>
AuthorDate: Wed Oct 21 10:26:17 2020 +0800

    update instructions for installation and PMC list
---
 docs-site/docs/how-to-release.md | 129 +++++++++++++++++++++++----------------
 docs-site/docs/installation.md   |  11 ++--
 docs-site/docs/team-list.md      |   2 +-
 docs-site/docs/wheel-cpu.md      |   8 +--
 docs-site/docs/wheel-gpu.md      |   8 +--
 5 files changed, 92 insertions(+), 66 deletions(-)

diff --git a/docs-site/docs/how-to-release.md b/docs-site/docs/how-to-release.md
index 9e99054..43b2341 100644
--- a/docs-site/docs/how-to-release.md
+++ b/docs-site/docs/how-to-release.md
@@ -96,11 +96,12 @@ in SINGA.
    cd VERSION
    sha512sum apache-singa-VERSION.tar.gz > apache-singa-VERSION.tar.gz.sha512
    gpg --armor --output apache-singa-VERSION.tar.gz.asc --detach-sig apache-singa-VERSION.tar.gz
+   cd ..
    svn add VERSION
-   svn update
+   svn commit
    ```
 
-6) Call for vote by sending an email
+6) Call for vote by sending an email. An example is provided as follows.
 
    ```
    To: dev@singa.apache.org
@@ -108,76 +109,100 @@ in SINGA.
 
    Hi all,
 
-   I have created a build for Apache SINGA X.Y.Z, release candidate N.
-   The artifacts to be voted on are located here:  xxxx
-   The hashes of the artifacts are as follows: xxx
-   Release artifacts are signed with the following key: xxx
-   Please vote on releasing this package. The vote is open for at least
-   72 hours and passes if a majority of at least three +1 votes are cast.
+   I have created a build for Apache SINGA 3.1.0, release candidate 2.
+
+   The release note is at
+   https://github.com/apache/singa/blob/master/RELEASE_NOTES.
+
+   The artifacts to be voted on are located here:
+   https://dist.apache.org/repos/dist/dev/singa/3.1.0.rc2/apache-singa-3.1.0.rc2.tar.gz
+    
+   The hashes of the artifacts are as follows:
+   SHA512: 84545499ad36da108c6a599edd1d853f82d331bc03273b5278515554866f0c698e881f956b2eabcb6b29c07fa9fa4ff1add5a777b58db8a6a2362cf383b5c04d 
+
+   Release artifacts are signed with the followingkey:
+   https://dist.apache.org/repos/dist/dev/singa/KEYS
 
-   [ ] +1 Release this package as Apache SINGA X.Y.Z
-   [ ] 0 I don't feel strongly about it, but I'm okay with the release
-   [ ] -1 Do not release this package because...
+   The signature file is:
+   https://dist.apache.org/repos/dist/dev/singa/3.1.0.rc2/apache-singa-3.1.0.rc2.tar.gz.asc
 
-   Here is my vote:
-   +1
+   The Github tag is at:
+   https://github.com/apache/singa/releases/tag/3.1.0.rc2
+
+   The documentation website is at
+   http://singa.apache.org/docs/next/installation/
+
+   Some examples are available for testing:
+   https://github.com/apache/singa/tree/master/examples
    ```
 
+Please vote on releasing this package. The vote is open for at least 72 hours
+and passes if a majority of at least three +1 votes are cast.
+
+[ ] +1 Release this package as Apache SINGA X.Y.Z [ ] 0 I don't feel strongly
+about it, but I'm okay with the release [ ] -1 Do not release this package
+because...
+
+Here is my vote: +1
+
+```
+
 7) Wait at least 48 hours for test responses. Any PMC, committer or contributor
-   can test features for releasing, and feedback. Everyone should check these
-   before vote +1. If the vote passes, then send the result email. Otherwise,
-   repeat from the beginning.
+can test features for releasing, and feedback. Everyone should check these
+before vote +1. If the vote passes, then send the result email. Otherwise,
+repeat from the beginning.
 
-   ```
-   To: dev@singa.apache.org
-   Subject: [RESULT] [VOTE] Release apache-singa-X.Y.Z (release candidate N)
+```
 
-   Thanks to everyone who has voted and given their comments.
-   The tally is as follows.
+To: dev@singa.apache.org Subject: [RESULT][vote] Release apache-singa-X.Y.Z
+(release candidate N)
 
-   N binding +1s:
-   <names>
+Thanks to everyone who has voted and given their comments. The tally is as
+follows.
 
-   N non-binding +1s:
-   <names>
+N binding +1s: <names>
 
-   No 0s or -1s.
+N non-binding +1s: <names>
 
-   I am delighted to announce that the proposal to release
-   Apache SINGA X.Y.Z has passed.
-   ```
+No 0s or -1s.
+
+I am delighted to announce that the proposal to release Apache SINGA X.Y.Z has
+passed.
+
+````
 
 8) Upload the package for
-   [distribution](http://www.apache.org/dev/release-publishing.html#distribution)
-   to https://dist.apache.org/repos/dist/release/singa/.
+[distribution](http://www.apache.org/dev/release-publishing.html#distribution)
+to https://dist.apache.org/repos/dist/release/singa/.
 
 9) Update the Download page of SINGA website. The tar.gz file MUST be downloaded
-   from mirror, using closer.cgi script; other artifacts MUST be downloaded from
-   main Apache site. More details
-   [here](http://www.apache.org/dev/release-download-pages.html). Some feedback
-   we got during the previous releases: "Download pages must only link to formal
-   releases, so must not include links to GitHub.", "Links to KEYS, sigs and
-   hashes must not use dist.apache.org; instead use
-   https://www.apache.org/dist/singa/...;", "Also you only need one KEYS link,
-   and there should be a description of how to use KEYS + sig or hash to verify
-   the downloads."
+from mirror, using closer.cgi script; other artifacts MUST be downloaded from
+main Apache site. More details
+[here](http://www.apache.org/dev/release-download-pages.html). Some feedback
+we got during the previous releases: "Download pages must only link to formal
+releases, so must not include links to GitHub.", "Links to KEYS, sigs and
+hashes must not use dist.apache.org; instead use
+https://www.apache.org/dist/singa/...;", "Also you only need one KEYS link,
+and there should be a description of how to use KEYS + sig or hash to verify
+the downloads."
 
 10) Remove the RC tag and compile the conda packages.
 
 11) Publish the release information.
 
-    ```
-    To: announce@apache.org, dev@singa.apache.org
-    Subject: [ANNOUNCE] Apache SINGA X.Y.Z released
+ ```
+ To: announce@apache.org, dev@singa.apache.org
+ Subject: [ANNOUNCE] Apache SINGA X.Y.Z released
 
-    We are pleased to announce that SINGA X.Y.Z is released.
+ We are pleased to announce that SINGA X.Y.Z is released.
 
-    SINGA is a general distributed deep learning platform
-    for training big deep learning models over large datasets.
-    The release is available at: http://singa.apache.org/downloads.html
-    The main features of this release include XXX
-    We look forward to hearing your feedback, suggestions,
-    and contributions to the project.
+ SINGA is a general distributed deep learning platform
+ for training big deep learning models over large datasets.
+ The release is available at: http://singa.apache.org/downloads.html
+ The main features of this release include XXX
+ We look forward to hearing your feedback, suggestions,
+ and contributions to the project.
 
-    On behalf of the SINGA team, {SINGA Team Member Name}
-    ```
+ On behalf of the SINGA team, {SINGA Team Member Name}
+ ```
+````
diff --git a/docs-site/docs/installation.md b/docs-site/docs/installation.md
index 72b7d3f..307be00 100644
--- a/docs-site/docs/installation.md
+++ b/docs-site/docs/installation.md
@@ -36,8 +36,9 @@ $ conda search -c nusdbsystem singa
 
 Loading channels: done
 # Name                       Version           Build  Channel
-singa                      2.1.0.dev        cpu_py36  nusdbsystem
-singa                      2.1.0.dev        cpu_py37  nusdbsystem
+singa                      3.1.0.rc2        cpu_py36  nusdbsystem
+singa                      3.1.0.rc2 cudnn7.6.5_cuda10.2_py36  nusdbsystem
+singa                      3.1.0.rc2 cudnn7.6.5_cuda10.2_py37  nusdbsystem
 ```
 
 <!--- > Please note that using the nightly built images is not recommended except for SINGA development and testing. Using stable releases is recommended. -->
@@ -45,7 +46,7 @@ singa                      2.1.0.dev        cpu_py37  nusdbsystem
 The following command installs a specific version of SINGA,
 
 ```shell
-$ conda install -c nusdbsystem -c conda-forge singa=X.Y.Z.dev=cpu_py37
+$ conda install -c nusdbsystem -c conda-forge singa=X.Y.Z=cpu_py36
 ```
 
 If there is no error message from
@@ -76,7 +77,7 @@ http://singa.apache.org/docs/next/wheel-cpu-dev.html
    [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1W30IPCqj5fG8ADAQsFqclaCLyIclVcJL?usp=sharing)
 
 ```bash
-pip install singa -f http://singa.apache.org/docs/next/wheel-cuda.html --trusted-host singa.apache.org
+pip install singa -f http://singa.apache.org/docs/next/wheel-gpu.html --trusted-host singa.apache.org
 ```
 
 You can also configure SINGA version and the CUDA version, like
@@ -84,7 +85,7 @@ You can also configure SINGA version and the CUDA version, like
 version are listed at the link.
 
 To install the latest develop version, replace the link with
-http://singa.apache.org/docs/next/wheel-cuda-dev.html
+http://singa.apache.org/docs/next/wheel-gpu-dev.html
 
 Note: the Python version of your local Python environment will be used to find
 the corresponding wheel package. For example, if your local Python is 3.6, then
diff --git a/docs-site/docs/team-list.md b/docs-site/docs/team-list.md
index 41bd786..333686e 100644
--- a/docs-site/docs/team-list.md
+++ b/docs-site/docs/team-list.md
@@ -26,6 +26,7 @@ Zhejiang University, NetEase, Osaka University, yzBigData, etc.
 | Beng Chin Ooi | ooibc@apache.org        | National University of Singapore              |
 | Moaz Reyad    | moaz@apache.org         | Université Grenoble Alpes                     |
 | Kian-Lee Tan  | tankianlee@apache.org   | National University of Singapore              |
+| Sheng Wang    | wangsh@apache.org       | DAMO Academy, Alibaba Group                   |
 | Wei Wang      | wangwei@apache.org      | National University of Singapore              |
 | Zhongle Xie   | zhongle@apache.org      | National University of Singapore              |
 | Sai Ho Yeung  | chrishkchris@apache.org | National University of Singapore              |
@@ -39,7 +40,6 @@ Zhejiang University, NetEase, Osaka University, yzBigData, etc.
 | Xiangrui Cai | caixr@apache.org       | Nankai University                             |
 | Chonho Lee   | chonho@apache.org      | Osaka University                              |
 | Shicong Lin  | shicong@apache.org     | National University of Singapore              |
-| Sheng Wang   | wangsh@apache.org      | DAMO Academy, Alibaba Group                   |
 | Rulin Xing   | rulin@apache.org       | Huazhong University of Science and Technology |
 | Wanqi Xue    | xuewanqi@apache.org    | Nanyang Technological University              |
 | Joddiy Zhang | joddiyzhang@apache.org | National University of Singapore              |
diff --git a/docs-site/docs/wheel-cpu.md b/docs-site/docs/wheel-cpu.md
index 4f0b921..430d9d1 100644
--- a/docs-site/docs/wheel-cpu.md
+++ b/docs-site/docs/wheel-cpu.md
@@ -5,11 +5,11 @@ title: CPU only Wheel Packages
 
 <!--- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agree [...]
 
-## 3.1.0.RC1
+## 3.1.0
 
-- [Python 3.6](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.1.0rc1-cp36-cp36m-manylinux2014_x86_64.whl)
-- [Python 3.7](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.1.0rc1-cp37-cp37m-manylinux2014_x86_64.whl)
-- [Python 3.8](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.1.0rc1-cp38-cp38-manylinux2014_x86_64.whl)
+- [Python 3.6](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.1.0-cp36-cp36m-manylinux2014_x86_64.whl)
+- [Python 3.7](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.1.0-cp37-cp37m-manylinux2014_x86_64.whl)
+- [Python 3.8](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.1.0-cp38-cp38-manylinux2014_x86_64.whl)
 
 ## 3.0.0
 
diff --git a/docs-site/docs/wheel-gpu.md b/docs-site/docs/wheel-gpu.md
index c64e4f8..2c0a1a9 100644
--- a/docs-site/docs/wheel-gpu.md
+++ b/docs-site/docs/wheel-gpu.md
@@ -5,14 +5,14 @@ title: Wheel Packages with CUDA Enabled
 
 <!--- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agree [...]
 
-## 3.1.0.RC1
+## 3.1.0
 
 - [CUDA10.2, cuDNN 7.6.5, Python
-  3.6]https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.1.0rc1%2Bcuda10.2-cp36-cp36m-manylinux2014_x86_64.whl)
+  3.6]https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.1.0%2Bcuda10.2-cp36-cp36m-manylinux2014_x86_64.whl)
 - [CUDA10.2, cuDNN 7.6.5, Python
-  3.7]https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.1.0rc1%2Bcuda10.2-cp37-cp37m-manylinux2014_x86_64.whl)
+  3.7]https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.1.0%2Bcuda10.2-cp37-cp37m-manylinux2014_x86_64.whl)
 - [CUDA10.2, cuDNN 7.6.5, Python
-  3.8]https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.1.0rc1%2Bcuda10.2-cp38-cp38-manylinux2014_x86_64.whl)
+  3.8]https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.1.0%2Bcuda10.2-cp38-cp38-manylinux2014_x86_64.whl)
 
 ## 3.0.0