Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

[Doc] Change the description for pip packages #12584

Merged
merged 4 commits into from
Sep 25, 2018
Merged
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
36 changes: 30 additions & 6 deletions docs/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,11 +141,17 @@ $ pip install mxnet --pre

</div> <!-- End of master-->
<hr> <!-- pip footer -->
Most MXNet versions offer an experimental MKL pip package that will be much faster when running on Intel hardware.
Check the chart below for other options, refer to <a href="https://pypi.org/project/mxnet/">PyPI for other MXNet pip packages</a>, or <a href="validate_mxnet.html">validate your MXNet installation</a>.
MXNet offers MKL pip packages that will be much faster when running on Intel hardware.
Check the chart below for other options, refer to <a href="https://pypi.org/project/mxnet/">PyPI for other MXNet pip packages</a>, or <a href="validate_mxnet.html">validate your MXNet installation</a>.

<img src="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/install/pip-packages-1.3.0.png" alt="pip packages"/>

**NOTES:**

*mxnet-cu92mkl* means the package is built with CUDA/cuDNN and MKL-DNN enabled and the CUDA version is 9.2.

All MKL pip packages are experimental prior to version 1.3.0.

</div> <!-- End of pip -->


Expand Down Expand Up @@ -252,13 +258,17 @@ $ pip install mxnet-cu92 --pre

</div> <!-- End of master-->
<hr> <!-- pip footer -->
Most MXNet versions offer an experimental MKL pip package that will be much faster when running on Intel hardware.
MXNet offers MKL pip packages that will be much faster when running on Intel hardware.
Check the chart below for other options, refer to <a href="https://pypi.org/project/mxnet/">PyPI for other MXNet pip packages</a>, or <a href="validate_mxnet.html">validate your MXNet installation</a>.

<img src="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/install/pip-packages-1.3.0.png" alt="pip packages"/>

**NOTES:**

*mxnet-cu92mkl* means the package is built with CUDA/cuDNN and MKL-DNN enabled and the CUDA version is 9.2.

All MKL pip packages are experimental prior to version 1.3.0.

CUDA should be installed first. Instructions can be found in the <a href="ubuntu_setup.html#cuda-dependencies">CUDA dependencies section of the MXNet Ubuntu installation guide</a>.

**Important:** Make sure your installed CUDA version matches the CUDA version in the pip package. Check your CUDA version with the following command:
Expand Down Expand Up @@ -478,11 +488,16 @@ $ pip install mxnet --pre

</div> <!-- End of master-->
<hr> <!-- pip footer -->
Most MXNet versions offer an experimental MKL pip package that will be much faster when running on Intel hardware.
MXNet offers MKL pip packages that will be much faster when running on Intel hardware.
Check the chart below for other options, refer to <a href="https://pypi.org/project/mxnet/">PyPI for other MXNet pip packages</a>, or <a href="validate_mxnet.html">validate your MXNet installation</a>.

<img src="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/install/pip-packages-1.3.0.png" alt="pip packages"/>

**NOTES:**

*mxnet-cu92mkl* means the package is built with CUDA/cuDNN and MKL-DNN enabled and the CUDA version is 9.2.

All MKL pip packages are experimental prior to version 1.3.0.

</div> <!-- END of pip -->

Expand Down Expand Up @@ -686,11 +701,16 @@ $ pip install mxnet --pre

</div> <!-- End of master-->
<hr> <!-- pip footer -->
Most MXNet versions offer an experimental MKL pip package that will be much faster when running on Intel hardware.
MXNet offers MKL pip packages that will be much faster when running on Intel hardware.
Check the chart below for other options, refer to <a href="https://pypi.org/project/mxnet/">PyPI for other MXNet pip packages</a>, or <a href="validate_mxnet.html">validate your MXNet installation</a>.

<img src="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/install/pip-packages-1.3.0.png" alt="pip packages"/>

**NOTES:**

*mxnet-cu92mkl* means the package is built with CUDA/cuDNN and MKL-DNN enabled and the CUDA version is 9.2.

All MKL pip packages are experimental prior to version 1.3.0.

</div> <!-- End of pip -->

Expand Down Expand Up @@ -762,13 +782,17 @@ $ pip install mxnet-cu92 --pre

</div> <!-- End of master-->
<hr> <!-- pip footer -->
Most MXNet versions offer an experimental MKL pip package that will be much faster when running on Intel hardware.
MXNet offers MKL pip packages that will be much faster when running on Intel hardware.
Check the chart below for other options, refer to <a href="https://pypi.org/project/mxnet/">PyPI for other MXNet pip packages</a>, or <a href="validate_mxnet.html">validate your MXNet installation</a>.

<img src="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/install/pip-packages-1.3.0.png" alt="pip packages"/>

**NOTES:**

*mxnet-cu92mkl* means the package is built with CUDA/cuDNN and MKL-DNN enabled and the CUDA version is 9.2.

All MKL pip packages are experimental prior to version 1.3.0.

[Anaconda](https://www.anaconda.com/download/) is recommended.

CUDA should be installed first. Instructions can be found in the <a href="ubuntu_setup.html#cuda-dependencies">CUDA dependencies section of the MXNet Ubuntu installation guide</a>.
Expand Down
2 changes: 1 addition & 1 deletion docs/install/windows_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ We provide two primary options to build and install MXNet yourself using [Micros

**NOTE:** Visual Studio 2017's compiler is `vc15`. This is not to be confused with Visual Studio 2015's compiler, `vc14`.

You also have the option to install MXNet with MKL or MKLDNN. In this case it is recommended that you refer to the [MKLDNN_README](https://github.com/apache/incubator-mxnet/blob/master/MKLDNN_README.md).
You also have the option to install MXNet with MKL or MKL-DNN. In this case it is recommended that you refer to the [MKLDNN_README](https://github.com/apache/incubator-mxnet/blob/master/MKLDNN_README.md).

**Option 1: Build with Microsoft Visual Studio 2017 (VS2017)**

Expand Down