You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by GitBox <gi...@apache.org> on 2018/09/25 18:41:39 UTC
[GitHub] sandeep-krishnamurthy closed pull request #12584: [Doc] Change the
description for pip packages
sandeep-krishnamurthy closed pull request #12584: [Doc] Change the description for pip packages
URL: https://github.com/apache/incubator-mxnet/pull/12584
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/docs/install/index.md b/docs/install/index.md
index dd6f97c132d..c2aa229de1d 100644
--- a/docs/install/index.md
+++ b/docs/install/index.md
@@ -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 -->
@@ -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:
@@ -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 -->
@@ -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 -->
@@ -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>.
diff --git a/docs/install/windows_setup.md b/docs/install/windows_setup.md
index 01cd46658a7..1b5262fa47f 100755
--- a/docs/install/windows_setup.md
+++ b/docs/install/windows_setup.md
@@ -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)**
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services