Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs-site/docs/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ For installing swig

```shell
sudo yum install pcre-devel
wget http://prdownloads.sourceforge.net/swig/swig-3.0.10.tar.gz
wget https://prdownloads.sourceforge.net/swig/swig-3.0.10.tar.gz
tar xvzf swig-3.0.10.tar.gz
cd swig-3.0.10.tar.gz
./configure --prefix=${RUN}
Expand Down Expand Up @@ -519,7 +519,7 @@ $ make package
Python linked by PySINGA via `otool -L <path to _singa_wrap.so>`. To fix this
error, compile SINGA with the correct version of Python. In particular, if you
build PySINGA from source, you need to specify the paths when invoking
[cmake](http://stackoverflow.com/questions/15291500/i-have-2-versions-of-python-installed-but-cmake-is-using-older-version-how-do)
[cmake](https://stackoverflow.com/questions/15291500/i-have-2-versions-of-python-installed-but-cmake-is-using-older-version-how-do)

$ cmake -DPYTHON_LIBRARY=`python-config --prefix`/lib/libpython2.7.dylib -DPYTHON_INCLUDE_DIR=`python-config --prefix`/include/python2.7/ ..

Expand Down
6 changes: 3 additions & 3 deletions docs-site/docs/contribute-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ title: How to Contribute Code
## Coding Style

The SINGA codebase follows the Google Style for both
[CPP](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml) and
[Python](http://google.github.io/styleguide/pyguide.html) code.
[CPP](https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml) and
[Python](https://google.github.io/styleguide/pyguide.html) code.

A simple way to enforce the Google coding styles is to use the linting and
formating tools in the Visual Studio Code editor:
Expand Down Expand Up @@ -56,7 +56,7 @@ different PRs would be identical to get rid of github pull request conflicts.
First, install LLVM 9.0 which provides clang-format version 9.0.0. The download
page of LLVM is:

- [LLVM](http://releases.llvm.org/download.html#9.0.0)
- [LLVM](https://releases.llvm.org/download.html#9.0.0)

- On Ubuntu

Expand Down
2 changes: 1 addition & 1 deletion docs-site/docs/contribute-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ To generate docs, run "doxygen" from the doc folder (Doxygen >= 1.8 recommended)
### Python API

Follow the
[Google Python DocString Style](http://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings).
[Google Python DocString Style](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings).

## Visual Studio Code (vscode)

Expand Down
24 changes: 12 additions & 12 deletions docs-site/docs/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ You can also check the SHA512 or MD5 values to see if the download is completed.

## V3.3.0 (07 June 2022):

- [Apache SINGA 3.3.0](http://www.apache.org/dyn/closer.cgi/singa/3.3.0/apache-singa-3.3.0.tar.gz)
- [Apache SINGA 3.3.0](https://www.apache.org/dyn/closer.cgi/singa/3.3.0/apache-singa-3.3.0.tar.gz)
[\[SHA512\]](https://www.apache.org/dist/singa/3.3.0/apache-singa-3.3.0.tar.gz.sha512)
[\[ASC\]](https://www.apache.org/dist/singa/3.3.0/apache-singa-3.3.0.tar.gz.asc)
- [Release Notes 3.3.0](http://singa.apache.org/docs/releases/RELEASE_NOTES_3.3.0)
- [Release Notes 3.3.0](https://singa.apache.org/docs/releases/RELEASE_NOTES_3.3.0)
- Major changes:
* New examples
- Add one CNN example for the BloodMnist dataset, a sub set of MedMNIST.
Expand Down Expand Up @@ -51,7 +51,7 @@ You can also check the SHA512 or MD5 values to see if the download is completed.
- [Apache SINGA 3.2.0](https://archive.apache.org/dist/singa/3.2.0/apache-singa-3.2.0.tar.gz)
[\[SHA512\]](https://archive.apache.org/dist/singa/3.2.0/apache-singa-3.2.0.tar.gz.sha512)
[\[ASC\]](https://archive.apache.org/dist/singa/3.2.0/apache-singa-3.2.0.tar.gz.asc)
- [Release Notes 3.2.0](http://singa.apache.org/docs/releases/RELEASE_NOTES_3.2.0)
- [Release Notes 3.2.0](https://singa.apache.org/docs/releases/RELEASE_NOTES_3.2.0)
- Major changes:
* New examples
- Add one cifar-10 distributed CNN example for benchmarking the performance
Expand Down Expand Up @@ -81,7 +81,7 @@ You can also check the SHA512 or MD5 values to see if the download is completed.
- [Apache SINGA 3.1.0](https://archive.apache.org/dist/singa/3.1.0/apache-singa-3.1.0.tar.gz)
[\[SHA512\]](https://archive.apache.org/dist/singa/3.1.0/apache-singa-3.1.0.tar.gz.sha512)
[\[ASC\]](https://archive.apache.org/dist/singa/3.1.0/apache-singa-3.1.0.tar.gz.asc)
- [Release Notes 3.1.0](http://singa.apache.org/docs/releases/RELEASE_NOTES_3.1.0)
- [Release Notes 3.1.0](https://singa.apache.org/docs/releases/RELEASE_NOTES_3.1.0)
- Major changes:
- Update Tensor core:
- Support tensor transformation (reshape, transpose) for tensors up to 6
Expand Down Expand Up @@ -111,7 +111,7 @@ You can also check the SHA512 or MD5 values to see if the download is completed.
- [Apache SINGA 3.0.0](https://archive.apache.org/dist/singa/3.0.0/apache-singa-3.0.0.tar.gz)
[\[SHA512\]](https://archive.apache.org/dist/singa/3.0.0/apache-singa-3.0.0.tar.gz.sha512)
[\[ASC\]](https://archive.apache.org/dist/singa/3.0.0/apache-singa-3.0.0.tar.gz.asc)
- [Release Notes 3.0.0](http://singa.apache.org/docs/releases/RELEASE_NOTES_3.0.0)
- [Release Notes 3.0.0](https://singa.apache.org/docs/releases/RELEASE_NOTES_3.0.0)
- New features and major changes,
- Enhanced ONNX. Multiple ONNX models have been tested in SINGA.
- Distributed training with MPI and NCCL Communication optimization through
Expand All @@ -130,7 +130,7 @@ You can also check the SHA512 or MD5 values to see if the download is completed.
- [Apache SINGA 2.0.0 (incubating)](https://archive.apache.org/dist/incubator/singa/2.0.0/apache-singa-incubating-2.0.0.tar.gz)
[\[SHA512\]](https://archive.apache.org/dist/incubator/singa/2.0.0/apache-singa-incubating-2.0.0.tar.gz.sha512)
[\[ASC\]](https://archive.apache.org/dist/incubator/singa/2.0.0/apache-singa-incubating-2.0.0.tar.gz.asc)
- [Release Notes 2.0.0 (incubating)](http://singa.apache.org/docs/releases/RELEASE_NOTES_2.0.0.html)
- [Release Notes 2.0.0 (incubating)](https://singa.apache.org/docs/releases/RELEASE_NOTES_2.0.0.html)
- New features and major updates,
- Enhance autograd (for Convolution networks and recurrent networks)
- Support ONNX
Expand All @@ -144,7 +144,7 @@ You can also check the SHA512 or MD5 values to see if the download is completed.
- [Apache SINGA 1.2.0 (incubating)](https://archive.apache.org/dist/incubator/singa/1.2.0/apache-singa-incubating-1.2.0.tar.gz)
[\[SHA512\]](https://archive.apache.org/dist/incubator/singa/1.2.0/apache-singa-incubating-1.2.0.tar.gz.sha512)
[\[ASC\]](https://archive.apache.org/dist/incubator/singa/1.2.0/apache-singa-incubating-1.2.0.tar.gz.asc)
- [Release Notes 1.2.0 (incubating)](http://singa.apache.org/docs/releases/RELEASE_NOTES_1.2.0.html)
- [Release Notes 1.2.0 (incubating)](https://singa.apache.org/docs/releases/RELEASE_NOTES_1.2.0.html)
- New features and major updates,
- Implement autograd (currently support MLP model)
- Upgrade PySinga to support Python 3
Expand All @@ -162,7 +162,7 @@ You can also check the SHA512 or MD5 values to see if the download is completed.
- [Apache SINGA 1.1.0 (incubating)](https://archive.apache.org/dist/incubator/singa/1.1.0/apache-singa-incubating-1.1.0.tar.gz)
[\[MD5\]](https://archive.apache.org/dist/incubator/singa/1.1.0/apache-singa-incubating-1.1.0.tar.gz.md5)
[\[ASC\]](https://archive.apache.org/dist/incubator/singa/1.1.0/apache-singa-incubating-1.1.0.tar.gz.asc)
- [Release Notes 1.1.0 (incubating)](http://singa.apache.org/docs/releases/RELEASE_NOTES_1.1.0.html)
- [Release Notes 1.1.0 (incubating)](https://singa.apache.org/docs/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)
Expand All @@ -186,7 +186,7 @@ You can also check the SHA512 or MD5 values to see if the download is completed.
- [Apache SINGA 1.0.0 (incubating)](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)
[\[ASC\]](https://archive.apache.org/dist/incubator/singa/1.0.0/apache-singa-incubating-1.0.0.tar.gz.asc)
- [Release Notes 1.0.0 (incubating)](http://singa.apache.org/docs/releases/RELEASE_NOTES_1.0.0.html)
- [Release Notes 1.0.0 (incubating)](https://singa.apache.org/docs/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,
Expand All @@ -206,7 +206,7 @@ You can also check the SHA512 or MD5 values to see if the download is completed.
- [Apache SINGA 0.3.0 (incubating)](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)
[\[ASC\]](https://archive.apache.org/dist/incubator/singa/0.3.0/apache-singa-incubating-0.3.0.tar.gz.asc)
- [Release Notes 0.3.0 (incubating)](http://singa.apache.org/docs/releases/RELEASE_NOTES_0.3.0.html)
- [Release Notes 0.3.0 (incubating)](https://singa.apache.org/docs/releases/RELEASE_NOTES_0.3.0.html)
- New features and major updates,
- Training on GPU cluster enables training of deep learning models over a GPU
cluster.
Expand All @@ -224,7 +224,7 @@ You can also check the SHA512 or MD5 values to see if the download is completed.
- [Apache SINGA 0.2.0 (incubating)](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)
[\[ASC\]](https://archive.apache.org/dist/incubator/singa/0.2.0/apache-singa-incubating-0.2.0.tar.gz.asc)
- [Release Notes 0.2.0 (incubating)](http://singa.apache.org/docs/releases/RELEASE_NOTES_0.2.0.html)
- [Release Notes 0.2.0 (incubating)](https://singa.apache.org/docs/releases/RELEASE_NOTES_0.2.0.html)
- New features and major updates,
- Training on GPU enables training of complex models on a single node with
multiple GPU cards.
Expand Down Expand Up @@ -252,7 +252,7 @@ You can also check the SHA512 or MD5 values to see if the download is completed.
[\[MD5\]](https://archive.apache.org/dist/incubator/singa/apache-singa-incubating-0.1.0.tar.gz.md5)
[\[ASC\]](https://archive.apache.org/dist/incubator/singa/apache-singa-incubating-0.1.0.tar.gz.asc)
- [Amazon EC2 image](https://console.aws.amazon.com/ec2/v2/home?region=ap-southeast-1#LaunchInstanceWizard:ami=ami-b41001e6)
- [Release Notes 0.1.0 (incubating)](http://singa.apache.org/docs/releases/RELEASE_NOTES_0.1.0.html)
- [Release Notes 0.1.0 (incubating)](https://singa.apache.org/docs/releases/RELEASE_NOTES_0.1.0.html)
- Major features include,
- Installation using GNU build utility
- Scripts for job management with zookeeper
Expand Down
14 changes: 7 additions & 7 deletions docs-site/docs/history-singa.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,29 +13,29 @@ cite the following two papers if you use SINGA in your research:

- 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.
[SINGA: A distributed deep learning platform](http://www.comp.nus.edu.sg/~ooibc/singaopen-mm15.pdf).
[SINGA: A distributed deep learning platform](https://www.comp.nus.edu.sg/~ooibc/singaopen-mm15.pdf).
ACM Multimedia (Open Source Software Competition) 2015

- W. Wang, G. Chen, T. T. A. Dinh, B. C. Ooi, K.-L.Tan, J. Gao, and S. Wang.
[SINGA: putting deep learning in the hands of multimedia users](http://www.comp.nus.edu.sg/~ooibc/singa-mm15.pdf).
[SINGA: putting deep learning in the hands of multimedia users](https://www.comp.nus.edu.sg/~ooibc/singa-mm15.pdf).
ACM Multimedia 2015.

Rafiki is a sub module of SINGA. Please cite the following paper if you use
Rafiki in your research:

- Wei Wang, Jinyang Gao, Meihui Zhang, Sheng Wang, Gang Chen, Teck Khim Ng, Beng
Chin Ooi, Jie Shao, Moaz Reyad.
[Rafiki: Machine Learning as an Analytics Service System](http://www.vldb.org/pvldb/vol12/p128-wang.pdf).
[VLDB 2019](http://vldb.org/2019/)
[Rafiki: Machine Learning as an Analytics Service System](https://www.vldb.org/pvldb/vol12/p128-wang.pdf).
[VLDB 2019](https://vldb.org/2019/)
([BibTex](https://dblp.org/rec/bib2/journals/pvldb/WangWGZCNOS18.bib)).

Companies like [NetEase](http://tech.163.com/17/0602/17/CLUL016I00098GJ5.html),
[yzBigData](http://www.yzbigdata.com/en/index.html),
Companies like [NetEase](https://tech.163.com/17/0602/17/CLUL016I00098GJ5.html),
[yzBigData](https://www.yzbigdata.com/en/index.html),
[Shentilium](https://shentilium.com/), [Foodlg](http://www.foodlg.com/) and
[Medilot](https://medilot.com/technologies) are using SINGA for their
applications.

## License

SINGA is released under
[Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
[Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
18 changes: 9 additions & 9 deletions docs-site/docs/how-to-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: How to Prepare a Release
<!--- 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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->

This is a guide for the
[release preparing process](http://www.apache.org/dev/release-publishing.html)
[release preparing process](https://www.apache.org/dev/release-publishing.html)
in SINGA.

1. Select a release manager. The release manager (RM) is the coordinator for the
Expand All @@ -15,7 +15,7 @@ in SINGA.
public key server. The RM needs to get his key endorsed (signed) by other
Apache user, to be connected to the web of trust. He should first ask the
mentor to help signing his key.
[How to generate the key](http://www.apache.org/dev/release-signing.html)?
[How to generate the key](https://www.apache.org/dev/release-signing.html)?

2. Check license. [FAQ](https://www.apache.org/legal/src-headers.html#faq-docs);
[SINGA Issue](https://issues.apache.org/jira/projects/SINGA/issues/SINGA-447)
Expand All @@ -25,7 +25,7 @@ in SINGA.
- The dependencies are compatible with APL. GNU-like licenses are NOT
compatible;
- All source files written by us MUST include the Apache license header:
http://www.apache.org/legal/src-headers.html. There's a script in there
https://www.apache.org/legal/src-headers.html. There's a script in there
which helps propagating the header to all files.
- Update the LICENSE file. If we include any third party code in the release
package which is not APL, must state it at the end of the NOTICE file.
Expand All @@ -40,7 +40,7 @@ in SINGA.
4. Prepare the RELEASE_NOTES file. Include the following items, Introduction,
Features, Bugs (link to JIRA or Github PR), Changes, Dependency list,
Incompatibility issues. Follow this
[example](http://commons.apache.org/proper/commons-digester/commons-digester-3.0/RELEASE-NOTES.txt).
[example](https://commons.apache.org/proper/commons-digester/commons-digester-3.0/RELEASE-NOTES.txt).

5. Package the release candidate. The release should be packaged into :
apache-singa-VERSION.tar.gz. The release should not include any binary files
Expand Down Expand Up @@ -68,7 +68,7 @@ in SINGA.
[stage repo](https://dist.apache.org/repos/dist/dev/singa/). The tar file,
signature, KEY and SHA256 checksum file should be included. MD5 is no longer
used. Policy is
[here](http://www.apache.org/dev/release-distribution#sigs-and-sums). The
[here](https://www.apache.org/dev/release-distribution#sigs-and-sums). The
stage folder should include:

- apache-singa-VERSION.tar.gz
Expand Down Expand Up @@ -130,7 +130,7 @@ in SINGA.
https://github.com/apache/singa/releases/tag/3.1.0.rc2

The documentation website is at
http://singa.apache.org/docs/next/installation/
https://singa.apache.org/docs/next/installation/

Some examples are available for testing:
https://github.com/apache/singa/tree/master/examples
Expand Down Expand Up @@ -172,13 +172,13 @@ passed.
````

8) Upload the package for
[distribution](http://www.apache.org/dev/release-publishing.html#distribution)
[distribution](https://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
[here](https://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
Expand All @@ -198,7 +198,7 @@ the downloads."

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 release is available at: https://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.
Expand Down
8 changes: 4 additions & 4 deletions docs-site/docs/install-win.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ The dependencies are:
- Visual Studio. The community edition is free and can be used to build SINGA.
https://www.visualstudio.com/
- CMake
- Can be downloaded from http://cmake.org/
- Can be downloaded from https://cmake.org/
- Make sure the path to cmake executable is in the system path, or use full
path when calling cmake.
- SWIG

- Can be downloaded from http://swig.org/
- Can be downloaded from https://swig.org/
- Make sure the path to swig executable is in the system path, or use full
path when calling swig. Use a recent version such as 3.0.12.

Expand All @@ -40,10 +40,10 @@ The dependencies are:
- Openblas

- Download a suitable source version such as 0.2.20 from
http://www.openblas.net
https://www.openblas.net
- Extract the source in the dependencies folder.
- If you don't have Perl installed, download a perl environment such as
Strawberry Perl (http://strawberryperl.com/)
Strawberry Perl (https://strawberryperl.com/)
- Build the Visual Studio solution by running this command in the source
folder:

Expand Down
4 changes: 2 additions & 2 deletions docs-site/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ SINGA.
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](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
pip install singa -f https://singa.apache.org/docs/next/wheel-cpu.html --trusted-host singa.apache.org
```

You can install a specific version of SINGA via `singa==<version>`, where the
Expand All @@ -28,7 +28,7 @@ versions are listed at the link.
[![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-gpu.html --trusted-host singa.apache.org
pip install singa -f https://singa.apache.org/docs/next/wheel-gpu.html --trusted-host singa.apache.org
```

You can also configure SINGA version and the CUDA version, like
Expand Down
Loading