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

Commit

Permalink
Consolidate installation instructions on website and add disclaimer f…
Browse files Browse the repository at this point in the history
…or non-ASF ressources (#18487)

* Update website with disclaimer for non-ASF ressources

* Integrate Windows instructions to build_from_source.md

* Remove master version from selector

* Update Download links

* Update get_started/download.md per Release Download Page policy
  • Loading branch information
leezu committed Jun 10, 2020
1 parent cf3984b commit b6b4087
Show file tree
Hide file tree
Showing 71 changed files with 493 additions and 2,434 deletions.
2 changes: 1 addition & 1 deletion contrib/clojure-package/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Currently there are no pre-built jars available. jars that were previously avail

### Building MXNet and the Clojure package from source

The first step is to download the latest version from [the Apache release page](https://downloads.apache.org/incubator/mxnet/).
The first step is to download the latest version from the [Download page](https://mxnet.apache.org/get_started/download).

#### Building the core library

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Alternatively, you can also directly install MXNet v1.6 wheel with Jetson suppor

*WARNING: this MXNet wheel is provided for your convenience but it contains packages that are not provided nor endorsed by the Apache Software Foundation.
As such, they might contain software components with more restrictive licenses than the Apache License and you'll need to decide whether they are appropriate for your usage. Like all Apache Releases, the
official Apache MXNet (incubating) releases consist of source code only and are found at https://downloads.apache.org/incubator/mxnet .*
official Apache MXNet (incubating) releases consist of source code only and are found at https://mxnet.apache.org/get_started/download .*

We start by installing MXNet dependencies
```bash
Expand Down Expand Up @@ -114,4 +114,4 @@ With prob = 0.28096, it contains n02119022 red fox, Vulpes vulpes
With prob = 0.06857, it contains n02124075 Egyptian cat
With prob = 0.03046, it contains n02120505 grey fox, gray fox, Urocyon cinereoargenteus
With prob = 0.02770, it contains n02441942 weasel
```
```
16 changes: 12 additions & 4 deletions docs/static_site/src/_includes/get_started/cloud/cpu.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
MXNet should work on any cloud provider's CPU-only instances. Follow the Python pip install
instructions,
Docker instructions, or try the following preinstalled option.
MXNet should work on any cloud provider's CPU-only instances. Follow the Python
pip install instructions, Docker instructions, or try the following preinstalled
option.

WARNING: the following cloud provider packages are provided for your convenience
but they point to packages that are *not* provided nor endorsed by the Apache
Software Foundation. As such, they might contain software components with more
restrictive licenses than the Apache License and you'll need to decide whether
they are appropriate for your usage. Like all Apache Releases, the official
Apache MXNet (incubating) releases consist of source code only and are found at
the [Download page](https://mxnet.apache.org/get_started/download).

* **Amazon Web Services**
- [AWS Deep Learning AMI](https://aws.amazon.com/machine-learning/amis/) - Preinstalled
Conda environments
for Python 2 or 3 with MXNet and MKL-DNN.
for Python 2 or 3 with MXNet and MKL-DNN.
17 changes: 12 additions & 5 deletions docs/static_site/src/_includes/get_started/cloud/gpu.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
MXNet is available on several cloud providers with GPU support. You can also find
GPU/CPU-hybrid support for
use cases like scalable inference, or even fractional GPU support with AWS Elastic
Inference.
MXNet is available on several cloud providers with GPU support. You can also
find GPU/CPU-hybrid support for use cases like scalable inference, or even
fractional GPU support with AWS Elastic Inference.

WARNING: the following cloud provider packages are provided for your convenience
but they point to packages that are *not* provided nor endorsed by the Apache
Software Foundation. As such, they might contain software components with more
restrictive licenses than the Apache License and you'll need to decide whether
they are appropriate for your usage. Like all Apache Releases, the official
Apache MXNet (incubating) releases consist of source code only and are found at
the [Download page](https://mxnet.apache.org/get_started/download).

* **Alibaba**
- [NVIDIA
Expand Down Expand Up @@ -29,4 +36,4 @@ All NVIDIA VMs use the [NVIDIA MXNet Docker
container](https://ngc.nvidia.com/catalog/containers/nvidia:mxnet).
Follow the [container usage
instructions](https://ngc.nvidia.com/catalog/containers/nvidia:mxnet) found in
[NVIDIA's container repository](https://ngc.nvidia.com/).
[NVIDIA's container repository](https://ngc.nvidia.com/).
253 changes: 99 additions & 154 deletions docs/static_site/src/_includes/get_started/get_started.html

Large diffs are not rendered by default.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
To use the C++ package, build from source the `USE_CPP_PACKAGE=1` option. Please
refer to the build from source instructions linked above.
4 changes: 0 additions & 4 deletions docs/static_site/src/_includes/get_started/linux/cpp/cpp.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Previously available binaries distributed via Maven have been removed as they
redistributed Category-X binaries in violation of Apache Software Foundation
(ASF) policies.

At this point in time, no third-party binary Java packages are available. Please
follow the build from source instructions linked above.
6 changes: 0 additions & 6 deletions docs/static_site/src/_includes/get_started/linux/java/gpu.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
Refer to the [Julia section of the MXNet Ubuntu installation guide](/get_started/ubuntu_setup.html#install-the-mxnet-package-for-julia).

Please follow the build from source instructions linked above.
10 changes: 0 additions & 10 deletions docs/static_site/src/_includes/get_started/linux/julia/pkg.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Please follow the build from source instructions linked above.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
To build from source, refer to the [MXNet Ubuntu installation guide](/get_started/ubuntu_setup.html).
Please follow the build from source instructions linked above.
Original file line number Diff line number Diff line change
@@ -1,22 +1,18 @@
Docker images with *MXNet* are available at [DockerHub](https://hub.docker.com/r/mxnet/).

**Step 1** Install Docker on your machine by following the [docker installation
instructions](https://docs.docker.com/engine/installation/linux/ubuntu/#install-using-the-repository).

*Note* - You can install Community Edition (CE) to get started with *MXNet*.

**Step 2** [Optional] Post installation steps to manage Docker as a non-root user.
WARNING: the following links and names of binary distributions are provided for
your convenience but they point to packages that are *not* provided nor endorsed
by the Apache Software Foundation. As such, they might contain software
components with more restrictive licenses than the Apache License and you'll
need to decide whether they are appropriate for your usage. Like all Apache
Releases, the official Apache MXNet (incubating) releases consist of source code
only and are found at
the [Download page](https://mxnet.apache.org/get_started/download).


Follow the four steps in this [docker
documentation](https://docs.docker.com/engine/installation/linux/linux-postinstall/#manage-docker-as-a-non-root-user)
to allow managing docker containers without *sudo*.

If you skip this step, you need to use *sudo* each time you invoke Docker.

**Step 3** Pull the MXNet docker image.
Docker images with *MXNet* are available at [DockerHub](https://hub.docker.com/r/mxnet/).
After you installed Docker on your machine, you can use them via:

{% highlight bash %}
$ docker pull mxnet/python # Use sudo if you skip Step 2
$ docker pull mxnet/python
{% endhighlight %}

You can list docker images to see if mxnet/python docker image pull was successful.
Expand All @@ -28,16 +24,4 @@ REPOSITORY TAG IMAGE ID CREATED SIZE
mxnet/python latest 00d026968b3c 3 weeks ago 1.41 GB
{% endhighlight %}

Using the latest MXNet with [Intel MKL-DNN](https://github.com/intel/mkl-dnn) is
recommended for the
fastest inference speeds with MXNet.

{% highlight bash %}
$ docker pull mxnet/python:1.3.0_cpu_mkl # Use sudo if you skip Step 2
$ docker images # Use sudo if you skip Step 2

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.html">Validate the installation</a>.
You can then <a href="/get_started/validate_mxnet.html">validate the installation</a>.
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
WARNING: the following PyPI package names are provided for your convenience but
they point to packages that are *not* provided nor endorsed by the Apache
Software Foundation. As such, they might contain software components with more
restrictive licenses than the Apache License and you'll need to decide whether
they are appropriate for your usage. Like all Apache Releases, the official
Apache MXNet (incubating) releases consist of source code only and are found at
the [Download page](https://mxnet.apache.org/get_started/download).

Run the following command:

<div class="v1-6-0">
Expand Down Expand Up @@ -115,13 +123,6 @@ pip install mxnet==0.11.0

</div> <!-- End of v0-11-0-->

<div class="master">

{% highlight bash %}
pip install --pre mxnet -f https://dist.mxnet.io/python/all
{% endhighlight %}

</div> <!-- End of master-->
<br>


Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
To build from source, refer to the [MXNet Ubuntu installation guide](/get_started/ubuntu_setup.html).
Please follow the build from source instructions linked above.
Original file line number Diff line number Diff line change
@@ -1,24 +1,19 @@
Docker images with *MXNet* are available at [DockerHub](https://hub.docker.com/r/mxnet/).

**Step 1** Install Docker on your machine by following the [docker installation
instructions](https://docs.docker.com/engine/installation/linux/ubuntu/#install-using-the-repository).

*Note* - You can install Community Edition (CE) to get started with *MXNet*.

**Step 2** [Optional] Post installation steps to manage Docker as a non-root user.
WARNING: the following links and names of binary distributions are provided for
your convenience but they point to packages that are *not* provided nor endorsed
by the Apache Software Foundation. As such, they might contain software
components with more restrictive licenses than the Apache License and you'll
need to decide whether they are appropriate for your usage. Like all Apache
Releases, the official Apache MXNet (incubating) releases consist of source code
only and are found at
the [Download page](https://mxnet.apache.org/get_started/download).

Follow the four steps in this [docker
documentation](https://docs.docker.com/engine/installation/linux/linux-postinstall/#manage-docker-as-a-non-root-user)
to allow managing docker containers without *sudo*.

If you skip this step, you need to use *sudo* each time you invoke Docker.
Docker images with *MXNet* are available at [DockerHub](https://hub.docker.com/r/mxnet/).

**Step 3** Install *nvidia-docker-plugin* following the [installation
instructions](https://github.com/NVIDIA/nvidia-docker/wiki). *nvidia-docker-plugin*
is required to
enable the usage of GPUs from the docker containers.
Please follow the [NVidia Docker installation
instructions](https://github.com/NVIDIA/nvidia-docker/wiki) to enable the usage
of GPUs from the docker containers.

**Step 4** Pull the MXNet docker image.
After you installed Docker on your machine, you can use them via:

{% highlight bash %}
$ docker pull mxnet/python:gpu # Use sudo if you skip Step 2
Expand All @@ -33,16 +28,4 @@ REPOSITORY TAG IMAGE ID CREATED SIZE
mxnet/python gpu 493b2683c269 3 weeks ago 4.77 GB
{% endhighlight %}

Using the latest MXNet with [Intel MKL-DNN](https://github.com/intel/mkl-dnn) is
recommended for the
fastest inference speeds with MXNet.

{% highlight bash %}
$ docker pull mxnet/python:1.3.0_cpu_mkl # Use sudo if you skip Step 2
$ docker images # Use sudo if you skip Step 2

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>.
You can then <a href="/get_started/validate_mxnet.html">validate the installation</a>.
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
WARNING: the following PyPI package names are provided for your convenience but
they point to packages that are *not* provided nor endorsed by the Apache
Software Foundation. As such, they might contain software components with more
restrictive licenses than the Apache License and you'll need to decide whether
they are appropriate for your usage. Like all Apache Releases, the official
Apache MXNet (incubating) releases consist of source code only and are found at
the [Download page](https://mxnet.apache.org/get_started/download).

Run the following command:

<div class="v1-6-0">
Expand Down Expand Up @@ -67,14 +75,6 @@ $ pip install mxnet-cu80==0.11.0

</div> <!-- End of v0-11-0-->

<div class="master">

{% highlight bash %}
$ pip install --pre mxnet-cu102 -f https://dist.mxnet.io/python/all
{% endhighlight %}

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

<br>

{% include /get_started/pip_snippet.md %}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
You will need to R v3.4.4+ and build MXNet from source. Please follow the
instructions linked above.
10 changes: 0 additions & 10 deletions docs/static_site/src/_includes/get_started/linux/r/cpu.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/static_site/src/_includes/get_started/linux/r/gpu.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/static_site/src/_includes/get_started/linux/scala/cpu.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/static_site/src/_includes/get_started/linux/scala/gpu.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/static_site/src/_includes/get_started/macos
13 changes: 0 additions & 13 deletions docs/static_site/src/_includes/get_started/macos/clojure/cpu.md

This file was deleted.

This file was deleted.

3 changes: 0 additions & 3 deletions docs/static_site/src/_includes/get_started/macos/cpp/cpp.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/static_site/src/_includes/get_started/macos/java/cpu.md

This file was deleted.

This file was deleted.

This file was deleted.

10 changes: 0 additions & 10 deletions docs/static_site/src/_includes/get_started/macos/julia/pkg.md

This file was deleted.

This file was deleted.

This file was deleted.

Loading

0 comments on commit b6b4087

Please sign in to comment.