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:07 UTC
[singa-doc] 02/07: update the installation page for pip
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 ca744759f15cd6730c627c461443b6c5ceeb1df3
Author: wang wei <wa...@gmail.com>
AuthorDate: Mon Jul 20 17:59:34 2020 +0800
update the installation page for pip
---
docs-site/docs/installation.md | 39 +++++++++++++++++++++++++++++++-
docs-site/docs/wheel.md | 50 ------------------------------------------
2 files changed, 38 insertions(+), 51 deletions(-)
diff --git a/docs-site/docs/installation.md b/docs-site/docs/installation.md
index b7a21cd..48e44d1 100644
--- a/docs-site/docs/installation.md
+++ b/docs-site/docs/installation.md
@@ -5,7 +5,7 @@ title: Installation
<!--- 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 [...]
-## From Conda
+## Using Conda
Conda is a package manager for Python, CPP and other packages.
@@ -56,6 +56,43 @@ $ python -c "from singa import tensor"
then SINGA is installed successfully.
+## Using Pip
+
+1. CPU only
+
+```bash
+pip install singa -f http://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
+`<version>` field should be replaced, e.g., `3.0.0`. The available SINGA
+versions are listed at the link.
+
+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
+
+```bash
+pip install singa -f http://singa.apache.org/docs/next/wheel-cuda.html --trusted-host singa.apache.org
+```
+
+You can also configure SINGA version and the CUDA version, like
+`singa==3.0.0+cuda10.2`. The available combinations of SINGA version and CUDA
+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
+
+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
+the wheel package compiled on Python 3.6 will be selected by pip and installed.
+In fact, the wheel file's name include SINGA version, CUDA version and Python
+version. Therefore, `pip` knows which wheel file to download and install.
+
+Refer to the comments at the top of the `setup.py` file for how to build the
+wheel packages.
+
## Using Docker
Install Docker on your local host machine following the
diff --git a/docs-site/docs/wheel.md b/docs-site/docs/wheel.md
deleted file mode 100644
index 47259e8..0000000
--- a/docs-site/docs/wheel.md
+++ /dev/null
@@ -1,50 +0,0 @@
----
-id: wheel
-title: Wheel
----
-
-<!--- 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 [...]
-
-## Installation Instructions
-
-The wheel package of SINGA is installed via `pip`. Depending on the hardware
-environment, here are two ways to install the wheel package.
-
-- CPU only
-
-```bash
-pip install singa-<version> -f http://singa.apache.org/docs/next/wheel.html
-```
-
-The `<version>` field should be replaced, e.g., `3.0.0.dev1`. The available
-SINGA versions are listed below.
-
-- With CUDA and cuDNN
-
-```bash
-pip install singa-<version>+cuda<cu_version> -f http://singa.apache.org/docs/next/wheel.html
-```
-
-The `<version>` field should be replaced with specific SINGA version; The
-`<cu_version>` field should be replaced with specific CUDA version; For example,
-`singa-3.0.0.dev1+cuda10.2` is the full version specification for one package.
-The available combinations of SINGA version and CUDA version are listed below.
-
-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
-the wheel package compiled on Python 3.6 will be selected by pip and installed.
-In fact, the wheel file's name include SINGA version, CUDA version and Python
-version. Therefore, `pip` knows which wheel file to download and install.
-
-## Building Instructions
-
-Refer to the comments at the top of the `setup.py` file.
-
-## SINGA-3.0.0.dev1
-
-- [CPU only, Python 3.6](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.0.0.dev1-cp36-cp36m-manylinux2014_x86_64.whl)
-- [CPU only, Python 3.7](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.0.0.dev1-cp37-cp37m-manylinux2014_x86_64.whl)
-- [CPU only, Python 3.8](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.0.0.dev1-cp38-cp38-manylinux2014_x86_64.whl)
-- [CUDA10.2, cuDNN 7.6.5, Python 3.6](https://singa-wheel.s3-ap-southeast-1.amazonaws.com/singa-3.0.0.dev1%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.dev1-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.dev1-cp38-cp38-manylinux2014_x86_64.whl)