This is an automated email from the ASF dual-hosted git repository. lausen pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/incubator-mxnet.git
The following commit(s) were added to refs/heads/master by this push: new eea0cd8 Update static site web pages (#18161) eea0cd8 is described below commit eea0cd8bd65f02b9b3933d19d9d32080ed3d89ff Author: waytrue17 <52505574+waytru...@users.noreply.github.com> AuthorDate: Mon May 4 11:40:26 2020 -0700 Update static site web pages (#18161) * update from upstream * modify static website * fix web url * fix indentation * modify build pages * add gcc requirment * Fix Julia guide * test get_started_link * test get_started link * change 3rdparty versions * Fix math table in build source page Co-authored-by: Wei Chu <wei...@amazon.com> Co-authored-by: Leonard Lausen <lau...@amazon.com> --- CONTRIBUTORS.md | 1 + .../src/_includes/get_started/get_started.html | 4 +++ .../src/_includes/get_started/linux/clojure/cpu.md | 11 +++----- .../src/_includes/get_started/linux/clojure/gpu.md | 5 +--- .../src/_includes/get_started/linux/java/cpu.md | 2 +- .../get_started/linux/julia/build-from-source.md | 2 +- .../src/_includes/get_started/linux/perl/perl.md | 2 +- .../linux/python/cpu/build-from-source.md | 2 +- .../get_started/linux/python/cpu/docker.md | 2 +- .../linux/python/gpu/build-from-source.md | 2 +- .../get_started/linux/python/gpu/docker.md | 2 +- .../src/_includes/get_started/linux/r/gpu.md | 4 +-- .../src/_includes/get_started/linux/scala/cpu.md | 6 ++--- .../src/_includes/get_started/linux/scala/gpu.md | 6 ++--- .../src/_includes/get_started/macos/clojure/cpu.md | 6 +---- .../get_started/macos/julia/build-from-source.md | 2 +- .../src/_includes/get_started/macos/perl/perl.md | 2 +- .../macos/python/cpu/build-from-source.md | 2 +- .../get_started/macos/python/cpu/docker.md | 2 +- .../macos/python/gpu/build-from-source.md | 4 +-- .../get_started/macos/python/gpu/pip_docker.md | 2 +- .../src/_includes/get_started/macos/r/cpu.md | 2 +- .../src/_includes/get_started/macos/scala/cpu.md | 2 +- .../src/_includes/get_started/windows/perl/perl.md | 2 +- .../windows/python/cpu/build-from-source.md | 2 +- .../get_started/windows/python/cpu/docker.md | 2 +- .../get_started/windows/python/cpu/pip.md | 3 ++- .../get_started/windows/python/gpu/docker.md | 1 + .../get_started/windows/python/gpu/pip.md | 3 ++- .../src/_includes/get_started/windows/r/cpu.md | 2 +- .../src/_includes/get_started/windows/r/gpu.md | 7 ++--- docs/static_site/src/pages/api/julia/index.md | 5 ++-- .../src/pages/get_started/build_from_source.md | 20 ++++++++------ .../static_site/src/pages/get_started/osx_setup.md | 31 ++++++++++++++++------ .../src/pages/get_started/ubuntu_setup.md | 25 ++++++++--------- .../src/pages/get_started/windows_setup.md | 2 ++ 36 files changed, 100 insertions(+), 80 deletions(-) diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 867a56f..f63b241 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -252,6 +252,7 @@ List of Contributors * [Jonathan Tan](https://github.com/jonatan1626) * [Oliver Kowalke](https://github.com/olk) * [Connor Goggins](https://github.com/connorgoggins) +* [Wei Chu](https://github.com/waytrue17) * [Yang Shi](https://github.com/ys2843) Label Bot diff --git a/docs/static_site/src/_includes/get_started/get_started.html b/docs/static_site/src/_includes/get_started/get_started.html index da5975f..20e25eb 100644 --- a/docs/static_site/src/_includes/get_started/get_started.html +++ b/docs/static_site/src/_includes/get_started/get_started.html @@ -381,6 +381,10 @@ {% markdown %}{% include /get_started/windows/python/gpu/pip.md %}{% endmarkdown %} </div> <!-- End of pip --> + <div class="docker"> + {% markdown %}{% include /get_started/windows/python/gpu/docker.md %}{% endmarkdown %} + </div> <!-- End of docker --> + <div class="build-from-source"> {% markdown %}{% include /get_started/windows/python/gpu/build-from-source.md %}{% endmarkdown %} </div> <!-- End of build from source --> diff --git a/docs/static_site/src/_includes/get_started/linux/clojure/cpu.md b/docs/static_site/src/_includes/get_started/linux/clojure/cpu.md index c16eb9a..4675c17 100644 --- a/docs/static_site/src/_includes/get_started/linux/clojure/cpu.md +++ b/docs/static_site/src/_includes/get_started/linux/clojure/cpu.md @@ -1,7 +1,4 @@ -You can use the Maven packages defined in the following dependency to include MXNet in your Clojure -project. To maximize leverage, the Clojure package has been built on the existing Scala package. Please -refer to the [MXNet-Scala setup guide]({{'/get_started/scala_setup'|relative_url}}) for a detailed set of instructions -to help you with the setup process that is required to use the Clojure dependency. +Please refer to the [MXNet-Clojure setup guide](https://github.com/apache/incubator-mxnet/tree/master/contrib/clojure-package) for a detailed set of instructions to help you with the setup process that is required to use the Clojure dependency. <a href="https://mvnrepository.com/artifact/org.apache.mxnet.contrib.clojure/clojure-mxnet-linux-cpu"><img src="https://img.shields.io/badge/org.apache.mxnet-linux cpu-green.svg" @@ -9,7 +6,7 @@ to help you with the setup process that is required to use the Clojure dependenc {% highlight html %} <dependency> -<groupId>org.apache.mxnet.contrib.clojure</groupId> -<artifactId>clojure-mxnet-linux-cpu</artifactId> + <groupId>org.apache.mxnet.contrib.clojure</groupId> + <artifactId>clojure-mxnet-linux-cpu</artifactId> </dependency> -{% endhighlight %} +{% endhighlight %} \ No newline at end of file diff --git a/docs/static_site/src/_includes/get_started/linux/clojure/gpu.md b/docs/static_site/src/_includes/get_started/linux/clojure/gpu.md index 26293f6..78cbe68 100644 --- a/docs/static_site/src/_includes/get_started/linux/clojure/gpu.md +++ b/docs/static_site/src/_includes/get_started/linux/clojure/gpu.md @@ -1,7 +1,4 @@ -You can use the Maven packages defined in the following dependency to include MXNet in your Clojure -project. To maximize leverage, the Clojure package has been built on the existing Scala package. Please -refer to the [MXNet-Scala setup guide]({{'/get_started/scala_setup'|relative_url}}) for a detailed set of instructions -to help you with the setup process that is required to use the Clojure dependency. +Please refer to the [MXNet-Clojure setup guide](https://github.com/apache/incubator-mxnet/tree/master/contrib/clojure-package) for a detailed set of instructions to help you with the setup process that is required to use the Clojure dependency. <a href="https://mvnrepository.com/artifact/org.apache.mxnet.contrib.clojure/clojure-mxnet-linux-gpu"><img src="https://img.shields.io/badge/org.apache.mxnet-linux gpu-green.svg" diff --git a/docs/static_site/src/_includes/get_started/linux/java/cpu.md b/docs/static_site/src/_includes/get_started/linux/java/cpu.md index fc6f598..581a8fe 100644 --- a/docs/static_site/src/_includes/get_started/linux/java/cpu.md +++ b/docs/static_site/src/_includes/get_started/linux/java/cpu.md @@ -5,7 +5,7 @@ instructions to help you with the setup process. <a href="https://repository.apache.org/#nexus-search;gav~org.apache.mxnet~~1.5.0~~"> <img src="https://img.shields.io/badge/org.apache.mxnet-linux cpu-green.svg" - alt="maven badge"/> + alt="maven badge"/> </a> {% highlight html %} diff --git a/docs/static_site/src/_includes/get_started/linux/julia/build-from-source.md b/docs/static_site/src/_includes/get_started/linux/julia/build-from-source.md index 018aca9..6e89430 100644 --- a/docs/static_site/src/_includes/get_started/linux/julia/build-from-source.md +++ b/docs/static_site/src/_includes/get_started/linux/julia/build-from-source.md @@ -1,2 +1,2 @@ -Refer to the [Julia section of the MXNet Ubuntu installation guide](/get_started/ubuntu_setup#install-the-mxnet-package-for-julia). +Refer to the [Julia section of the MXNet Ubuntu installation guide](/get_started/ubuntu_setup.html#install-the-mxnet-package-for-julia). diff --git a/docs/static_site/src/_includes/get_started/linux/perl/perl.md b/docs/static_site/src/_includes/get_started/linux/perl/perl.md index 02d82e4..1b20674 100644 --- a/docs/static_site/src/_includes/get_started/linux/perl/perl.md +++ b/docs/static_site/src/_includes/get_started/linux/perl/perl.md @@ -1 +1 @@ -Refer to the [Perl section of the MXNet Ubuntu installation guide](get_started/ubuntu_setup.html#install-the-mxnet-package-for-perl). \ No newline at end of file +Refer to the [Perl section of the MXNet Ubuntu installation guide](/get_started/ubuntu_setup.html#install-the-mxnet-package-for-perl). \ No newline at end of file diff --git a/docs/static_site/src/_includes/get_started/linux/python/cpu/build-from-source.md b/docs/static_site/src/_includes/get_started/linux/python/cpu/build-from-source.md index 4adf039..73abb18 100644 --- a/docs/static_site/src/_includes/get_started/linux/python/cpu/build-from-source.md +++ b/docs/static_site/src/_includes/get_started/linux/python/cpu/build-from-source.md @@ -1 +1 @@ -To build from source, refer to the [MXNet Ubuntu installation guide]({{'/get_started/ubuntu_setup' | relative_url}}). +To build from source, refer to the [MXNet Ubuntu installation guide](/get_started/ubuntu_setup.html). diff --git a/docs/static_site/src/_includes/get_started/linux/python/cpu/docker.md b/docs/static_site/src/_includes/get_started/linux/python/cpu/docker.md index 8f2c8eb..52eeb22 100644 --- a/docs/static_site/src/_includes/get_started/linux/python/cpu/docker.md +++ b/docs/static_site/src/_includes/get_started/linux/python/cpu/docker.md @@ -40,4 +40,4 @@ REPOSITORY TAG IMAGE ID CREATED SIZE mxnet/python 1.3.0_cpu_mkl deaf9bf61d29 4 days ago 678 MB {% endhighlight %} -**Step 4** <a href="get_started/validate_mxnet">Validate the installation</a>. \ No newline at end of file +**Step 4** <a href="/get_started/validate_mxnet.html">Validate the installation</a>. \ No newline at end of file diff --git a/docs/static_site/src/_includes/get_started/linux/python/gpu/build-from-source.md b/docs/static_site/src/_includes/get_started/linux/python/gpu/build-from-source.md index 4adf039..73abb18 100644 --- a/docs/static_site/src/_includes/get_started/linux/python/gpu/build-from-source.md +++ b/docs/static_site/src/_includes/get_started/linux/python/gpu/build-from-source.md @@ -1 +1 @@ -To build from source, refer to the [MXNet Ubuntu installation guide]({{'/get_started/ubuntu_setup' | relative_url}}). +To build from source, refer to the [MXNet Ubuntu installation guide](/get_started/ubuntu_setup.html). diff --git a/docs/static_site/src/_includes/get_started/linux/python/gpu/docker.md b/docs/static_site/src/_includes/get_started/linux/python/gpu/docker.md index dc21cf1..a7d8c00 100644 --- a/docs/static_site/src/_includes/get_started/linux/python/gpu/docker.md +++ b/docs/static_site/src/_includes/get_started/linux/python/gpu/docker.md @@ -45,4 +45,4 @@ REPOSITORY TAG IMAGE ID CREATED SIZE mxnet/python 1.3.0_gpu_cu92_mkl adcb3ab19f50 4 days ago 4.23 GB {% endhighlight %} -**Step 5** <a href="get_started/validate_mxnet">Validate the installation</a>. \ No newline at end of file +**Step 5** <a href="/get_started/validate_mxnet">Validate the installation</a>. \ No newline at end of file diff --git a/docs/static_site/src/_includes/get_started/linux/r/gpu.md b/docs/static_site/src/_includes/get_started/linux/r/gpu.md index 1ef16df..f112da5 100644 --- a/docs/static_site/src/_includes/get_started/linux/r/gpu.md +++ b/docs/static_site/src/_includes/get_started/linux/r/gpu.md @@ -1,7 +1,5 @@ The default version of R that is installed with `apt-get` is insufficient. You will need -to first -[install R v3.4.4+ and build MXNet from -source](/get_started/ubuntu_setup.html#install-the-mxnet-package-for-r). +to first [install R v3.4.4+ and build MXNet from source](/get_started/ubuntu_setup.html#install-the-mxnet-package-for-r). After you have setup R v3.4.4+ and MXNet, you can build and install the MXNet R bindings with the diff --git a/docs/static_site/src/_includes/get_started/linux/scala/cpu.md b/docs/static_site/src/_includes/get_started/linux/scala/cpu.md index 3cc96ba..452b4d9 100644 --- a/docs/static_site/src/_includes/get_started/linux/scala/cpu.md +++ b/docs/static_site/src/_includes/get_started/linux/scala/cpu.md @@ -1,5 +1,5 @@ You can use the Maven packages defined in the following dependency to include MXNet in your Scala -project. Please refer to the [MXNet-Scala setup guide]({{'/get_started/scala_setup'|relative_url}}) for +project. Please refer to the [MXNet-Scala setup guide](/get_started/scala_setup.html) for a detailed set of instructions to help you with the setup process. <a href="https://mvnrepository.com/artifact/org.apache.mxnet/mxnet-full_2.11-linux-x86_64-cpu"><img @@ -8,7 +8,7 @@ a detailed set of instructions to help you with the setup process. {% highlight html %} <dependency> -<groupId>org.apache.mxnet</groupId> -<artifactId>mxnet-full_2.11-linux-x86_64-cpu</artifactId> + <groupId>org.apache.mxnet</groupId> + <artifactId>mxnet-full_2.11-linux-x86_64-cpu</artifactId> </dependency> {% endhighlight %} \ No newline at end of file diff --git a/docs/static_site/src/_includes/get_started/linux/scala/gpu.md b/docs/static_site/src/_includes/get_started/linux/scala/gpu.md index 5e2f9b1..4fcb8a7 100644 --- a/docs/static_site/src/_includes/get_started/linux/scala/gpu.md +++ b/docs/static_site/src/_includes/get_started/linux/scala/gpu.md @@ -1,6 +1,6 @@ You can use the Maven packages defined in the following dependency to include MXNet in your Scala -project. Please refer to the <a href="scala_setup.html">MXNet-Scala setup guide</a> for +project. Please refer to the <a href="/get_started/scala_setup.html">MXNet-Scala setup guide</a> for a detailed set of instructions to help you with the setup process. @@ -10,7 +10,7 @@ of instructions to help you with the setup process. {% highlight html %} <dependency> -<groupId>org.apache.mxnet</groupId> -<artifactId>mxnet-full_2.11-linux-x86_64-gpu</artifactId> + <groupId>org.apache.mxnet</groupId> + <artifactId>mxnet-full_2.11-linux-x86_64-gpu</artifactId> </dependency> {% endhighlight %} diff --git a/docs/static_site/src/_includes/get_started/macos/clojure/cpu.md b/docs/static_site/src/_includes/get_started/macos/clojure/cpu.md index 1e27af5..0eee5c8 100644 --- a/docs/static_site/src/_includes/get_started/macos/clojure/cpu.md +++ b/docs/static_site/src/_includes/get_started/macos/clojure/cpu.md @@ -1,8 +1,4 @@ - -You can use the Maven packages defined in the following dependency to include MXNet in -your Clojure project. To maximize leverage, the Clojure package has been built on the existing Scala -package. Please refer to the [MXNet-Scala setup guide](scala_setup.html) for a detailed set -of instructions to help you with the setup process that is required to use the Clojure dependency. +Please refer to the [MXNet-Clojure setup guide](https://github.com/apache/incubator-mxnet/tree/master/contrib/clojure-package) for a detailed set of instructions to help you with the setup process that is required to use the Clojure dependency. <a href="https://mvnrepository.com/artifact/org.apache.mxnet.contrib.clojure/clojure-mxnet-osx-cpu"><img src="https://img.shields.io/badge/org.apache.mxnet-mac cpu-green.svg" diff --git a/docs/static_site/src/_includes/get_started/macos/julia/build-from-source.md b/docs/static_site/src/_includes/get_started/macos/julia/build-from-source.md index b864d8a..d1b8b29 100644 --- a/docs/static_site/src/_includes/get_started/macos/julia/build-from-source.md +++ b/docs/static_site/src/_includes/get_started/macos/julia/build-from-source.md @@ -1 +1 @@ -Refer to the [Julia section of the MXNet macOS installation guide](get_started/osx_setup.html#install-the-mxnet-package-for-julia). \ No newline at end of file +Refer to the [Julia section of the MXNet macOS installation guide](/get_started/osx_setup.html#install-the-mxnet-package-for-julia). \ No newline at end of file diff --git a/docs/static_site/src/_includes/get_started/macos/perl/perl.md b/docs/static_site/src/_includes/get_started/macos/perl/perl.md index 45d59dd..e6ad608 100644 --- a/docs/static_site/src/_includes/get_started/macos/perl/perl.md +++ b/docs/static_site/src/_includes/get_started/macos/perl/perl.md @@ -1 +1 @@ -Refer to the [Perl section of installation guide](/get_started/osx_setup.html#install-the-mxnet-package-for-perl). \ No newline at end of file +Refer to the [Perl section of the MXNet macOS installation guide](/get_started/osx_setup.html#install-the-mxnet-package-for-perl). \ No newline at end of file diff --git a/docs/static_site/src/_includes/get_started/macos/python/cpu/build-from-source.md b/docs/static_site/src/_includes/get_started/macos/python/cpu/build-from-source.md index ee8e378..8b4ab13 100644 --- a/docs/static_site/src/_includes/get_started/macos/python/cpu/build-from-source.md +++ b/docs/static_site/src/_includes/get_started/macos/python/cpu/build-from-source.md @@ -1,2 +1,2 @@ To build from source, refer to the [MXNet macOS installation guide](/get_started/osx_setup.html). -MXNet developers should refer to the MXNet wiki's [Developer Setup on Mac](https://cwiki.apache.org/confluence/display/MXNET/MXNet+Developer+Setup+on+Mac). +MXNet developers should refer to the MXNet wiki's [Developer Setup on macOS](https://cwiki.apache.org/confluence/display/MXNET/MXNet+Developer+Setup+on+Mac). diff --git a/docs/static_site/src/_includes/get_started/macos/python/cpu/docker.md b/docs/static_site/src/_includes/get_started/macos/python/cpu/docker.md index c8631ec..56cde00 100644 --- a/docs/static_site/src/_includes/get_started/macos/python/cpu/docker.md +++ b/docs/static_site/src/_includes/get_started/macos/python/cpu/docker.md @@ -32,4 +32,4 @@ REPOSITORY TAG IMAGE ID CREATED SIZE mxnet/python 1.3.0_cpu_mkl deaf9bf61d29 4 days ago 678 MB {% endhighlight %} -**Step 4** <a href="get_started/validate_mxnet">Validate the installation</a>. \ No newline at end of file +**Step 4** <a href="/get_started/validate_mxnet.html">Validate the installation</a>. \ No newline at end of file diff --git a/docs/static_site/src/_includes/get_started/macos/python/gpu/build-from-source.md b/docs/static_site/src/_includes/get_started/macos/python/gpu/build-from-source.md index ffcf88e..95805e6 100644 --- a/docs/static_site/src/_includes/get_started/macos/python/gpu/build-from-source.md +++ b/docs/static_site/src/_includes/get_started/macos/python/gpu/build-from-source.md @@ -1,2 +1,2 @@ -Refer to the [MXNet macOS installation guide](get_started/osx_setup.html). -MXNet developers should refer to the MXNet wiki's [Developer Setup on Mac](https://cwiki.apache.org/confluence/display/MXNET/MXNet+Developer+Setup+on+Mac). \ No newline at end of file +Refer to the [MXNet macOS installation guide](/get_started/osx_setup.html). +MXNet developers should refer to the MXNet wiki's [Developer Setup on macOS](https://cwiki.apache.org/confluence/display/MXNET/MXNet+Developer+Setup+on+Mac). \ No newline at end of file diff --git a/docs/static_site/src/_includes/get_started/macos/python/gpu/pip_docker.md b/docs/static_site/src/_includes/get_started/macos/python/gpu/pip_docker.md index 87281fe..4d1261d 100644 --- a/docs/static_site/src/_includes/get_started/macos/python/gpu/pip_docker.md +++ b/docs/static_site/src/_includes/get_started/macos/python/gpu/pip_docker.md @@ -1 +1 @@ -This option is only available by building from source. Refer to the [MXNet macOS installation guide](get_started/osx_setup.html). \ No newline at end of file +This option is only available by building from source. Refer to the [MXNet macOS installation guide](/get_started/osx_setup.html). \ No newline at end of file diff --git a/docs/static_site/src/_includes/get_started/macos/r/cpu.md b/docs/static_site/src/_includes/get_started/macos/r/cpu.md index 1e0d96b..51a31eb 100644 --- a/docs/static_site/src/_includes/get_started/macos/r/cpu.md +++ b/docs/static_site/src/_includes/get_started/macos/r/cpu.md @@ -17,7 +17,7 @@ Note: packages for 3.6.x are not yet available. Install 3.5.x of R from [CRAN](https://cran.r-project.org/bin/macosx/). The latest is [v3.5.3](https://cran.r-project.org/bin/macosx/R-3.5.3.pkg). -You can [build MXNet-R from source](get_started/osx_setup.html#install-the-mxnet-package-for-r), or +You can [build MXNet-R from source](/get_started/osx_setup.html#install-the-mxnet-package-for-r), or you can use a pre-built binary: {% highlight r %} diff --git a/docs/static_site/src/_includes/get_started/macos/scala/cpu.md b/docs/static_site/src/_includes/get_started/macos/scala/cpu.md index 0bc69eb..dbb2a18 100644 --- a/docs/static_site/src/_includes/get_started/macos/scala/cpu.md +++ b/docs/static_site/src/_includes/get_started/macos/scala/cpu.md @@ -7,7 +7,7 @@ of instructions to help you with the setup process. alt="maven badge"/></a> {% highlight html %} - <dependency> +<dependency> <groupId>org.apache.mxnet</groupId> <artifactId>mxnet-full_2.11-osx-x86_64-cpu</artifactId> </dependency> diff --git a/docs/static_site/src/_includes/get_started/windows/perl/perl.md b/docs/static_site/src/_includes/get_started/windows/perl/perl.md index 1a8eea5..d639a10 100644 --- a/docs/static_site/src/_includes/get_started/windows/perl/perl.md +++ b/docs/static_site/src/_includes/get_started/windows/perl/perl.md @@ -1 +1 @@ -Refer to the [Perl section of the MXNet Windows installation guide](/get_started/windows_setup.html#install-the-mxnet-package-for-perl). \ No newline at end of file +MXNet Perl API for Windows is not yet available. \ No newline at end of file diff --git a/docs/static_site/src/_includes/get_started/windows/python/cpu/build-from-source.md b/docs/static_site/src/_includes/get_started/windows/python/cpu/build-from-source.md index af36205..1aff9b0 100644 --- a/docs/static_site/src/_includes/get_started/windows/python/cpu/build-from-source.md +++ b/docs/static_site/src/_includes/get_started/windows/python/cpu/build-from-source.md @@ -1 +1 @@ -Refer to the [MXNet Windows installation guide](/get_started/windows_setup.html) \ No newline at end of file +To build from source, refer to the [MXNet Windows installation guide](/get_started/windows_setup.html). \ No newline at end of file diff --git a/docs/static_site/src/_includes/get_started/windows/python/cpu/docker.md b/docs/static_site/src/_includes/get_started/windows/python/cpu/docker.md index a061b8b..d3868e5 100644 --- a/docs/static_site/src/_includes/get_started/windows/python/cpu/docker.md +++ b/docs/static_site/src/_includes/get_started/windows/python/cpu/docker.md @@ -31,4 +31,4 @@ REPOSITORY TAG IMAGE ID CREATED SIZE mxnet/python 1.3.0_cpu_mkl deaf9bf61d29 4 days ago 678 MB {% endhighlight %} -**Step 4** <a href="get_started/validate_mxnet">Validate the installation</a>. \ No newline at end of file +**Step 4** <a href="/get_started/validate_mxnet.html">Validate the installation</a>. \ No newline at end of file diff --git a/docs/static_site/src/_includes/get_started/windows/python/cpu/pip.md b/docs/static_site/src/_includes/get_started/windows/python/cpu/pip.md index 9e4d20d..60af550 100644 --- a/docs/static_site/src/_includes/get_started/windows/python/cpu/pip.md +++ b/docs/static_site/src/_includes/get_started/windows/python/cpu/pip.md @@ -1,4 +1,5 @@ -Run the following command: +<!-- Uncomment the following line when the newest version is released --> +<!-- Run the following command: --> <div class="v1-6-0"> diff --git a/docs/static_site/src/_includes/get_started/windows/python/gpu/docker.md b/docs/static_site/src/_includes/get_started/windows/python/gpu/docker.md new file mode 100644 index 0000000..9d75ae8 --- /dev/null +++ b/docs/static_site/src/_includes/get_started/windows/python/gpu/docker.md @@ -0,0 +1 @@ +Docker installation for Windows GPU is not yet available. \ No newline at end of file diff --git a/docs/static_site/src/_includes/get_started/windows/python/gpu/pip.md b/docs/static_site/src/_includes/get_started/windows/python/gpu/pip.md index 91533ba..4c095a2 100644 --- a/docs/static_site/src/_includes/get_started/windows/python/gpu/pip.md +++ b/docs/static_site/src/_includes/get_started/windows/python/gpu/pip.md @@ -1,4 +1,5 @@ -Run the following command: +<!-- Uncomment the following line when the newest version is released --> +<!-- Run the following command: --> <div class="v1-6-0"> diff --git a/docs/static_site/src/_includes/get_started/windows/r/cpu.md b/docs/static_site/src/_includes/get_started/windows/r/cpu.md index 926b835..3a45f18 100644 --- a/docs/static_site/src/_includes/get_started/windows/r/cpu.md +++ b/docs/static_site/src/_includes/get_started/windows/r/cpu.md @@ -1,7 +1,7 @@ Note: packages for 3.6.x are not yet available. Install 3.5.x of R from [CRAN](https://cran.r-project.org/bin/windows/base/old/). -You can [build MXNet-R from source](/get_started/windows_setup.html#install-mxnet-package-for-r), or +You can [build MXNet-R from source](/get_started/windows_setup.html#install-the-mxnet-package-for-r), or you can use a pre-built binary: diff --git a/docs/static_site/src/_includes/get_started/windows/r/gpu.md b/docs/static_site/src/_includes/get_started/windows/r/gpu.md index 084f1a5..52db31e 100644 --- a/docs/static_site/src/_includes/get_started/windows/r/gpu.md +++ b/docs/static_site/src/_includes/get_started/windows/r/gpu.md @@ -1,6 +1,7 @@ -You can [build MXNet-R from source](/get_started/windows_setup.html#install-mxnet-package-for-r), or -you can use a -pre-built binary: +Note: packages for 3.6.x are not yet available. +Install 3.5.x of R from [CRAN](https://cran.r-project.org/bin/windows/base/old/). + +You can [build MXNet-R from source](/get_started/windows_setup.html#install-the-mxnet-package-for-r), or you can use a pre-built binary: {% highlight r %} cran <- getOption("repos") diff --git a/docs/static_site/src/pages/api/julia/index.md b/docs/static_site/src/pages/api/julia/index.md index 52c1e25..1cd1400 100644 --- a/docs/static_site/src/pages/api/julia/index.md +++ b/docs/static_site/src/pages/api/julia/index.md @@ -35,5 +35,6 @@ computing and the state-of-art deep learning to Julia. and apply them to tasks such as image classification and data science challenges. ## Installation -* [Ubuntu installation guide]({{'/get_started/ubuntu_setup' | relative_url}}) -* Mac / Windows guides are not available (contributions welcome!) +* [Ubuntu installation guide]({{'/get_started/ubuntu_setup.html'|relative_url}}) +* [maxOS installation guide]({{'/get_started/osx_setup.html'|relative_url}}) +* [Windows installation guide]({{'/get_started/windows_setup.html'|relative_url}}) diff --git a/docs/static_site/src/pages/get_started/build_from_source.md b/docs/static_site/src/pages/get_started/build_from_source.md index ae391e4..1f24a27 100644 --- a/docs/static_site/src/pages/get_started/build_from_source.md +++ b/docs/static_site/src/pages/get_started/build_from_source.md @@ -27,7 +27,6 @@ permalink: /get_started/build_from_source This document explains how to build MXNet from source code. -**For Java/Scala/Clojure, please follow [this guide instead](scala_setup)** ## Overview @@ -36,6 +35,7 @@ Building from source follows this general two-step flow of building the shared l 1. Build the MXNet shared library, `libmxnet.so`. * [Clone the repository](#clone-the-mxnet-project) * [Prerequisites](#prerequisites) + * [Compiler requirement](#compiler-requirement) * [Math library selection](#math-library-selection) * [Install GPU software](#install-gpu-software) * [Install optional software](#install-optional-software) @@ -89,6 +89,9 @@ cd mxnet The following sections will help you decide which specific prerequisites you need to install. +#### Compiler Requirement +Building MXNet from source requires at least [gcc7](https://gcc.gnu.org/), clang6 or any C++17 compatible compiler + #### Math Library Selection It is useful to consider your math library selection prior to your other prerequisites. MXNet relies on the @@ -109,18 +112,18 @@ The following lists show this order by library and `cmake` switch. For desktop platforms (x86_64): -1. MKL-DNN (submodule) | `USE_MKLDNN` -2. MKL | `USE_MKL_IF_AVAILABLE` -3. MKLML (downloaded) | `USE_MKLML` -4. Apple Accelerate | `USE_APPLE_ACCELERATE_IF_AVAILABLE` | Mac only -5. OpenBLAS | `BLAS` | Options: Atlas, Open, MKL, Apple +1. MKL-DNN (submodule), `USE_MKLDNN` +2. MKL, `USE_MKL_IF_AVAILABLE` +3. MKLML (downloaded), `USE_MKLML` +4. Apple Accelerate (Mac only), `USE_APPLE_ACCELERATE_IF_AVAILABLE` +5. OpenBLAS, `BLAS` Note: If `USE_MKL_IF_AVAILABLE` is set to False then MKLML and MKL-DNN will be disabled as well for configuration backwards compatibility. For embedded platforms (all other and if cross compiled): -1. OpenBLAS | `BLAS` | Options: Atlas, Open, MKL, Apple +1. OpenBLAS, `BLAS` You can set the BLAS library explicitly by setting the BLAS variable to: @@ -170,6 +173,7 @@ unpredictable. If you want to run MXNet with GPUs, you must install [NVDIA CUDA and cuDNN](https://developer.nvidia.com/cuda-downloads). +After installation, run nvidia-smi to verify cuda is available on your machine. #### Install Optional Software @@ -314,7 +318,7 @@ ninja -v ## Installing MXNet Language Bindings After building MXNet's shared library, you can install other language bindings. -**NOTE:** The C++ API binding must be built when you build MXNet from source. See [Build MXNet with C++]({{'/api/cpp'|relative_url}}). +**NOTE:** The C++ API binding must be built when you build MXNet from source. See [Build MXNet with C++]({{'/api/cpp.html'|relative_url}}). The following table provides links to each language binding by operating system: diff --git a/docs/static_site/src/pages/get_started/osx_setup.md b/docs/static_site/src/pages/get_started/osx_setup.md index b71f7bc..f8618d5 100644 --- a/docs/static_site/src/pages/get_started/osx_setup.md +++ b/docs/static_site/src/pages/get_started/osx_setup.md @@ -26,10 +26,10 @@ permalink: /get_started/osx_setup The following installation instructions are for building MXNet from source. For instructions to build MXNet from source on other platforms, see the general -[Build From Source guide](build_from_source). +[Build From Source guide](build_from_source.html). Instead of building from source, you can install a binary version of MXNet. For -that, please follow the information at [Get Started](get_started). +that, please follow the information at [Get Started](/get_started). Building MXNet from source is a two-step process: @@ -61,6 +61,8 @@ not support macOS. ## Build the MXNet shared library from source +**Note**: Building MXNet from source requires at least [gcc7](https://gcc.gnu.org/), clang6 or any C++17 compatible compiler. + On OS X, you need the following dependencies: **Step 1:** Install prerequisite packages. @@ -97,13 +99,13 @@ build without Cuda, change `set(USE_CUDA ON CACHE TYPE "Build with CUDA support")` to `set(USE_CUDA OFF CACHE TYPE "Build with CUDA support")`. For a GPU-enabled build make sure you have installed the [CUDA dependencies -first](#cuda-dependencies)). When building a GPU-enabled build on a machine +first](#cuda-dependencies). When building a GPU-enabled build on a machine without GPU, MXNet build can't autodetect your GPU architecture and will target all available GPU architectures. Please set the `MXNET_CUDA_ARCH` variable in `config.cmake` to your desired cuda architecture to speed up the build. To (optionally) build with MKL math library, please install MKL first based on -the guide in [Math Library Selection](build_from_source#math-library-selection). +the guide in [Math Library Selection](build_from_source.html#math-library-selection). **Step 3:** Build MXNet core shared library. @@ -159,7 +161,7 @@ package installed. ### Install the MXNet Package for C++ -Refer to the [C++ Package setup guide](c_plus_plus). +Refer to the [C++ Package setup guide](cpp_setup.html). <hr> @@ -202,16 +204,16 @@ You might want to add this command to your ```~/.bashrc``` file. If you do, you Pkg.add("MXNet") ``` -For more details about installing and using MXNet with Julia, see the [MXNet Julia documentation]({{'/api/julia'|relative_url}}). +For more details about installing and using MXNet with Julia, see the [MXNet Julia documentation](/api/julia.html). ### Install the MXNet Package for Scala To use the MXNet-Scala package, you can acquire the Maven package as a dependency. -Further information is in the [MXNet-Scala Setup Instructions](scala_setup). +Further information is in the [MXNet-Scala Setup Instructions](scala_setup.html). -If you use IntelliJ or a similar IDE, you may want to follow the [MXNet-Scala on IntelliJ tutorial]({{'/api/scala/docs/tutorials/mxnet_scala_on_intellij'|relative_url}}) instead. +If you use IntelliJ or a similar IDE, you may want to follow the [MXNet-Scala on IntelliJ tutorial](/api/scala/docs/tutorials/mxnet_scala_on_intellij.html) instead. ### Install the MXNet Package for Perl @@ -247,6 +249,19 @@ After you build the shared library, run the following command from the MXNet sou make install ``` +### Install the MXNet Package for Java + +**Note:** If you use IntelliJ or a similar IDE, you may want to follow the [MXNet-Java on IntelliJ tutorial](/api/java/docs/tutorials/mxnet_java_on_intellij.html) instead of these instructions. + +To install Maven, please refer to [Maven setup guide](java_setup.html). After Maven is setup, you may simply run the following from the MXNet scala-package folder: + +```bash +mvn install +``` + +This will install both the Java Inference API and the required MXNet-Scala package. +<hr> + ## Contributions You are more than welcome to contribute easy installation scripts for other operating systems and programming languages. diff --git a/docs/static_site/src/pages/get_started/ubuntu_setup.md b/docs/static_site/src/pages/get_started/ubuntu_setup.md index ee4fd27..541ece4 100644 --- a/docs/static_site/src/pages/get_started/ubuntu_setup.md +++ b/docs/static_site/src/pages/get_started/ubuntu_setup.md @@ -26,11 +26,10 @@ permalink: /get_started/ubuntu_setup The following installation instructions are for building MXNet from source on computers running **Ubuntu 16.04** or higher. For instructions to build MXNet -from source on other platforms, see the general [Build From Source -guide](build_from_source). +from source on other platforms, see the general [Build From Source guide](build_from_source.html). Instead of building from source, you can install a binary version of MXNet. For -that, please follow the information at [Get Started](get_started). +that, please follow the information at [Get Started](/get_started). Building MXNet from source is a two-step process: @@ -74,7 +73,9 @@ sudo ldconfig ## Build the MXNet shared library from source -It is recommended that you review the general [build from source](build_from_source) instructions before continuing. +It is recommended that you review the general [build from source](build_from_source.html) instructions before continuing. + +**Note**: Building MXNet from source requires at least [gcc7](https://gcc.gnu.org/), clang6 or any C++17 compatible compiler. On Ubuntu versions 16.04 or later, you need the following dependencies: @@ -117,13 +118,13 @@ series of `set(name value CACHE TYPE "Description")` entries. You can change the values of the respective `value`. For a GPU-enabled build make sure you have installed the [CUDA dependencies -first](#cuda-dependencies)). When building a GPU-enabled build on a machine +first](#cuda-dependencies). When building a GPU-enabled build on a machine without GPU, MXNet build can't autodetect your GPU architecture and will target all available GPU architectures. Please set the `MXNET_CUDA_ARCH` variable in `config.cmake` to your desired cuda architecture to speed up the build. To (optionally) build with MKL math library, please install MKL first based on -the guide in [Math Library Selection](build_from_source#math-library-selection). +the guide in [Math Library Selection](build_from_source.html#math-library-selection). **Step 3:** Build MXNet core shared library. @@ -189,7 +190,7 @@ pip install --user graphviz==0.8.4 jupyter ### Install the MXNet Package for C++ -Refer to the [C++ Package setup guide](c_plus_plus). +Refer to the [C++ Package setup guide](cpp_setup.html). <hr> @@ -300,7 +301,7 @@ julia --color=yes --project=./ -e \ ``` For more details about installing and using MXNet with Julia, see the -[MXNet Julia documentation]({{'/api/julia'|relative_url}}). +[MXNet Julia documentation](/api/julia.html). <hr> @@ -409,20 +410,20 @@ You should see the following output: To use the MXNet-Scala package, you can acquire the Maven package as a dependency. -Further information is in the [MXNet-Scala Setup Instructions](scala_setup). +Further information is in the [MXNet-Scala Setup Instructions](scala_setup.html). If you use IntelliJ or a similar IDE, you may want to follow the -[MXNet-Scala on IntelliJ tutorial]({{'/api/scala/docs/tutorials/mxnet_scala_on_intellij'|relative_url}}) instead. +[MXNet-Scala on IntelliJ tutorial](/api/scala/docs/tutorials/mxnet_scala_on_intellij.html) instead. <hr> ### Install the MXNet Package for Java To use the MXNet-Java package, you can acquire the Maven package as a dependency. -Further information is in the [MXNet-Java Setup Instructions](java_setup). +Further information is in the [MXNet-Java Setup Instructions](java_setup.html). If you use IntelliJ or a similar IDE, you may want to follow the -[MXNet-Java on IntelliJ tutorial]({{'/api/java/docs/tutorials/mxnet_java_on_intellij'|relative_url}}) instead. +[MXNet-Java on IntelliJ tutorial](/api/java/docs/tutorials/mxnet_java_on_intellij.html) instead. <hr> ## Contributions diff --git a/docs/static_site/src/pages/get_started/windows_setup.md b/docs/static_site/src/pages/get_started/windows_setup.md index b008a8e..3eb99c3 100644 --- a/docs/static_site/src/pages/get_started/windows_setup.md +++ b/docs/static_site/src/pages/get_started/windows_setup.md @@ -139,6 +139,8 @@ Check the chart below for other options or refer to [PyPI for other MXNet pip pa **IMPORTANT: It is recommended that you review the [build from source guide](build_from_source) first.** It describes many of the build options that come with MXNet in more detail. You may decide to install additional dependencies and modify your build flags after reviewing this material. +**Note**: Building MXNet from source requires at least [gcc7](https://gcc.gnu.org/), clang6 or any C++17 compatible compiler. + We provide two primary options to build and install MXNet yourself using [Microsoft Visual Studio 2017](https://www.visualstudio.com/downloads/) or [Microsoft Visual Studio 2015](https://www.visualstudio.com/vs/older-downloads/). **NOTE:** Visual Studio 2017's compiler is `vc15`. This is not to be confused with Visual Studio 2015's compiler, `vc14`.