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/09/28 09:34:09 UTC
[singa-doc] 04/07: update the docs for v3.1.0.rc1
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 96bb9ef89722842a2882af52cfd1d8d173a8cdb0
Author: wang wei <wa...@gmail.com>
AuthorDate: Thu Sep 24 10:39:27 2020 +0800
update the docs for v3.1.0.rc1
---
docs-site/docs/assets/singav3.1-sw.png | Bin 0 -> 20083 bytes
docs-site/docs/graph.md | 9 +++++++++
docs-site/docs/installation.md | 6 ++++--
docs-site/docs/software-stack.md | 20 +++++++++-----------
docs-site/docs/wheel-cpu-dev.md | 12 ++++++++++++
docs-site/docs/wheel-cpu.md | 18 ++++++++++++++++++
docs-site/docs/wheel-gpu-dev.md | 12 ++++++++++++
docs-site/docs/wheel-gpu.md | 21 +++++++++++++++++++++
docs-site/website/pages/en/index.js | 2 +-
docs-site/website/static/img/singav3.1-sw.png | Bin 0 -> 20083 bytes
10 files changed, 86 insertions(+), 14 deletions(-)
diff --git a/docs-site/docs/assets/singav3.1-sw.png b/docs-site/docs/assets/singav3.1-sw.png
new file mode 100644
index 0000000..2bfd2c0
Binary files /dev/null and b/docs-site/docs/assets/singav3.1-sw.png differ
diff --git a/docs-site/docs/graph.md b/docs-site/docs/graph.md
index e1e0334..a37d0e8 100644
--- a/docs-site/docs/graph.md
+++ b/docs-site/docs/graph.md
@@ -16,6 +16,15 @@ need to define the neural network model using the
[Model](https://github.com/apache/singa/blob/master/python/singa/model.py) API.
The graph is constructed and optimized at the C++ backend automatically.
+In this way, on the one hand, users implement a network using the
+[Model](./graph) API following the imperative programming style like PyTorch.
+Different to PyTorch which recreates the operations in every iteration, SINGA
+buffers the operations to create a computational graph implicitly (when this
+feature is enabled) after the first iteration. Therefore, on the other hand,
+SINGA has a similar computational graph as the one created by libraries using
+declarative programming, e.g., TensorFlow. Consequently, it can enjoy the
+optimizations done over the graph.
+
## Example
The following code illustrates the usage of the `Model` API.
diff --git a/docs-site/docs/installation.md b/docs-site/docs/installation.md
index 64af47e..72b7d3f 100644
--- a/docs-site/docs/installation.md
+++ b/docs-site/docs/installation.md
@@ -15,14 +15,14 @@ After installing miniconda, execute the one of the following commands to install
SINGA.
1. CPU only
- [](https://colab.research.google.com/drive/1Ntkhi-Z6XTR8WYPXiLwujHd2dOm0772V)
+ [](https://colab.research.google.com/drive/1Ntkhi-Z6XTR8WYPXiLwujHd2dOm0772V?usp=sharing)
```shell
$ conda install -c nusdbsystem -c conda-forge singa-cpu
```
2. GPU with CUDA and cuDNN (CUDA driver >=384.81 is required)
- [](https://colab.research.google.com/drive/1do_TLJe18IthLOnBOsHCEe-FFPGk1sPJ)
+ [](https://colab.research.google.com/drive/1do_TLJe18IthLOnBOsHCEe-FFPGk1sPJ?usp=sharing)
```shell
$ conda install -c nusdbsystem -c conda-forge singa-gpu
@@ -59,6 +59,7 @@ then SINGA is installed successfully.
## Using Pip
1. CPU only
+ [](https://colab.research.google.com/drive/17RA056Brwk0vBQTFaZ-l9EbqwADO0NA9?usp=sharing)
```bash
pip install singa -f http://singa.apache.org/docs/next/wheel-cpu.html --trusted-host singa.apache.org
@@ -72,6 +73,7 @@ To install the latest develop version, replace the link with
http://singa.apache.org/docs/next/wheel-cpu-dev.html
2. GPU With CUDA and cuDNN
+ [](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
diff --git a/docs-site/docs/software-stack.md b/docs-site/docs/software-stack.md
index 620ed61..05d8208 100644
--- a/docs-site/docs/software-stack.md
+++ b/docs-site/docs/software-stack.md
@@ -14,19 +14,9 @@ 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.
-SINGA's programming model enjoys the advantages of imperative programming and
-declarative programming. Users define the network structure and the training
-procedure (data flow) via imperative programming like PyTorch.
-Different to PyTorch which recreates the operations in every iteration, SINGA
-buffers the operations to create a computational graph implicitly (when this
-feature is enabled) after the first iteration. The graph is similar to that
-created by libraries using declarative programming, e.g., TensorFlow. Therefore,
-SINGA can apply the memory and speed optimization techniques over the
-computational graph.
-
Next, we introduce the software stack in a bottom-up manner.
- <br/> **Figure 1 - SINGA V3
+ <br/> **Figure 1 - SINGA V3
software stack.**
## Low-level Backend
@@ -144,6 +134,14 @@ efficiency and memory optimization.
just need to inherit `Model` and define the forward propagation of the model by
creating and calling the layers or operators. `Model` will do autograd and
update the parameters via `Opt` automatically when training data is fed into it.
+With the `Model` API, SINGA enjoys the advantages of imperative programming and
+declarative programming. Users implement a network using the [Model](./graph)
+API following the imperative programming style like PyTorch. Different to
+PyTorch which recreates the operations in every iteration, SINGA buffers the
+operations to create a computational graph implicitly (when this feature is
+enabled) after the first iteration. The graph is similar to that created by
+libraries using declarative programming, e.g., TensorFlow. Therefore, SINGA can
+apply the memory and speed optimization techniques over the computational graph.
### ONNX
diff --git a/docs-site/docs/wheel-cpu-dev.md b/docs-site/docs/wheel-cpu-dev.md
new file mode 100644
index 0000000..9f8f7af
--- /dev/null
+++ b/docs-site/docs/wheel-cpu-dev.md
@@ -0,0 +1,12 @@
+---
+id: wheel-cpu-dev
+title: CPU only Wheel Packages (develop version)
+---
+
+<!--- 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.0.0.dev200720
+
+- [Python 3.6](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.0.0.dev200720-cp36-cp36m-manylinux2014_x86_64.whl)
+- [Python 3.7](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.0.0.dev200720-cp37-cp37m-manylinux2014_x86_64.whl)
+- [Python 3.8](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.0.0.dev200720-cp38-cp38-manylinux2014_x86_64.whl)
diff --git a/docs-site/docs/wheel-cpu.md b/docs-site/docs/wheel-cpu.md
new file mode 100644
index 0000000..4f0b921
--- /dev/null
+++ b/docs-site/docs/wheel-cpu.md
@@ -0,0 +1,18 @@
+---
+id: wheel-cpu
+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
+
+- [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)
+
+## 3.0.0
+
+- [Python 3.6](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.0.0-cp36-cp36m-manylinux2014_x86_64.whl)
+- [Python 3.7](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.0.0-cp37-cp37m-manylinux2014_x86_64.whl)
+- [Python 3.8](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.0.0-cp38-cp38-manylinux2014_x86_64.whl)
diff --git a/docs-site/docs/wheel-gpu-dev.md b/docs-site/docs/wheel-gpu-dev.md
new file mode 100644
index 0000000..3c061e9
--- /dev/null
+++ b/docs-site/docs/wheel-gpu-dev.md
@@ -0,0 +1,12 @@
+---
+id: wheel-gpu-dev
+title: Wheel Packages with CUDA enabled (develop version)
+---
+
+<!--- 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.0.0.dev200720
+
+- [CUDA10.2, cuDNN 7.6.5, Python 3.6](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.0.0.dev200720%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.0.0.dev200720%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.0.0.dev200720%2Bcuda10.2-cp38-cp38-manylinux2014_x86_64.whl)
diff --git a/docs-site/docs/wheel-gpu.md b/docs-site/docs/wheel-gpu.md
new file mode 100644
index 0000000..c64e4f8
--- /dev/null
+++ b/docs-site/docs/wheel-gpu.md
@@ -0,0 +1,21 @@
+---
+id: wheel-gpu
+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
+
+- [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)
+- [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)
+- [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.0.0
+
+- [CUDA10.2, cuDNN 7.6.5, Python 3.6](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.0.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.0.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.0.0%2Bcuda10.2-cp38-cp38-manylinux2014_x86_64.whl)
diff --git a/docs-site/website/pages/en/index.js b/docs-site/website/pages/en/index.js
index b26dfef..7aad38e 100644
--- a/docs-site/website/pages/en/index.js
+++ b/docs-site/website/pages/en/index.js
@@ -143,7 +143,7 @@ class Index extends React.Component {
{
content: `SINGA has a simple [software stack and Python interface](./docs/software-stack) to improve usability.`,
imageAlign: "left",
- image: `${siteConfig.baseUrl}img/singav3-sw.png`,
+ image: `${siteConfig.baseUrl}img/singav3.1-sw.png`,
imageAlt: "Usability",
title: "Usability",
},
diff --git a/docs-site/website/static/img/singav3.1-sw.png b/docs-site/website/static/img/singav3.1-sw.png
new file mode 100644
index 0000000..2bfd2c0
Binary files /dev/null and b/docs-site/website/static/img/singav3.1-sw.png differ