From 60aeea1f76d594e5420357a521c4ca54cab78535 Mon Sep 17 00:00:00 2001 From: Sheng Zha Date: Mon, 25 Feb 2019 22:52:52 -0800 Subject: [PATCH] pypi package description. manifest/setup.py update --- tools/pip/MANIFEST.in | 3 ++ tools/pip/doc/CPU_ADDITIONAL.md | 40 +++++++++++++++++++++++++ tools/pip/doc/CU100MKL_ADDITIONAL.md | 44 ++++++++++++++++++++++++++++ tools/pip/doc/CU100_ADDITIONAL.md | 44 ++++++++++++++++++++++++++++ tools/pip/doc/CU75MKL_ADDITIONAL.md | 42 ++++++++++++++++++++++++++ tools/pip/doc/CU75_ADDITIONAL.md | 42 ++++++++++++++++++++++++++ tools/pip/doc/CU80MKL_ADDITIONAL.md | 42 ++++++++++++++++++++++++++ tools/pip/doc/CU80_ADDITIONAL.md | 42 ++++++++++++++++++++++++++ tools/pip/doc/CU90MKL_ADDITIONAL.md | 42 ++++++++++++++++++++++++++ tools/pip/doc/CU90_ADDITIONAL.md | 42 ++++++++++++++++++++++++++ tools/pip/doc/CU91MKL_ADDITIONAL.md | 42 ++++++++++++++++++++++++++ tools/pip/doc/CU91_ADDITIONAL.md | 42 ++++++++++++++++++++++++++ tools/pip/doc/CU92MKL_ADDITIONAL.md | 42 ++++++++++++++++++++++++++ tools/pip/doc/CU92_ADDITIONAL.md | 42 ++++++++++++++++++++++++++ tools/pip/doc/MKL_ADDITIONAL.md | 40 +++++++++++++++++++++++++ tools/pip/doc/PYPI_README.md | 25 ++++++++++++++++ tools/pip/setup.py | 17 ++++++++++- 17 files changed, 632 insertions(+), 1 deletion(-) create mode 100644 tools/pip/doc/CPU_ADDITIONAL.md create mode 100644 tools/pip/doc/CU100MKL_ADDITIONAL.md create mode 100644 tools/pip/doc/CU100_ADDITIONAL.md create mode 100644 tools/pip/doc/CU75MKL_ADDITIONAL.md create mode 100644 tools/pip/doc/CU75_ADDITIONAL.md create mode 100644 tools/pip/doc/CU80MKL_ADDITIONAL.md create mode 100644 tools/pip/doc/CU80_ADDITIONAL.md create mode 100644 tools/pip/doc/CU90MKL_ADDITIONAL.md create mode 100644 tools/pip/doc/CU90_ADDITIONAL.md create mode 100644 tools/pip/doc/CU91MKL_ADDITIONAL.md create mode 100644 tools/pip/doc/CU91_ADDITIONAL.md create mode 100644 tools/pip/doc/CU92MKL_ADDITIONAL.md create mode 100644 tools/pip/doc/CU92_ADDITIONAL.md create mode 100644 tools/pip/doc/MKL_ADDITIONAL.md create mode 100644 tools/pip/doc/PYPI_README.md diff --git a/tools/pip/MANIFEST.in b/tools/pip/MANIFEST.in index 8037b6a1059c..1edefa026ebc 100644 --- a/tools/pip/MANIFEST.in +++ b/tools/pip/MANIFEST.in @@ -16,6 +16,9 @@ # under the License. include README +include LICENSE +include DISCLAIMER +include NOTICE include mxnet/COMMIT_HASH recursive-include mxnet/tools * recursive-include mxnet *.py diff --git a/tools/pip/doc/CPU_ADDITIONAL.md b/tools/pip/doc/CPU_ADDITIONAL.md new file mode 100644 index 000000000000..05be9e52bd06 --- /dev/null +++ b/tools/pip/doc/CPU_ADDITIONAL.md @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + + + +Prerequisites +------------- +This package supports Linux, Mac OSX, and Windows platforms. You may also want to check: +- [mxnet-cu92](https://pypi.python.org/pypi/mxnet-cu92/) with CUDA-9.2 support. +- [mxnet-cu92mkl](https://pypi.python.org/pypi/mxnet-cu92mkl/) with CUDA-9.2 support and MKLDNN support. +- [mxnet-cu91](https://pypi.python.org/pypi/mxnet-cu91/) with CUDA-9.1 support. +- [mxnet-cu91mkl](https://pypi.python.org/pypi/mxnet-cu91mkl/) with CUDA-9.1 support and MKLDNN support. +- [mxnet-cu90](https://pypi.python.org/pypi/mxnet-cu90/) with CUDA-9.0 support. +- [mxnet-cu90mkl](https://pypi.python.org/pypi/mxnet-cu90mkl/) with CUDA-9.0 support and MKLDNN support. +- [mxnet-cu80](https://pypi.python.org/pypi/mxnet-cu80/) with CUDA-8.0 support. +- [mxnet-cu80mkl](https://pypi.python.org/pypi/mxnet-cu80mkl/) with CUDA-8.0 support and MKLDNN support. +- [mxnet-cu75](https://pypi.python.org/pypi/mxnet-cu75/) with CUDA-7.5 support. +- [mxnet-cu75mkl](https://pypi.python.org/pypi/mxnet-cu75mkl/) with CUDA-7.5 support and MKLDNN support. +- [mxnet-mkl](https://pypi.python.org/pypi/mxnet-mkl/) with MKLDNN support. + +To install for other platforms (e.g. Windows, Raspberry Pi/ARM) or other versions, check [Installing MXNet](https://mxnet.incubator.apache.org/versions/master/install/index.html) for instructions on building from source. + +Installation +------------ +To install, use: +```bash +pip install mxnet +``` diff --git a/tools/pip/doc/CU100MKL_ADDITIONAL.md b/tools/pip/doc/CU100MKL_ADDITIONAL.md new file mode 100644 index 000000000000..f47115c93c1a --- /dev/null +++ b/tools/pip/doc/CU100MKL_ADDITIONAL.md @@ -0,0 +1,44 @@ + + + + + + + + + + + + + + + + + +Prerequisites +------------- +This package supports Linux and Windows platforms. You may also want to check: +- [mxnet-cu100](https://pypi.python.org/pypi/mxnet-cu100/) with CUDA-10.0 support. +- [mxnet-cu92](https://pypi.python.org/pypi/mxnet-cu92/) with CUDA-9.2 support. +- [mxnet-cu92mkl](https://pypi.python.org/pypi/mxnet-cu92mkl/) with CUDA-9.2 support and MKLDNN support. +- [mxnet-cu91](https://pypi.python.org/pypi/mxnet-cu91/) with CUDA-9.1 support. +- [mxnet-cu91mkl](https://pypi.python.org/pypi/mxnet-cu91mkl/) with CUDA-9.1 support and MKLDNN support. +- [mxnet-cu90](https://pypi.python.org/pypi/mxnet-cu90/) with CUDA-9.0 support. +- [mxnet-cu90mkl](https://pypi.python.org/pypi/mxnet-cu90mkl/) with CUDA-9.0 support and MKLDNN support. +- [mxnet-cu80](https://pypi.python.org/pypi/mxnet-cu80/) with CUDA-8.0 support. +- [mxnet-cu80mkl](https://pypi.python.org/pypi/mxnet-cu80mkl/) with CUDA-8.0 support and MKLDNN support. +- [mxnet-cu75](https://pypi.python.org/pypi/mxnet-cu75/) with CUDA-7.5 support. +- [mxnet-cu75mkl](https://pypi.python.org/pypi/mxnet-cu75mkl/) with CUDA-7.5 support and MKLDNN support. +- [mxnet-mkl](https://pypi.python.org/pypi/mxnet-mkl/) with MKLDNN support. +- [mxnet](https://pypi.python.org/pypi/mxnet/). + +To download CUDA, check [CUDA download](https://developer.nvidia.com/cuda-downloads). For more instructions, check [CUDA Toolkit online documentation](http://docs.nvidia.com/cuda/index.html). + +To install for other platforms (e.g. Windows, Raspberry Pi/ARM) or other versions of CUDA, check [Installing MXNet](https://mxnet.incubator.apache.org/versions/master/install/index.html) for instructions on building from source. + +Installation +------------ +To install: +```bash +pip install mxnet-cu100mkl +``` diff --git a/tools/pip/doc/CU100_ADDITIONAL.md b/tools/pip/doc/CU100_ADDITIONAL.md new file mode 100644 index 000000000000..32c30b0fef5e --- /dev/null +++ b/tools/pip/doc/CU100_ADDITIONAL.md @@ -0,0 +1,44 @@ + + + + + + + + + + + + + + + + + +Prerequisites +------------- +This package supports Linux and Windows platforms. You may also want to check: +- [mxnet-cu100mkl](https://pypi.python.org/pypi/mxnet-cu100mkl/) with CUDA-10.0 support and MKLDNN support. +- [mxnet-cu92](https://pypi.python.org/pypi/mxnet-cu92/) with CUDA-9.2 support. +- [mxnet-cu92mkl](https://pypi.python.org/pypi/mxnet-cu92mkl/) with CUDA-9.2 support and MKLDNN support. +- [mxnet-cu91](https://pypi.python.org/pypi/mxnet-cu91/) with CUDA-9.1 support. +- [mxnet-cu91mkl](https://pypi.python.org/pypi/mxnet-cu91mkl/) with CUDA-9.1 support and MKLDNN support. +- [mxnet-cu90](https://pypi.python.org/pypi/mxnet-cu90/) with CUDA-9.0 support. +- [mxnet-cu90mkl](https://pypi.python.org/pypi/mxnet-cu90mkl/) with CUDA-9.0 support and MKLDNN support. +- [mxnet-cu80](https://pypi.python.org/pypi/mxnet-cu80/) with CUDA-8.0 support. +- [mxnet-cu80mkl](https://pypi.python.org/pypi/mxnet-cu80mkl/) with CUDA-8.0 support and MKLDNN support. +- [mxnet-cu75](https://pypi.python.org/pypi/mxnet-cu75/) with CUDA-7.5 support. +- [mxnet-cu75mkl](https://pypi.python.org/pypi/mxnet-cu75mkl/) with CUDA-7.5 support and MKLDNN support. +- [mxnet-mkl](https://pypi.python.org/pypi/mxnet-mkl/) with MKLDNN support. +- [mxnet](https://pypi.python.org/pypi/mxnet/). + +To download CUDA, check [CUDA download](https://developer.nvidia.com/cuda-downloads). For more instructions, check [CUDA Toolkit online documentation](http://docs.nvidia.com/cuda/index.html). + +To install for other platforms (e.g. Windows, Raspberry Pi/ARM) or other versions, check [Installing MXNet](https://mxnet.incubator.apache.org/versions/master/install/index.html) for instructions on building from source. + +Installation +------------ +To install: +```bash +pip install mxnet-cu100 +``` diff --git a/tools/pip/doc/CU75MKL_ADDITIONAL.md b/tools/pip/doc/CU75MKL_ADDITIONAL.md new file mode 100644 index 000000000000..cc6c8820a0e3 --- /dev/null +++ b/tools/pip/doc/CU75MKL_ADDITIONAL.md @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + +Prerequisites +------------- +This package supports Linux only, up to 1.2.1. You may also want to check: +- [mxnet-cu92](https://pypi.python.org/pypi/mxnet-cu92/) with CUDA-9.2 support. +- [mxnet-cu92mkl](https://pypi.python.org/pypi/mxnet-cu92mkl/) with CUDA-9.2 support and MKLDNN support. +- [mxnet-cu91](https://pypi.python.org/pypi/mxnet-cu91/) with CUDA-9.1 support. +- [mxnet-cu91mkl](https://pypi.python.org/pypi/mxnet-cu91mkl/) with CUDA-9.1 support and MKLDNN support. +- [mxnet-cu90](https://pypi.python.org/pypi/mxnet-cu90/) with CUDA-9.0 support. +- [mxnet-cu90mkl](https://pypi.python.org/pypi/mxnet-cu90mkl/) with CUDA-9.0 support and MKLDNN support. +- [mxnet-cu80](https://pypi.python.org/pypi/mxnet-cu80/) with CUDA-8.0 support. +- [mxnet-cu80mkl](https://pypi.python.org/pypi/mxnet-cu80mkl/) with CUDA-8.0 support and MKLDNN support. +- [mxnet-cu75](https://pypi.python.org/pypi/mxnet-cu75/) with CUDA-7.5 support. +- [mxnet-mkl](https://pypi.python.org/pypi/mxnet-mkl/) with MKLDNN support. +- [mxnet](https://pypi.python.org/pypi/mxnet/). + +To download CUDA, check [CUDA download](https://developer.nvidia.com/cuda-downloads). For more instructions, check [CUDA Toolkit online documentation](http://docs.nvidia.com/cuda/index.html). + +To install for other platforms (e.g. Windows, Raspberry Pi/ARM) or other versions, check [Installing MXNet](https://mxnet.incubator.apache.org/versions/master/install/index.html) for instructions on building from source. + +Installation +------------ +To install: +```bash +pip install mxnet-cu75mkl +``` diff --git a/tools/pip/doc/CU75_ADDITIONAL.md b/tools/pip/doc/CU75_ADDITIONAL.md new file mode 100644 index 000000000000..ad57c13fda9e --- /dev/null +++ b/tools/pip/doc/CU75_ADDITIONAL.md @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + +Prerequisites +------------- +This package supports Linux only, up to 1.2.1. You may also want to check: +- [mxnet-cu92](https://pypi.python.org/pypi/mxnet-cu92/) with CUDA-9.2 support. +- [mxnet-cu92mkl](https://pypi.python.org/pypi/mxnet-cu92mkl/) with CUDA-9.2 support and MKLDNN support. +- [mxnet-cu91](https://pypi.python.org/pypi/mxnet-cu91/) with CUDA-9.1 support. +- [mxnet-cu91mkl](https://pypi.python.org/pypi/mxnet-cu91mkl/) with CUDA-9.1 support and MKLDNN support. +- [mxnet-cu90](https://pypi.python.org/pypi/mxnet-cu90/) with CUDA-9.0 support. +- [mxnet-cu90mkl](https://pypi.python.org/pypi/mxnet-cu90mkl/) with CUDA-9.0 support and MKLDNN support. +- [mxnet-cu80](https://pypi.python.org/pypi/mxnet-cu80/) with CUDA-8.0 support. +- [mxnet-cu80mkl](https://pypi.python.org/pypi/mxnet-cu80mkl/) with CUDA-8.0 support and MKLDNN support. +- [mxnet-cu75mkl](https://pypi.python.org/pypi/mxnet-cu75mkl/) with CUDA-7.5 support and MKLDNN support. +- [mxnet-mkl](https://pypi.python.org/pypi/mxnet-mkl/) with MKLDNN support. +- [mxnet](https://pypi.python.org/pypi/mxnet/). + +To download CUDA, check [CUDA download](https://developer.nvidia.com/cuda-downloads). For more instructions, check [CUDA Toolkit online documentation](http://docs.nvidia.com/cuda/index.html). + +To install for other platforms (e.g. Windows, Raspberry Pi/ARM) or other versions, check [Installing MXNet](https://mxnet.incubator.apache.org/versions/master/install/index.html) for instructions on building from source. + +Installation +------------ +To install: +```bash +pip install mxnet-cu75 +``` diff --git a/tools/pip/doc/CU80MKL_ADDITIONAL.md b/tools/pip/doc/CU80MKL_ADDITIONAL.md new file mode 100644 index 000000000000..549df7dca8d6 --- /dev/null +++ b/tools/pip/doc/CU80MKL_ADDITIONAL.md @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + +Prerequisites +------------- +This package supports Linux and Windows platforms. You may also want to check: +- [mxnet-cu92](https://pypi.python.org/pypi/mxnet-cu92/) with CUDA-9.2 support. +- [mxnet-cu92mkl](https://pypi.python.org/pypi/mxnet-cu92mkl/) with CUDA-9.2 support and MKLDNN support. +- [mxnet-cu91](https://pypi.python.org/pypi/mxnet-cu91/) with CUDA-9.1 support. +- [mxnet-cu91mkl](https://pypi.python.org/pypi/mxnet-cu91mkl/) with CUDA-9.1 support and MKLDNN support. +- [mxnet-cu90](https://pypi.python.org/pypi/mxnet-cu90/) with CUDA-9.0 support. +- [mxnet-cu90mkl](https://pypi.python.org/pypi/mxnet-cu90mkl/) with CUDA-9.0 support and MKLDNN support. +- [mxnet-cu80](https://pypi.python.org/pypi/mxnet-cu80/) with CUDA-8.0 support. +- [mxnet-cu75](https://pypi.python.org/pypi/mxnet-cu75/) with CUDA-7.5 support. +- [mxnet-cu75mkl](https://pypi.python.org/pypi/mxnet-cu75mkl/) with CUDA-7.5 support and MKLDNN support. +- [mxnet-mkl](https://pypi.python.org/pypi/mxnet-mkl/) with MKLDNN support. +- [mxnet](https://pypi.python.org/pypi/mxnet/). + +To download CUDA, check [CUDA download](https://developer.nvidia.com/cuda-downloads). For more instructions, check [CUDA Toolkit online documentation](http://docs.nvidia.com/cuda/index.html). + +To install for other platforms (e.g. Windows, Raspberry Pi/ARM) or other versions of CUDA, check [Installing MXNet](https://mxnet.incubator.apache.org/versions/master/install/index.html) for instructions on building from source. + +Installation +------------ +To install: +```bash +pip install mxnet-cu80mkl +``` diff --git a/tools/pip/doc/CU80_ADDITIONAL.md b/tools/pip/doc/CU80_ADDITIONAL.md new file mode 100644 index 000000000000..7105dfd1ba2c --- /dev/null +++ b/tools/pip/doc/CU80_ADDITIONAL.md @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + +Prerequisites +------------- +This package supports Linux and Windows platforms. You may also want to check: +- [mxnet-cu92](https://pypi.python.org/pypi/mxnet-cu92/) with CUDA-9.2 support. +- [mxnet-cu92mkl](https://pypi.python.org/pypi/mxnet-cu92mkl/) with CUDA-9.2 support and MKLDNN support. +- [mxnet-cu91](https://pypi.python.org/pypi/mxnet-cu91/) with CUDA-9.1 support. +- [mxnet-cu91mkl](https://pypi.python.org/pypi/mxnet-cu91mkl/) with CUDA-9.1 support and MKLDNN support. +- [mxnet-cu90](https://pypi.python.org/pypi/mxnet-cu90/) with CUDA-9.0 support. +- [mxnet-cu90mkl](https://pypi.python.org/pypi/mxnet-cu90mkl/) with CUDA-9.0 support and MKLDNN support. +- [mxnet-cu80mkl](https://pypi.python.org/pypi/mxnet-cu80mkl/) with CUDA-8.0 support and MKLDNN support. +- [mxnet-cu75](https://pypi.python.org/pypi/mxnet-cu75/) with CUDA-7.5 support. +- [mxnet-cu75mkl](https://pypi.python.org/pypi/mxnet-cu75mkl/) with CUDA-7.5 support and MKLDNN support. +- [mxnet-mkl](https://pypi.python.org/pypi/mxnet-mkl/) with MKLDNN support. +- [mxnet](https://pypi.python.org/pypi/mxnet/). + +To download CUDA, check [CUDA download](https://developer.nvidia.com/cuda-downloads). For more instructions, check [CUDA Toolkit online documentation](http://docs.nvidia.com/cuda/index.html). + +To install for other platforms (e.g. Raspberry Pi/ARM) or other versions of CUDA, check [Installing MXNet](https://mxnet.incubator.apache.org/versions/master/install/index.html) for instructions on building from source. + +Installation +------------ +To install: +```bash +pip install mxnet-cu80 +``` diff --git a/tools/pip/doc/CU90MKL_ADDITIONAL.md b/tools/pip/doc/CU90MKL_ADDITIONAL.md new file mode 100644 index 000000000000..8f4257fa96f1 --- /dev/null +++ b/tools/pip/doc/CU90MKL_ADDITIONAL.md @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + +Prerequisites +------------- +This package supports Linux and Windows platforms. You may want to check: +- [mxnet-cu92](https://pypi.python.org/pypi/mxnet-cu92/) with CUDA-9.2 support. +- [mxnet-cu92mkl](https://pypi.python.org/pypi/mxnet-cu92mkl/) with CUDA-9.2 support and MKLDNN support. +- [mxnet-cu91](https://pypi.python.org/pypi/mxnet-cu91/) with CUDA-9.1 support. +- [mxnet-cu91mkl](https://pypi.python.org/pypi/mxnet-cu91mkl/) with CUDA-9.1 support and MKLDNN support. +- [mxnet-cu90](https://pypi.python.org/pypi/mxnet-cu90/) with CUDA-9.0 support. +- [mxnet-cu80](https://pypi.python.org/pypi/mxnet-cu80/) with CUDA-8.0 support. +- [mxnet-cu80mkl](https://pypi.python.org/pypi/mxnet-cu80mkl/) with CUDA-8.0 support and MKLDNN support. +- [mxnet-cu75](https://pypi.python.org/pypi/mxnet-cu75/) with CUDA-7.5 support. +- [mxnet-cu75mkl](https://pypi.python.org/pypi/mxnet-cu75mkl/) with CUDA-7.5 support and MKLDNN support. +- [mxnet-mkl](https://pypi.python.org/pypi/mxnet-mkl/) with MKLDNN support. +- [mxnet](https://pypi.python.org/pypi/mxnet/). + +To download CUDA, check [CUDA download](https://developer.nvidia.com/cuda-downloads). For more instructions, check [CUDA Toolkit online documentation](http://docs.nvidia.com/cuda/index.html). + +To install for other platforms (e.g. Windows, Raspberry Pi/ARM) or other versions of CUDA, check [Installing MXNet](https://mxnet.incubator.apache.org/versions/master/install/index.html) for instructions on building from source. + +Installation +------------ +To install: +```bash +pip install mxnet-cu90mkl +``` diff --git a/tools/pip/doc/CU90_ADDITIONAL.md b/tools/pip/doc/CU90_ADDITIONAL.md new file mode 100644 index 000000000000..477a5cb57e96 --- /dev/null +++ b/tools/pip/doc/CU90_ADDITIONAL.md @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + +Prerequisites +------------- +This package supports Linux and Windows platforms. You may also want to check: +- [mxnet-cu92](https://pypi.python.org/pypi/mxnet-cu92/) with CUDA-9.2 support. +- [mxnet-cu92mkl](https://pypi.python.org/pypi/mxnet-cu92mkl/) with CUDA-9.2 support and MKLDNN support. +- [mxnet-cu91](https://pypi.python.org/pypi/mxnet-cu91/) with CUDA-9.1 support. +- [mxnet-cu91mkl](https://pypi.python.org/pypi/mxnet-cu91mkl/) with CUDA-9.1 support and MKLDNN support. +- [mxnet-cu90mkl](https://pypi.python.org/pypi/mxnet-cu90mkl/) with CUDA-9.0 support and MKLDNN support. +- [mxnet-cu80](https://pypi.python.org/pypi/mxnet-cu80/) with CUDA-8.0 support. +- [mxnet-cu80mkl](https://pypi.python.org/pypi/mxnet-cu80mkl/) with CUDA-8.0 support and MKLDNN support. +- [mxnet-cu75](https://pypi.python.org/pypi/mxnet-cu75/) with CUDA-7.5 support. +- [mxnet-cu75mkl](https://pypi.python.org/pypi/mxnet-cu75mkl/) with CUDA-7.5 support and MKLDNN support. +- [mxnet-mkl](https://pypi.python.org/pypi/mxnet-mkl/) with MKLDNN support. +- [mxnet](https://pypi.python.org/pypi/mxnet/). + +To download CUDA, check [CUDA download](https://developer.nvidia.com/cuda-downloads). For more instructions, check [CUDA Toolkit online documentation](http://docs.nvidia.com/cuda/index.html). + +To install for other platforms (e.g. Windows, Raspberry Pi/ARM) or other versions, check [Installing MXNet](https://mxnet.incubator.apache.org/versions/master/install/index.html) for instructions on building from source. + +Installation +------------ +To install: +```bash +pip install mxnet-cu90 +``` diff --git a/tools/pip/doc/CU91MKL_ADDITIONAL.md b/tools/pip/doc/CU91MKL_ADDITIONAL.md new file mode 100644 index 000000000000..d1706c0d5fa7 --- /dev/null +++ b/tools/pip/doc/CU91MKL_ADDITIONAL.md @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + +Prerequisites +------------- +This package supports Linux and Windows platforms, up to 1.2.1. You may also want to check: +- [mxnet-cu92](https://pypi.python.org/pypi/mxnet-cu92/) with CUDA-9.2 support. +- [mxnet-cu92mkl](https://pypi.python.org/pypi/mxnet-cu92mkl/) with CUDA-9.2 support and MKLDNN support. +- [mxnet-cu91](https://pypi.python.org/pypi/mxnet-cu91/) with CUDA-9.1 support. +- [mxnet-cu90](https://pypi.python.org/pypi/mxnet-cu90/) with CUDA-9.0 support. +- [mxnet-cu90mkl](https://pypi.python.org/pypi/mxnet-cu90mkl/) with CUDA-9.0 support and MKLDNN support. +- [mxnet-cu80](https://pypi.python.org/pypi/mxnet-cu80/) with CUDA-8.0 support. +- [mxnet-cu80mkl](https://pypi.python.org/pypi/mxnet-cu80mkl/) with CUDA-8.0 support and MKLDNN support. +- [mxnet-cu75](https://pypi.python.org/pypi/mxnet-cu75/) with CUDA-7.5 support. +- [mxnet-cu75mkl](https://pypi.python.org/pypi/mxnet-cu75mkl/) with CUDA-7.5 support and MKLDNN support. +- [mxnet-mkl](https://pypi.python.org/pypi/mxnet-mkl/) with MKLDNN support. +- [mxnet](https://pypi.python.org/pypi/mxnet/). + +To download CUDA, check [CUDA download](https://developer.nvidia.com/cuda-downloads). For more instructions, check [CUDA Toolkit online documentation](http://docs.nvidia.com/cuda/index.html). + +To install for other platforms (e.g. Windows, Raspberry Pi/ARM) or other versions of CUDA, check [Installing MXNet](https://mxnet.incubator.apache.org/versions/master/install/index.html) for instructions on building from source. + +Installation +------------ +To install: +```bash +pip install mxnet-cu91mkl +``` diff --git a/tools/pip/doc/CU91_ADDITIONAL.md b/tools/pip/doc/CU91_ADDITIONAL.md new file mode 100644 index 000000000000..cbb5567917d2 --- /dev/null +++ b/tools/pip/doc/CU91_ADDITIONAL.md @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + +Prerequisites +------------- +This package supports Linux and Windows platforms, up to 1.2.1. You may also want to check: +- [mxnet-cu92](https://pypi.python.org/pypi/mxnet-cu92/) with CUDA-9.2 support. +- [mxnet-cu92mkl](https://pypi.python.org/pypi/mxnet-cu92mkl/) with CUDA-9.2 support and MKLDNN support. +- [mxnet-cu91mkl](https://pypi.python.org/pypi/mxnet-cu91mkl/) with CUDA-9.1 support and MKLDNN support. +- [mxnet-cu90](https://pypi.python.org/pypi/mxnet-cu90/) with CUDA-9.0 support. +- [mxnet-cu90mkl](https://pypi.python.org/pypi/mxnet-cu90mkl/) with CUDA-9.0 support and MKLDNN support. +- [mxnet-cu80](https://pypi.python.org/pypi/mxnet-cu80/) with CUDA-8.0 support. +- [mxnet-cu80mkl](https://pypi.python.org/pypi/mxnet-cu80mkl/) with CUDA-8.0 support and MKLDNN support. +- [mxnet-cu75](https://pypi.python.org/pypi/mxnet-cu75/) with CUDA-7.5 support. +- [mxnet-cu75mkl](https://pypi.python.org/pypi/mxnet-cu75mkl/) with CUDA-7.5 support and MKLDNN support. +- [mxnet-mkl](https://pypi.python.org/pypi/mxnet-mkl/) with MKLDNN support. +- [mxnet](https://pypi.python.org/pypi/mxnet/). + +To download CUDA, check [CUDA download](https://developer.nvidia.com/cuda-downloads). For more instructions, check [CUDA Toolkit online documentation](http://docs.nvidia.com/cuda/index.html). + +To install for other platforms (e.g. Windows, Raspberry Pi/ARM) or other versions, check [Installing MXNet](https://mxnet.incubator.apache.org/versions/master/install/index.html) for instructions on building from source. + +Installation +------------ +To install: +```bash +pip install mxnet-cu91 +``` diff --git a/tools/pip/doc/CU92MKL_ADDITIONAL.md b/tools/pip/doc/CU92MKL_ADDITIONAL.md new file mode 100644 index 000000000000..16cd8f138add --- /dev/null +++ b/tools/pip/doc/CU92MKL_ADDITIONAL.md @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + +Prerequisites +------------- +This package supports Linux and Windows platforms. You may also want to check: +- [mxnet-cu92](https://pypi.python.org/pypi/mxnet-cu92/) with CUDA-9.2 support. +- [mxnet-cu91](https://pypi.python.org/pypi/mxnet-cu91/) with CUDA-9.1 support. +- [mxnet-cu91mkl](https://pypi.python.org/pypi/mxnet-cu91mkl/) with CUDA-9.1 support and MKLDNN support. +- [mxnet-cu90](https://pypi.python.org/pypi/mxnet-cu90/) with CUDA-9.0 support. +- [mxnet-cu90mkl](https://pypi.python.org/pypi/mxnet-cu90mkl/) with CUDA-9.0 support and MKLDNN support. +- [mxnet-cu80](https://pypi.python.org/pypi/mxnet-cu80/) with CUDA-8.0 support. +- [mxnet-cu80mkl](https://pypi.python.org/pypi/mxnet-cu80mkl/) with CUDA-8.0 support and MKLDNN support. +- [mxnet-cu75](https://pypi.python.org/pypi/mxnet-cu75/) with CUDA-7.5 support. +- [mxnet-cu75mkl](https://pypi.python.org/pypi/mxnet-cu75mkl/) with CUDA-7.5 support and MKLDNN support. +- [mxnet-mkl](https://pypi.python.org/pypi/mxnet-mkl/) with MKLDNN support. +- [mxnet](https://pypi.python.org/pypi/mxnet/). + +To download CUDA, check [CUDA download](https://developer.nvidia.com/cuda-downloads). For more instructions, check [CUDA Toolkit online documentation](http://docs.nvidia.com/cuda/index.html). + +To install for other platforms (e.g. Windows, Raspberry Pi/ARM) or other versions of CUDA, check [Installing MXNet](https://mxnet.incubator.apache.org/versions/master/install/index.html) for instructions on building from source. + +Installation +------------ +To install: +```bash +pip install mxnet-cu92mkl +``` diff --git a/tools/pip/doc/CU92_ADDITIONAL.md b/tools/pip/doc/CU92_ADDITIONAL.md new file mode 100644 index 000000000000..28569ac069b2 --- /dev/null +++ b/tools/pip/doc/CU92_ADDITIONAL.md @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + +Prerequisites +------------- +This package supports Linux and Windows platforms. You may also want to check: +- [mxnet-cu92mkl](https://pypi.python.org/pypi/mxnet-cu92mkl/) with CUDA-9.2 support and MKLDNN support. +- [mxnet-cu91](https://pypi.python.org/pypi/mxnet-cu91/) with CUDA-9.1 support. +- [mxnet-cu91mkl](https://pypi.python.org/pypi/mxnet-cu91mkl/) with CUDA-9.1 support and MKLDNN support. +- [mxnet-cu90](https://pypi.python.org/pypi/mxnet-cu90/) with CUDA-9.0 support. +- [mxnet-cu90mkl](https://pypi.python.org/pypi/mxnet-cu90mkl/) with CUDA-9.0 support and MKLDNN support. +- [mxnet-cu80](https://pypi.python.org/pypi/mxnet-cu80/) with CUDA-8.0 support. +- [mxnet-cu80mkl](https://pypi.python.org/pypi/mxnet-cu80mkl/) with CUDA-8.0 support and MKLDNN support. +- [mxnet-cu75](https://pypi.python.org/pypi/mxnet-cu75/) with CUDA-7.5 support. +- [mxnet-cu75mkl](https://pypi.python.org/pypi/mxnet-cu75mkl/) with CUDA-7.5 support and MKLDNN support. +- [mxnet-mkl](https://pypi.python.org/pypi/mxnet-mkl/) with MKLDNN support. +- [mxnet](https://pypi.python.org/pypi/mxnet/). + +To download CUDA, check [CUDA download](https://developer.nvidia.com/cuda-downloads). For more instructions, check [CUDA Toolkit online documentation](http://docs.nvidia.com/cuda/index.html). + +To install for other platforms (e.g. Windows, Raspberry Pi/ARM) or other versions, check [Installing MXNet](https://mxnet.incubator.apache.org/versions/master/install/index.html) for instructions on building from source. + +Installation +------------ +To install: +```bash +pip install mxnet-cu92 +``` diff --git a/tools/pip/doc/MKL_ADDITIONAL.md b/tools/pip/doc/MKL_ADDITIONAL.md new file mode 100644 index 000000000000..60f827bff0b6 --- /dev/null +++ b/tools/pip/doc/MKL_ADDITIONAL.md @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + + + +Prerequisites +------------- +This package supports Linux only. You may also want to check: +- [mxnet-cu92](https://pypi.python.org/pypi/mxnet-cu92/) with CUDA-9.2 support. +- [mxnet-cu92mkl](https://pypi.python.org/pypi/mxnet-cu92mkl/) with CUDA-9.2 support and MKLDNN support. +- [mxnet-cu91](https://pypi.python.org/pypi/mxnet-cu91/) with CUDA-9.1 support. +- [mxnet-cu91mkl](https://pypi.python.org/pypi/mxnet-cu91mkl/) with CUDA-9.1 support and MKLDNN support. +- [mxnet-cu90](https://pypi.python.org/pypi/mxnet-cu90/) with CUDA-9.0 support. +- [mxnet-cu90mkl](https://pypi.python.org/pypi/mxnet-cu90mkl/) with CUDA-9.0 support and MKLDNN support. +- [mxnet-cu80](https://pypi.python.org/pypi/mxnet-cu80/) with CUDA-8.0 support. +- [mxnet-cu80mkl](https://pypi.python.org/pypi/mxnet-cu80mkl/) with CUDA-8.0 support and MKLDNN support. +- [mxnet-cu75](https://pypi.python.org/pypi/mxnet-cu75/) with CUDA-7.5 support. +- [mxnet-cu75mkl](https://pypi.python.org/pypi/mxnet-cu75mkl/) with CUDA-7.5 support and MKLDNN support. +- [mxnet](https://pypi.python.org/pypi/mxnet/). + +To install for other platforms (e.g. Windows, Raspberry Pi/ARM) or other versions, check [Installing MXNet](https://mxnet.incubator.apache.org/versions/master/install/index.html) for instructions on building from source. + +Installation +------------ +To install: +```bash +pip install mxnet-mkl +``` diff --git a/tools/pip/doc/PYPI_README.md b/tools/pip/doc/PYPI_README.md new file mode 100644 index 000000000000..899ebc032217 --- /dev/null +++ b/tools/pip/doc/PYPI_README.md @@ -0,0 +1,25 @@ + + + + + + + + + + + + + + + + + +Apache MXNet (Incubating) Python Package +======================================== +[Apache MXNet](http://beta.mxnet.io) is a deep learning framework designed for both *efficiency* and *flexibility*. +It allows you to mix the flavours of deep learning programs together to maximize the efficiency and your productivity. + +For feature requests on the PyPI package, suggestions, and issue reports, create an issue by clicking [here](https://github.com/apache/incubator-mxnet/issues/new). + + diff --git a/tools/pip/setup.py b/tools/pip/setup.py index d5db6d87fc1d..f5f9545619bf 100644 --- a/tools/pip/setup.py +++ b/tools/pip/setup.py @@ -65,6 +65,14 @@ def has_ext_modules(self): os.path.join(CURRENT_DIR, 'dmlc_tracker')) shutil.copy(LIB_PATH[0], os.path.join(CURRENT_DIR, 'mxnet')) +# copy license and notice +shutil.copy(os.path.join(CURRENT_DIR, 'mxnet-build/LICENSE'), + os.path.join(CURRENT_DIR, 'mxnet/LICENSE')) +shutil.copy(os.path.join(CURRENT_DIR, 'mxnet-build/DISCLAIMER'), + os.path.join(CURRENT_DIR, 'mxnet/DISCLAIMER')) +shutil.copy(os.path.join(CURRENT_DIR, 'mxnet-build/NOTICE'), + os.path.join(CURRENT_DIR, 'mxnet/NOTICE')) + # copy tools to mxnet package shutil.rmtree(os.path.join(CURRENT_DIR, 'mxnet/tools'), ignore_errors=True) os.mkdir(os.path.join(CURRENT_DIR, 'mxnet/tools')) @@ -112,7 +120,9 @@ def has_ext_modules(self): if variant == 'CPU': libraries.append('openblas') else: - if variant.startswith('CU92'): + if variant.startswith('CU100'): + libraries.append('CUDA-10.0') + elif variant.startswith('CU92'): libraries.append('CUDA-9.2') elif variant.startswith('CU91'): libraries.append('CUDA-9.1') @@ -152,6 +162,11 @@ def has_ext_modules(self): shutil.copy(os.path.join(os.path.dirname(LIB_PATH[0]), 'libquadmath.so.0'), os.path.join(CURRENT_DIR, 'mxnet')) package_data['mxnet'].append('mxnet/libquadmath.so.0') +# copy licenses +if variant.startswith('CU'): + shutil.copy(os.path.join(os.path.dirname(LIB_PATH[0]), '../CUB_LICENSE'), os.path.join(CURRENT_DIR, 'mxnet')) + package_data['mxnet'].append('mxnet/CUB_LICENSE') + from mxnet.base import _generate_op_module_signature from mxnet.ndarray.register import _generate_ndarray_function_code from mxnet.symbol.register import _generate_symbol_function_code