Skip to content

Commit

Permalink
[Doc] Fix link to backends docs (dmlc#1376)
Browse files Browse the repository at this point in the history
Co-authored-by: Tong He <[email protected]>
  • Loading branch information
adamjstewart and hetong007 authored Mar 25, 2020
1 parent b9c65e9 commit 08fcda3
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
4 changes: 3 additions & 1 deletion docs/source/install/backend.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _backends:

Working with different backends
===============================

Expand All @@ -22,7 +24,7 @@ size smaller than 2^32. To enable large graph training, *build* MXNet with ``USE
flag. See `this FAQ <https://mxnet.apache.org/api/faq/large_tensor_support>`_ for more information.

MXNet 1.5 and later has an option to enable Numpy shape mode for ``NDArray`` objects, some DGL models
need this mode to be enabled to run correctly. However, this mode may not compatible with pretrained
need this mode to be enabled to run correctly. However, this mode may not compatible with pretrained
model parameters with this mode disabled, e.g. pretrained models from GluonCV and GluonNLP.
By setting ``DGL_MXNET_SET_NP_SHAPE``, users can switch this mode on or off.

Expand Down
7 changes: 3 additions & 4 deletions docs/source/install/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ DGL works with the following operating systems:
DGL requires Python version 3.5 or later. Python 3.4 or earlier is not
tested. Python 2 support is coming.

DGL supports multiple tensor libraries as backends, e.g., PyTorch, MXNet. For requirements on backends and how to select one, see
`Working with different backends`_.
DGL supports multiple tensor libraries as backends, e.g., PyTorch, MXNet. For requirements on backends and how to select one, see :ref:`backends`.

Starting at version 0.3, DGL is separated into CPU and CUDA builds. The builds share the
same Python package name. If you install DGL with a CUDA 9 build after you install the
Expand Down Expand Up @@ -46,15 +45,15 @@ For CPU builds, run the following command to install with ``pip``.
.. code:: bash
pip install dgl
For CUDA builds, run one of the following commands and specify the CUDA version.

.. code:: bash
pip install dgl # For CPU Build
pip install dgl-cu90 # For CUDA 9.0 Build
pip install dgl-cu92 # For CUDA 9.2 Build
pip install dgl-cu100 # For CUDA 10.0 Build
pip install dgl-cu100 # For CUDA 10.0 Build
pip install dgl-cu101 # For CUDA 10.1 Build
For the most current nightly build from master branch, run one of the following commands.
Expand Down

0 comments on commit 08fcda3

Please sign in to comment.