From ef444793db5b43eaa2926f282647a67828ffc9fd Mon Sep 17 00:00:00 2001 From: Talia Chopra Date: Fri, 18 Oct 2019 12:37:38 -0700 Subject: [PATCH 1/2] checking broken link fixes work --- docs/python_docs/python/tutorials/deploy/export/onnx.md | 2 +- .../tutorials/performance/backend/mkldnn/mkldnn_readme.md | 2 +- docs/python_docs/themes/mx-theme/mxtheme/footer.html | 2 +- docs/static_site/src/_includes/get_started/linux/cpp/cpp.md | 2 +- docs/static_site/src/_includes/get_started/macos/cpp/cpp.md | 2 +- docs/static_site/src/_includes/get_started/macos/scala/cpu.md | 2 +- docs/static_site/src/_includes/get_started/windows/cpp/cpp.md | 4 ++-- docs/static_site/src/pages/api/faq/env_var.md | 2 +- docs/static_site/src/pages/features.html | 2 +- docs/static_site/src/pages/get_started/windows_setup.md | 4 ++-- example/gluon/word_language_model/README.md | 2 +- python/mxnet/gluon/block.py | 4 ++-- python/mxnet/gluon/contrib/data/text.py | 4 ++-- python/mxnet/gluon/trainer.py | 2 +- 14 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/python_docs/python/tutorials/deploy/export/onnx.md b/docs/python_docs/python/tutorials/deploy/export/onnx.md index 0b325cb0ba9a..274d74824eb9 100644 --- a/docs/python_docs/python/tutorials/deploy/export/onnx.md +++ b/docs/python_docs/python/tutorials/deploy/export/onnx.md @@ -44,7 +44,7 @@ logging.basicConfig(level=logging.INFO) ## Downloading a model from the MXNet model zoo -We download the pre-trained ResNet-18 [ImageNet](http://www.image-net.org/) model from the [MXNet Model Zoo](http://data.mxnet.io/models/imagenet/). +We download the pre-trained ResNet-18 [ImageNet](http://www.image-net.org/) model from the [MXNet Model Zoo](/api/python/docs/api/gluon/model_zoo/index.html). We will also download synset file to match labels. ```python diff --git a/docs/python_docs/python/tutorials/performance/backend/mkldnn/mkldnn_readme.md b/docs/python_docs/python/tutorials/performance/backend/mkldnn/mkldnn_readme.md index 65973fc0db43..7c19fbb97931 100644 --- a/docs/python_docs/python/tutorials/performance/backend/mkldnn/mkldnn_readme.md +++ b/docs/python_docs/python/tutorials/performance/backend/mkldnn/mkldnn_readme.md @@ -20,7 +20,7 @@ A better training and inference performance is expected to be achieved on Intel-Architecture CPUs with MXNet built with [Intel MKL-DNN](https://github.com/intel/mkl-dnn) on multiple operating system, including Linux, Windows and MacOS. In the following sections, you will find build instructions for MXNet with Intel MKL-DNN on Linux, MacOS and Windows. -Please find MKL-DNN optimized operators and other features in the [MKL-DNN operator list](../mkldnn/operator_list.md). +Please find MKL-DNN optimized operators and other features in the [MKL-DNN operator list](https://github.com/apache/incubator-mxnet/blob/v1.5.x/docs/tutorials/mkldnn/operator_list.md). The detailed performance data collected on Intel Xeon CPU with MXNet built with Intel MKL-DNN can be found [here](https://mxnet.apache.org/api/faq/perf#intel-cpu). diff --git a/docs/python_docs/themes/mx-theme/mxtheme/footer.html b/docs/python_docs/themes/mx-theme/mxtheme/footer.html index 4926f4fcb5d3..4e9d16ce305e 100644 --- a/docs/python_docs/themes/mx-theme/mxtheme/footer.html +++ b/docs/python_docs/themes/mx-theme/mxtheme/footer.html @@ -10,7 +10,7 @@

Resources

  • Jira Tracker
  • Github Roadmap
  • MXNet Discuss forum
    • -
  • Contribute To MXNet
    • +
  • Contribute To MXNet
    • diff --git a/docs/static_site/src/_includes/get_started/linux/cpp/cpp.md b/docs/static_site/src/_includes/get_started/linux/cpp/cpp.md index 376dd13424aa..dc492d801262 100644 --- a/docs/static_site/src/_includes/get_started/linux/cpp/cpp.md +++ b/docs/static_site/src/_includes/get_started/linux/cpp/cpp.md @@ -1,4 +1,4 @@ To enable the C++ package, build from source using `make USE_CPP_PACKAGE=1`. -Refer to the [MXNet C++ setup guide](get_started/c_plus_plus) +Refer to the [MXNet C++ setup guide](/get_started/cpp_setup.html) for full instructions. \ No newline at end of file diff --git a/docs/static_site/src/_includes/get_started/macos/cpp/cpp.md b/docs/static_site/src/_includes/get_started/macos/cpp/cpp.md index bb06cb617773..cb9e613928d9 100644 --- a/docs/static_site/src/_includes/get_started/macos/cpp/cpp.md +++ b/docs/static_site/src/_includes/get_started/macos/cpp/cpp.md @@ -1,3 +1,3 @@ To enable the C++ package, build from source using `make USE_CPP_PACKAGE=1`. -Refer to the [MXNet C++ setup guide](get_started/c_plus_plus) for full instructions. +Refer to the [MXNet C++ setup guide](/get_started/cpp_setup.html) for full instructions. \ No newline at end of file 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 623a8a56fb4d..0bc69eb2e63e 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 @@ -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](scala_setup.html) for a detailed set +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. Hybrid Front-End

    The Gluon Python API lets you use MXNet in a fully imperative manner. It also allows you to simply switch to symbolic mode by calling the hybridize + href="/api/python/docs/tutorials/packages/gluon/blocks/hybridize.html">hybridize functionality. The symbolic execution provides faster and more optimized execution as well as the ability to export the network for inference in different language bindings like java or C++. 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 2fe2123d2e1c..559c7e4fa989 100644 --- a/docs/static_site/src/pages/get_started/windows_setup.md +++ b/docs/static_site/src/pages/get_started/windows_setup.md @@ -74,7 +74,7 @@ Install MXNet with CPU support with Python: pip install mxnet ``` -Now [validate your MXNet installation with Python](get_started/validate_mxnet). +Now [validate your MXNet installation with Python](/get_started/validate_mxnet). ### Install with Intel CPUs @@ -88,7 +88,7 @@ The following steps will setup MXNet with MKL. MKL-DNN can be enabled only when pip install mxnet-mkl ``` -Now [validate your MXNet installation with Python](validate_mxnet). +Now [validate your MXNet installation with Python](/get_started/validate_mxnet). ### Install with NVIDIA GPUs diff --git a/example/gluon/word_language_model/README.md b/example/gluon/word_language_model/README.md index 04a4a4ac70b8..b2516a46b39a 100644 --- a/example/gluon/word_language_model/README.md +++ b/example/gluon/word_language_model/README.md @@ -29,7 +29,7 @@ The following techniques have been adopted for SOTA results: ### Wiki Text -The wikitext-2 data is from [(The wikitext long term dependency language modeling dataset)](https://www.salesforce.com/products/einstein/ai-research/the-wikitext-dependency-language-modeling-dataset/). The training script automatically loads the dataset into `$PWD/data`. +The wikitext-2 data is from [(The wikitext long term dependency language modeling dataset)](https://blog.einstein.ai/the-wikitext-long-term-dependency-language-modeling-dataset/). The training script automatically loads the dataset into `$PWD/data`. ## Usage diff --git a/python/mxnet/gluon/block.py b/python/mxnet/gluon/block.py index b42fefd065e8..ff619d67da06 100644 --- a/python/mxnet/gluon/block.py +++ b/python/mxnet/gluon/block.py @@ -378,7 +378,7 @@ def save_parameters(self, filename): References ---------- `Saving and Loading Gluon Models \ - `_ + `_ """ params = self._collect_params_with_prefix() arg_dict = {key : val._reduce() for key, val in params.items()} @@ -430,7 +430,7 @@ def load_parameters(self, filename, ctx=None, allow_missing=False, References ---------- `Saving and Loading Gluon Models \ - `_ + `_ """ if is_np_array(): # failure may happen when loading parameters saved as NDArrays within diff --git a/python/mxnet/gluon/contrib/data/text.py b/python/mxnet/gluon/contrib/data/text.py index 9e78e3c2e23c..c0f4a3b924bf 100644 --- a/python/mxnet/gluon/contrib/data/text.py +++ b/python/mxnet/gluon/contrib/data/text.py @@ -106,7 +106,7 @@ class WikiText2(_WikiText): """WikiText-2 word-level dataset for language modeling, from Salesforce research. From - https://einstein.ai/research/the-wikitext-long-term-dependency-language-modeling-dataset + https://blog.einstein.ai/the-wikitext-long-term-dependency-language-modeling-dataset/ License: Creative Commons Attribution-ShareAlike @@ -144,7 +144,7 @@ class WikiText103(_WikiText): """WikiText-103 word-level dataset for language modeling, from Salesforce research. From - https://einstein.ai/research/the-wikitext-long-term-dependency-language-modeling-dataset + https://blog.einstein.ai/the-wikitext-long-term-dependency-language-modeling-dataset/ License: Creative Commons Attribution-ShareAlike diff --git a/python/mxnet/gluon/trainer.py b/python/mxnet/gluon/trainer.py index 8a863fc2c6eb..01f76d637a97 100644 --- a/python/mxnet/gluon/trainer.py +++ b/python/mxnet/gluon/trainer.py @@ -43,7 +43,7 @@ class Trainer(object): The set of parameters to optimize. optimizer : str or Optimizer The optimizer to use. See - `help `_ + `help `_ on Optimizer for a list of available optimizers. optimizer_params : dict Key-word arguments to be passed to optimizer constructor. For example, From 4d0c527a702d6d0d1bf5796e24792fff3cddc217 Mon Sep 17 00:00:00 2001 From: Talia <31782251+TEChopra1000@users.noreply.github.com> Date: Sun, 20 Oct 2019 19:05:24 -0700 Subject: [PATCH 2/2] Update docs/python_docs/themes/mx-theme/mxtheme/footer.html Co-Authored-By: Aaron Markham --- docs/python_docs/themes/mx-theme/mxtheme/footer.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/python_docs/themes/mx-theme/mxtheme/footer.html b/docs/python_docs/themes/mx-theme/mxtheme/footer.html index 4e9d16ce305e..55a5fb2312d9 100644 --- a/docs/python_docs/themes/mx-theme/mxtheme/footer.html +++ b/docs/python_docs/themes/mx-theme/mxtheme/footer.html @@ -10,7 +10,7 @@

    Resources

  • Jira Tracker
  • Github Roadmap
  • MXNet Discuss forum
    • -
  • Contribute To MXNet
    • +
  • Contribute To MXNet
    • @@ -43,4 +43,4 @@

    Resources

    - \ No newline at end of file +