diff --git a/docs/Dockerfile b/docs/Dockerfile index 99bb3d5be492..61a1e5f915e2 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -1,3 +1,23 @@ +# -*- mode: dockerfile -*- +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# FROM ubuntu:14.04 MAINTAINER Mu Li diff --git a/docs/README.md b/docs/README.md index 80463cc68d54..6ff2ae5efe18 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,22 @@ + + # Building and Updating MXNet Documentation The website is hosted at http://mxnet.incubator.apache.org/. diff --git a/docs/api/c++/index.md b/docs/api/c++/index.md index 6bb7a410b341..491e91ab5e5d 100644 --- a/docs/api/c++/index.md +++ b/docs/api/c++/index.md @@ -1,3 +1,22 @@ + + # MXNet - C++ API The MXNet C++ Package provides C++ API bindings to the users of MXNet. Currently, these bindings are not available as standalone package. diff --git a/docs/api/clojure/index.md b/docs/api/clojure/index.md index 32abbe06ad79..cb27c637d586 100644 --- a/docs/api/clojure/index.md +++ b/docs/api/clojure/index.md @@ -1,3 +1,22 @@ + + # MXNet - Clojure API MXNet supports the Clojure programming language. The MXNet Clojure package brings flexible and efficient GPU diff --git a/docs/api/clojure/kvstore.md b/docs/api/clojure/kvstore.md index 25943c365f94..d5f7c089ff7c 100644 --- a/docs/api/clojure/kvstore.md +++ b/docs/api/clojure/kvstore.md @@ -1,3 +1,22 @@ + + # KVStore API Topics: diff --git a/docs/api/clojure/module.md b/docs/api/clojure/module.md index 88a5308a7cc2..db7cb70d0fce 100644 --- a/docs/api/clojure/module.md +++ b/docs/api/clojure/module.md @@ -1,3 +1,22 @@ + + # Module API The module API provides an intermediate and high-level interface for performing computation with neural networks in MXNet. Module wraps a Symbol and one or more Executors. It has both a high level and intermediate level API. diff --git a/docs/api/clojure/ndarray.md b/docs/api/clojure/ndarray.md index b0e5c991f7d4..3d367c6c5011 100644 --- a/docs/api/clojure/ndarray.md +++ b/docs/api/clojure/ndarray.md @@ -1,3 +1,22 @@ + + # NDArray API diff --git a/docs/api/clojure/symbol.md b/docs/api/clojure/symbol.md index 1ec841f153cf..a70c9ea5b906 100644 --- a/docs/api/clojure/symbol.md +++ b/docs/api/clojure/symbol.md @@ -1,3 +1,22 @@ + + # MXNet Clojure Symbolic API Topics: diff --git a/docs/api/clojure/symbol_in_pictures.md b/docs/api/clojure/symbol_in_pictures.md index bde274cb238b..aac133d2d067 100644 --- a/docs/api/clojure/symbol_in_pictures.md +++ b/docs/api/clojure/symbol_in_pictures.md @@ -1,3 +1,22 @@ + + # Symbolic Configuration and Execution in Pictures This topic explains symbolic construction and execution in pictures. diff --git a/docs/api/index.md b/docs/api/index.md index 9e7a58f7778c..62de6cbed502 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -1,3 +1,22 @@ + + # MXNet APIs diff --git a/docs/api/java/index.md b/docs/api/java/index.md index b2ae035b19c9..9955c05f3bc1 100644 --- a/docs/api/java/index.md +++ b/docs/api/java/index.md @@ -1,3 +1,22 @@ + + # MXNet - Java Inference API MXNet supports Java for performing inference on a trained model. The MXNet Java Inference API is an extension of the [Scala Infer API](../../api/scala/infer.html) which provides model loading and inference functionality. diff --git a/docs/api/julia/index.md b/docs/api/julia/index.md index f4dc0e5b7498..0c5c93c9c4db 100644 --- a/docs/api/julia/index.md +++ b/docs/api/julia/index.md @@ -1,3 +1,22 @@ + + # MXNet - Julia API See the [MXNet Julia Reference Manual](https://media.readthedocs.org/pdf/mxnet-test/latest/mxnet-test.pdf). diff --git a/docs/api/perl/index.md b/docs/api/perl/index.md index 6408b525f00c..0aef4d4aa4d3 100644 --- a/docs/api/perl/index.md +++ b/docs/api/perl/index.md @@ -1,3 +1,22 @@ + + # MXNet - Perl API MXNet supports the Perl programming language. The MXNet Perl package brings flexible and efficient GPU diff --git a/docs/api/perl/io.md b/docs/api/perl/io.md index 3310f26aba18..c3f55c6e27ea 100644 --- a/docs/api/perl/io.md +++ b/docs/api/perl/io.md @@ -1,3 +1,22 @@ + + # Data Loading API ## Overview diff --git a/docs/api/perl/kvstore.md b/docs/api/perl/kvstore.md index 7ff73be06b07..e221dbbf4f9b 100644 --- a/docs/api/perl/kvstore.md +++ b/docs/api/perl/kvstore.md @@ -1,3 +1,22 @@ + + # KVStore API Topics: diff --git a/docs/api/perl/module.md b/docs/api/perl/module.md index 132e333dac9c..314b5e8d41da 100644 --- a/docs/api/perl/module.md +++ b/docs/api/perl/module.md @@ -1,3 +1,22 @@ + + # Module API ## Overview diff --git a/docs/api/perl/ndarray.md b/docs/api/perl/ndarray.md index c7962b9f896f..4e7e3a3562ce 100644 --- a/docs/api/perl/ndarray.md +++ b/docs/api/perl/ndarray.md @@ -1,3 +1,22 @@ + + # NDArray API ## Overview diff --git a/docs/api/perl/symbol.md b/docs/api/perl/symbol.md index 407e912d6fb5..d9d7d7143c26 100644 --- a/docs/api/perl/symbol.md +++ b/docs/api/perl/symbol.md @@ -1,3 +1,22 @@ + + # MXNet Perl Symbolic API Topics: diff --git a/docs/api/python/autograd/autograd.md b/docs/api/python/autograd/autograd.md index f20799a44351..38a99f504f60 100644 --- a/docs/api/python/autograd/autograd.md +++ b/docs/api/python/autograd/autograd.md @@ -1,3 +1,22 @@ + + # Autograd Package ```eval_rst diff --git a/docs/api/python/callback/callback.md b/docs/api/python/callback/callback.md index 714966678a15..be99dc01ee7b 100644 --- a/docs/api/python/callback/callback.md +++ b/docs/api/python/callback/callback.md @@ -1,3 +1,22 @@ + + # Callback API ```eval_rst diff --git a/docs/api/python/contrib/contrib.md b/docs/api/python/contrib/contrib.md index 66fc39152983..65922556d2cc 100644 --- a/docs/api/python/contrib/contrib.md +++ b/docs/api/python/contrib/contrib.md @@ -1,3 +1,22 @@ + + # Contrib Package ## Overview diff --git a/docs/api/python/contrib/onnx.md b/docs/api/python/contrib/onnx.md index f8210ad6a001..18b108caa5b5 100644 --- a/docs/api/python/contrib/onnx.md +++ b/docs/api/python/contrib/onnx.md @@ -1,3 +1,22 @@ + + # ONNX-MXNet API ## Overview diff --git a/docs/api/python/contrib/svrg_optimization.md b/docs/api/python/contrib/svrg_optimization.md index e6e1c3e23ee3..c79dd44f003b 100644 --- a/docs/api/python/contrib/svrg_optimization.md +++ b/docs/api/python/contrib/svrg_optimization.md @@ -1,3 +1,22 @@ + + # SVRG Optimization in Python Module API ## Overview diff --git a/docs/api/python/contrib/text.md b/docs/api/python/contrib/text.md index e5f92bc7ef01..1fd9514e0f65 100644 --- a/docs/api/python/contrib/text.md +++ b/docs/api/python/contrib/text.md @@ -1,3 +1,22 @@ + + # Text API ## Overview diff --git a/docs/api/python/executor/executor.md b/docs/api/python/executor/executor.md index a37bfa91d2bf..26c97907dfc5 100644 --- a/docs/api/python/executor/executor.md +++ b/docs/api/python/executor/executor.md @@ -1,3 +1,22 @@ + + # Executor and Executor Manager The executor and executor manager are internal classes for managing symbolic diff --git a/docs/api/python/gluon/contrib.md b/docs/api/python/gluon/contrib.md index 98f36f882164..f6e6dfe771a5 100644 --- a/docs/api/python/gluon/contrib.md +++ b/docs/api/python/gluon/contrib.md @@ -1,3 +1,22 @@ + + # Gluon Contrib API ## Overview diff --git a/docs/api/python/gluon/data.md b/docs/api/python/gluon/data.md index 99e54c1f034b..6d4440f91709 100644 --- a/docs/api/python/gluon/data.md +++ b/docs/api/python/gluon/data.md @@ -1,3 +1,22 @@ + + # Gluon Data API ## Overview diff --git a/docs/api/python/gluon/gluon.md b/docs/api/python/gluon/gluon.md index 07c98981a166..cbb0750e47a2 100644 --- a/docs/api/python/gluon/gluon.md +++ b/docs/api/python/gluon/gluon.md @@ -1,3 +1,22 @@ + + # Gluon Package diff --git a/docs/api/python/gluon/loss.md b/docs/api/python/gluon/loss.md index 948f4983d370..a2ac65f84b53 100644 --- a/docs/api/python/gluon/loss.md +++ b/docs/api/python/gluon/loss.md @@ -1,3 +1,22 @@ + + # Gluon Loss API ## Overview diff --git a/docs/api/python/gluon/model_zoo.md b/docs/api/python/gluon/model_zoo.md index 288cf96f1d09..07d11cd7242e 100644 --- a/docs/api/python/gluon/model_zoo.md +++ b/docs/api/python/gluon/model_zoo.md @@ -1,3 +1,22 @@ + + # Gluon Model Zoo ```eval_rst diff --git a/docs/api/python/gluon/nn.md b/docs/api/python/gluon/nn.md index 25c82f066680..544a315eb784 100644 --- a/docs/api/python/gluon/nn.md +++ b/docs/api/python/gluon/nn.md @@ -1,3 +1,22 @@ + + # Gluon Neural Network Layers ## Overview diff --git a/docs/api/python/gluon/rnn.md b/docs/api/python/gluon/rnn.md index b558b8479e43..e7da65741f19 100644 --- a/docs/api/python/gluon/rnn.md +++ b/docs/api/python/gluon/rnn.md @@ -1,3 +1,22 @@ + + # Gluon Recurrent Neural Network API ## Overview diff --git a/docs/api/python/image/image.md b/docs/api/python/image/image.md index 299c54570b17..61cca225a230 100644 --- a/docs/api/python/image/image.md +++ b/docs/api/python/image/image.md @@ -1,3 +1,22 @@ + + # Image API ## Overview diff --git a/docs/api/python/index.md b/docs/api/python/index.md index de86aedff691..1d11eb7182a1 100644 --- a/docs/api/python/index.md +++ b/docs/api/python/index.md @@ -1,3 +1,22 @@ + + # MXNet - Python API MXNet provides a comprehensive and flexible Python API to serve a broad community of developers with different levels of experience and wide ranging requirements. In this section, we provide an in-depth discussion of the functionality provided by various MXNet Python packages. diff --git a/docs/api/python/io/io.md b/docs/api/python/io/io.md index a069eae61e71..057d64c129a4 100644 --- a/docs/api/python/io/io.md +++ b/docs/api/python/io/io.md @@ -1,3 +1,22 @@ + + # Data Loading API ## Overview diff --git a/docs/api/python/kvstore/kvstore.md b/docs/api/python/kvstore/kvstore.md index 9f4c06499663..3a2957353620 100644 --- a/docs/api/python/kvstore/kvstore.md +++ b/docs/api/python/kvstore/kvstore.md @@ -1,3 +1,22 @@ + + # KVStore API .. note:: Direct interactions with ``KVStore`` are dangerous and not recommended. diff --git a/docs/api/python/metric/metric.md b/docs/api/python/metric/metric.md index 319647a69491..5423971ad6fb 100644 --- a/docs/api/python/metric/metric.md +++ b/docs/api/python/metric/metric.md @@ -1,3 +1,22 @@ + + # Evaluation Metric API ```eval_rst diff --git a/docs/api/python/model.md b/docs/api/python/model.md index dc36648f7fac..a98d2e4119db 100644 --- a/docs/api/python/model.md +++ b/docs/api/python/model.md @@ -1,3 +1,22 @@ + + # Model API The model API provides a simplified way to train neural networks using common best practices. diff --git a/docs/api/python/module/module.md b/docs/api/python/module/module.md index 7a86eccd8d3a..51c2343deb58 100644 --- a/docs/api/python/module/module.md +++ b/docs/api/python/module/module.md @@ -1,3 +1,22 @@ + + # Module API ```eval_rst diff --git a/docs/api/python/ndarray/contrib.md b/docs/api/python/ndarray/contrib.md index d7c9021b5957..8d37ca41f4ba 100644 --- a/docs/api/python/ndarray/contrib.md +++ b/docs/api/python/ndarray/contrib.md @@ -1,3 +1,22 @@ + + # Contrib NDArray API ```eval_rst diff --git a/docs/api/python/ndarray/linalg.md b/docs/api/python/ndarray/linalg.md index 0a85b48304fa..fac44c0f06ef 100644 --- a/docs/api/python/ndarray/linalg.md +++ b/docs/api/python/ndarray/linalg.md @@ -1,3 +1,22 @@ + + # Linear Algebra NDArray API ```eval_rst diff --git a/docs/api/python/ndarray/ndarray.md b/docs/api/python/ndarray/ndarray.md index 2df18c286ba7..b71b961fef3c 100644 --- a/docs/api/python/ndarray/ndarray.md +++ b/docs/api/python/ndarray/ndarray.md @@ -1,3 +1,22 @@ + + # NDArray API ```eval_rst diff --git a/docs/api/python/ndarray/random.md b/docs/api/python/ndarray/random.md index 60c565dd5528..fc8c25900415 100644 --- a/docs/api/python/ndarray/random.md +++ b/docs/api/python/ndarray/random.md @@ -1,3 +1,22 @@ + + # Random Distribution Generator NDArray API ```eval_rst diff --git a/docs/api/python/ndarray/sparse.md b/docs/api/python/ndarray/sparse.md index 608a9501a039..0a513dc7a624 100644 --- a/docs/api/python/ndarray/sparse.md +++ b/docs/api/python/ndarray/sparse.md @@ -1,3 +1,22 @@ + + # Sparse NDArray API ```eval_rst diff --git a/docs/api/python/optimization/contrib.md b/docs/api/python/optimization/contrib.md index 8fc261f4f052..d67887992e50 100644 --- a/docs/api/python/optimization/contrib.md +++ b/docs/api/python/optimization/contrib.md @@ -1,3 +1,22 @@ + + # Contrib Optimization API ```eval_rst diff --git a/docs/api/python/optimization/optimization.md b/docs/api/python/optimization/optimization.md index fa3547b54a8f..56bf8f538ed8 100644 --- a/docs/api/python/optimization/optimization.md +++ b/docs/api/python/optimization/optimization.md @@ -1,3 +1,22 @@ + + # Optimization: initialize and update weights ## Overview diff --git a/docs/api/python/rtc/rtc.md b/docs/api/python/rtc/rtc.md index 88e4ed892722..5f90f3a8b77c 100644 --- a/docs/api/python/rtc/rtc.md +++ b/docs/api/python/rtc/rtc.md @@ -1,3 +1,22 @@ + + # Run-Time Compilation API ```eval_rst diff --git a/docs/api/python/symbol/contrib.md b/docs/api/python/symbol/contrib.md index a0253216f945..2429b3765ace 100644 --- a/docs/api/python/symbol/contrib.md +++ b/docs/api/python/symbol/contrib.md @@ -1,3 +1,22 @@ + + # Contrib Symbol API ```eval_rst diff --git a/docs/api/python/symbol/linalg.md b/docs/api/python/symbol/linalg.md index d22ca8e171f9..c04846e7ba92 100644 --- a/docs/api/python/symbol/linalg.md +++ b/docs/api/python/symbol/linalg.md @@ -1,3 +1,22 @@ + + # Linear Algebra Symbol API ```eval_rst diff --git a/docs/api/python/symbol/random.md b/docs/api/python/symbol/random.md index 1ecaf38830fc..1c5f916ad10a 100644 --- a/docs/api/python/symbol/random.md +++ b/docs/api/python/symbol/random.md @@ -1,3 +1,22 @@ + + # Random Distribution Generator Symbol API ```eval_rst diff --git a/docs/api/python/symbol/rnn.md b/docs/api/python/symbol/rnn.md index 722180a27789..627d2e0cde37 100644 --- a/docs/api/python/symbol/rnn.md +++ b/docs/api/python/symbol/rnn.md @@ -1,3 +1,22 @@ + + # RNN Cell Symbol API ```eval_rst diff --git a/docs/api/python/symbol/sparse.md b/docs/api/python/symbol/sparse.md index cd8272cedd7d..866a302940cc 100644 --- a/docs/api/python/symbol/sparse.md +++ b/docs/api/python/symbol/sparse.md @@ -1,3 +1,22 @@ + + # Sparse Symbol API ```eval_rst diff --git a/docs/api/python/symbol/symbol.md b/docs/api/python/symbol/symbol.md index 0fc2aa7c6cf2..9783053d9a1d 100644 --- a/docs/api/python/symbol/symbol.md +++ b/docs/api/python/symbol/symbol.md @@ -1,3 +1,22 @@ + + # Symbol API ```eval_rst diff --git a/docs/api/python/symbol_in_pictures/symbol_in_pictures.md b/docs/api/python/symbol_in_pictures/symbol_in_pictures.md index 5ef4395b9af6..5326ade3003f 100644 --- a/docs/api/python/symbol_in_pictures/symbol_in_pictures.md +++ b/docs/api/python/symbol_in_pictures/symbol_in_pictures.md @@ -1,3 +1,22 @@ + + # Symbolic Configuration and Execution in Pictures This topic explains symbolic construction and execution in pictures. diff --git a/docs/api/python/tools/test_utils.md b/docs/api/python/tools/test_utils.md index e29d9b99a844..2896a594c004 100644 --- a/docs/api/python/tools/test_utils.md +++ b/docs/api/python/tools/test_utils.md @@ -1,3 +1,22 @@ + + # Test Utilities This module has a variety of tools that help using and testing MXNet. diff --git a/docs/api/python/tools/visualization.md b/docs/api/python/tools/visualization.md index 6faa24980dd8..8ba722878616 100644 --- a/docs/api/python/tools/visualization.md +++ b/docs/api/python/tools/visualization.md @@ -1,3 +1,22 @@ + + # Visualization This module contains visualization features. diff --git a/docs/api/r/index.md b/docs/api/r/index.md index 822c59dbe3cc..5a85a770d80e 100644 --- a/docs/api/r/index.md +++ b/docs/api/r/index.md @@ -1,3 +1,22 @@ + + # MXNet - R API See the [MXNet R Reference Manual](https://s3.amazonaws.com/mxnet-prod/docs/R/mxnet-r-reference-manual.pdf). diff --git a/docs/api/scala/index.md b/docs/api/scala/index.md index f7a150019872..76e5673aa3bf 100644 --- a/docs/api/scala/index.md +++ b/docs/api/scala/index.md @@ -1,3 +1,22 @@ + + # MXNet - Scala API MXNet supports the Scala programming language. The MXNet Scala package brings flexible and efficient GPU diff --git a/docs/api/scala/infer.md b/docs/api/scala/infer.md index dfa21c178416..af50fc2e4b03 100644 --- a/docs/api/scala/infer.md +++ b/docs/api/scala/infer.md @@ -1,3 +1,22 @@ + + # Infer API The MXNet Scala Infer API provides you with model loading and inference functionality using the MXNet Scala package. diff --git a/docs/api/scala/io.md b/docs/api/scala/io.md index ff212d1479ed..fe819e876bbd 100644 --- a/docs/api/scala/io.md +++ b/docs/api/scala/io.md @@ -1,3 +1,22 @@ + + # MXNet Scala Data Loading API This topic introduces the data input method for MXNet. MXNet uses an iterator to provide data to the neural network. Iterators do some preprocessing and generate batches for the neural network. diff --git a/docs/api/scala/kvstore.md b/docs/api/scala/kvstore.md index e195c4d7e720..32e3c1f1145c 100644 --- a/docs/api/scala/kvstore.md +++ b/docs/api/scala/kvstore.md @@ -1,3 +1,22 @@ + + # KVStore API Topics: diff --git a/docs/api/scala/model.md b/docs/api/scala/model.md index 3e09d15218b8..4eeae42de6be 100644 --- a/docs/api/scala/model.md +++ b/docs/api/scala/model.md @@ -1,3 +1,22 @@ + + # MXNet Scala Model API The model API provides a simplified way to train neural networks using common best practices. diff --git a/docs/api/scala/module.md b/docs/api/scala/module.md index 06487f734a3f..c7f9a0a29a3b 100644 --- a/docs/api/scala/module.md +++ b/docs/api/scala/module.md @@ -1,3 +1,22 @@ + + # Module API The module API provides an intermediate and high-level interface for performing computation with neural networks in MXNet. A *module* is an instance of subclasses of the `BaseModule`. The most widely used module class is called `Module`. Module wraps a `Symbol` and one or more `Executors`. For a full list of functions, see `BaseModule`. A subclass of modules might have extra interface functions. This topic provides some examples of common use cases. All of the module APIs are in the `Module` namespace. diff --git a/docs/api/scala/ndarray.md b/docs/api/scala/ndarray.md index 9e87d397c8b8..ad3349d02c8e 100644 --- a/docs/api/scala/ndarray.md +++ b/docs/api/scala/ndarray.md @@ -1,3 +1,22 @@ + + # NDArray API diff --git a/docs/api/scala/symbol.md b/docs/api/scala/symbol.md index c10d5fb60a24..52d63e91f38b 100644 --- a/docs/api/scala/symbol.md +++ b/docs/api/scala/symbol.md @@ -1,3 +1,22 @@ + + # MXNet Scala Symbolic API Topics: diff --git a/docs/api/scala/symbol_in_pictures.md b/docs/api/scala/symbol_in_pictures.md index 0fa12d0a7557..9d6ecdd55202 100644 --- a/docs/api/scala/symbol_in_pictures.md +++ b/docs/api/scala/symbol_in_pictures.md @@ -1,3 +1,22 @@ + + # Symbolic Configuration and Execution in Pictures This topic explains symbolic construction and execution in pictures. diff --git a/docs/architecture/exception_handling.md b/docs/architecture/exception_handling.md index 5b4448a53ab6..08b05058628e 100644 --- a/docs/architecture/exception_handling.md +++ b/docs/architecture/exception_handling.md @@ -1,3 +1,22 @@ + + # Exception Handling in MXNet This tutorial explains the exception handling support in MXNet, diff --git a/docs/architecture/index.md b/docs/architecture/index.md index 189e76e62fa5..d17564090c89 100644 --- a/docs/architecture/index.md +++ b/docs/architecture/index.md @@ -1,3 +1,22 @@ + + # MXNet Architecture Building a high-performance deep learning library diff --git a/docs/architecture/note_data_loading.md b/docs/architecture/note_data_loading.md index 7c92c86a9c67..83420a3ff071 100644 --- a/docs/architecture/note_data_loading.md +++ b/docs/architecture/note_data_loading.md @@ -1,3 +1,22 @@ + + # Designing Efficient Data Loaders for Deep Learning Data loading is an important component of any machine learning system. diff --git a/docs/architecture/note_engine.md b/docs/architecture/note_engine.md index 237d8d61b77d..378191cdb184 100644 --- a/docs/architecture/note_engine.md +++ b/docs/architecture/note_engine.md @@ -1,3 +1,22 @@ + + # Dependency Engine for Deep Learning We always want deep learning libraries diff --git a/docs/architecture/note_memory.md b/docs/architecture/note_memory.md index 8ec77c395f31..cd161c9ed0f0 100644 --- a/docs/architecture/note_memory.md +++ b/docs/architecture/note_memory.md @@ -1,3 +1,22 @@ + + # Optimizing Memory Consumption in Deep Learning Over the last ten years, a constant trend in deep learning diff --git a/docs/architecture/overview.md b/docs/architecture/overview.md index 6a37f8830479..04abacd869cd 100644 --- a/docs/architecture/overview.md +++ b/docs/architecture/overview.md @@ -1,3 +1,22 @@ + + # MXNet System Architecture ![System Overview](https://raw.githubusercontent.com/dmlc/dmlc.github.io/master/img/mxnet/system/overview.png) diff --git a/docs/architecture/program_model.md b/docs/architecture/program_model.md index 519a9a9024d8..b4d2c31accda 100644 --- a/docs/architecture/program_model.md +++ b/docs/architecture/program_model.md @@ -1,3 +1,22 @@ + + # Deep Learning Programming Style However much we might ultimately care about performance, diff --git a/docs/architecture/rnn_interface.md b/docs/architecture/rnn_interface.md index dc0b6a7958ef..523295e934df 100644 --- a/docs/architecture/rnn_interface.md +++ b/docs/architecture/rnn_interface.md @@ -1,3 +1,22 @@ + + # Survey of Existing Interfaces and Implementations Commonly used deep learning libraries with good RNN/LSTM support include [Theano](http://deeplearning.net/software/theano/library/scan.html) and its wrappers [Lasagne](http://lasagne.readthedocs.org/en/latest/modules/layers/recurrent.html) and [Keras](http://keras.io/layers/recurrent/); [CNTK](https://cntk.codeplex.com/); [TensorFlow](https://www.tensorflow.org/tutorials/sequences/recurrent); and various implementations in Torch, such as [this well-known character-level language model tutorial](https://github.com/karpathy/char-rnn), [this](https://github.com/Element-Research/rnn). diff --git a/docs/build_version_doc/Dockerfile b/docs/build_version_doc/Dockerfile index 0cc2680ffaef..8bae701199af 100755 --- a/docs/build_version_doc/Dockerfile +++ b/docs/build_version_doc/Dockerfile @@ -1,3 +1,23 @@ +# -*- mode: dockerfile -*- +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# FROM ubuntu:16.04 LABEL maintainer="markhama@amazon.com" diff --git a/docs/build_version_doc/README.md b/docs/build_version_doc/README.md index 50802371cea2..2e30a3bbe5f9 100644 --- a/docs/build_version_doc/README.md +++ b/docs/build_version_doc/README.md @@ -1,3 +1,22 @@ + + # MXNet Documentation Build Scripts This folder contains a variety of scripts to generate the MXNet.io website as well as the docs for different versions of MXNet. diff --git a/docs/community/contribute.md b/docs/community/contribute.md index 1b83638edcb5..727b9d137784 100644 --- a/docs/community/contribute.md +++ b/docs/community/contribute.md @@ -1,3 +1,22 @@ + + # Contributing to MXNet Apache MXNet (incubating) is a community led, open source deep learning project. We welcome new members and look forward to your contributions. Here you will find how to get started and links to detailed information on MXNet best practices and processes. diff --git a/docs/community/ecosystem.md b/docs/community/ecosystem.md index 100ed973cf3f..792f9de6ff3c 100644 --- a/docs/community/ecosystem.md +++ b/docs/community/ecosystem.md @@ -1,3 +1,22 @@ + + # MXNet's Ecosystem Community contributions to MXNet have added many new valuable features and functionality to support use cases such as model serving & portability, easy and flexible APIs, and educational material like crash courses and online books. This ecosystem page lists the projects that use MXNet, teach MXNet, or augment MXNet in some way. diff --git a/docs/community/index.md b/docs/community/index.md index 7bdb1c213503..a2be9861db96 100644 --- a/docs/community/index.md +++ b/docs/community/index.md @@ -1,3 +1,22 @@ + + # MXNet Community ```eval_rst diff --git a/docs/community/mxnet_channels.md b/docs/community/mxnet_channels.md index 8bc8471dffd1..ec0149769474 100644 --- a/docs/community/mxnet_channels.md +++ b/docs/community/mxnet_channels.md @@ -1,3 +1,22 @@ + + # Join MXNet Development Discussion Converse with the MXNet community via the following channels: diff --git a/docs/community/powered_by.md b/docs/community/powered_by.md index 82748ef7df2a..0cca3d02f0c1 100644 --- a/docs/community/powered_by.md +++ b/docs/community/powered_by.md @@ -1,3 +1,22 @@ + + # Powered By
diff --git a/docs/faq/add_op_in_backend.md b/docs/faq/add_op_in_backend.md index c44a0aa05235..64f6c8ae0f98 100644 --- a/docs/faq/add_op_in_backend.md +++ b/docs/faq/add_op_in_backend.md @@ -1,3 +1,22 @@ + + # A Beginner's Guide to Implementing Operators in MXNet Backend ## Introduction diff --git a/docs/faq/bucketing.md b/docs/faq/bucketing.md index dbfdedde2acf..49994dc4fe97 100644 --- a/docs/faq/bucketing.md +++ b/docs/faq/bucketing.md @@ -1,3 +1,22 @@ + + # Bucketing in MXNet When we train recurrent neural networks (RNNs), we _unroll_ the network in time. For a single example of length T, we would unroll the network T steps. diff --git a/docs/faq/caffe.md b/docs/faq/caffe.md index a9bab3cdb549..b99acb07e0bd 100644 --- a/docs/faq/caffe.md +++ b/docs/faq/caffe.md @@ -1,3 +1,22 @@ + + # How to | Convert from Caffe to MXNet Key topics covered include the following: diff --git a/docs/faq/cloud.md b/docs/faq/cloud.md index 67b28f8b4338..bd2987f0a057 100644 --- a/docs/faq/cloud.md +++ b/docs/faq/cloud.md @@ -1,3 +1,22 @@ + + # MXNet on the Cloud Deep learning can require extremely powerful hardware, often for unpredictable durations of time. diff --git a/docs/faq/develop_and_hack.md b/docs/faq/develop_and_hack.md index da53fd010bb0..b09824dc2ef6 100644 --- a/docs/faq/develop_and_hack.md +++ b/docs/faq/develop_and_hack.md @@ -1,3 +1,22 @@ + + # Develop and Hack MXNet - [Create new operators](new_op.md) - [Use Torch from MXNet](torch.md) diff --git a/docs/faq/distributed_training.md b/docs/faq/distributed_training.md index 8d8666ff066c..32696f34e250 100644 --- a/docs/faq/distributed_training.md +++ b/docs/faq/distributed_training.md @@ -1,3 +1,22 @@ + + # Distributed Training in MXNet MXNet supports distributed training enabling us to leverage multiple machines for faster training. In this document, we describe how it works, how to launch a distributed training job and diff --git a/docs/faq/env_var.md b/docs/faq/env_var.md index 83368bf4d0c3..2f649bedafc1 100644 --- a/docs/faq/env_var.md +++ b/docs/faq/env_var.md @@ -1,3 +1,22 @@ + + Environment Variables ===================== MXNet has several settings that you can change with environment variables. diff --git a/docs/faq/faq.md b/docs/faq/faq.md index 668587ec6888..4682c95d2a47 100644 --- a/docs/faq/faq.md +++ b/docs/faq/faq.md @@ -1,3 +1,22 @@ + + # Frequently Asked Questions This topic provides answers to the frequently asked questions on [mxnet/issues](https://github.com/dmlc/mxnet/issues). Before posting an issue, please check this page. If you would like to contribute to this page, please make the questions and answers simple. If your answer is extremely detailed, please post it elsewhere and link to it. diff --git a/docs/faq/finetune.md b/docs/faq/finetune.md index 04244d15b0b9..33a4ffb32521 100644 --- a/docs/faq/finetune.md +++ b/docs/faq/finetune.md @@ -1,3 +1,22 @@ + + # Fine-tune with Pretrained Models diff --git a/docs/faq/float16.md b/docs/faq/float16.md index b4cd97b30e5c..0fda178c4bde 100644 --- a/docs/faq/float16.md +++ b/docs/faq/float16.md @@ -1,3 +1,22 @@ + + # Mixed precision training using float16 In this tutorial you will walk through how one can train deep learning neural networks with mixed precision on supported hardware. You will first see how to use float16 (both with Gluon and Symbolic APIs) and then some techniques on achieving good performance and accuracy. diff --git a/docs/faq/gradient_compression.md b/docs/faq/gradient_compression.md index e2dbd3271d8d..adf7f62bc193 100644 --- a/docs/faq/gradient_compression.md +++ b/docs/faq/gradient_compression.md @@ -1,3 +1,22 @@ + + # Gradient Compression Gradient Compression reduces communication bandwidth, and in some scenarios, it can make training more scalable and efficient without significant loss in convergence rate or accuracy. Example implementations with GPUs, CPUs, and distributed training are provided in this document. diff --git a/docs/faq/index.md b/docs/faq/index.md index fe91f7ca43b7..99c448da027d 100644 --- a/docs/faq/index.md +++ b/docs/faq/index.md @@ -1,3 +1,22 @@ + + # MXNet FAQ ```eval_rst diff --git a/docs/faq/model_parallel_lstm.md b/docs/faq/model_parallel_lstm.md index b78b2c574dcc..63f4db6d9df9 100644 --- a/docs/faq/model_parallel_lstm.md +++ b/docs/faq/model_parallel_lstm.md @@ -1,3 +1,22 @@ + + # Training with Multiple GPUs Using Model Parallelism Training deep learning models can be resource intensive. Even with a powerful GPU, some models can take days or weeks to train. diff --git a/docs/faq/multi_devices.md b/docs/faq/multi_devices.md index a43879cb5233..46ec837025d9 100644 --- a/docs/faq/multi_devices.md +++ b/docs/faq/multi_devices.md @@ -1,3 +1,22 @@ + + # Run MXNet on Multiple CPU/GPUs with Data Parallelism _MXNet_ supports training with multiple CPUs and GPUs, which may be located on different physical machines. diff --git a/docs/faq/new_op.md b/docs/faq/new_op.md index 994a2a6f823e..910bb64ef5d9 100644 --- a/docs/faq/new_op.md +++ b/docs/faq/new_op.md @@ -1,3 +1,22 @@ + + # How to Create New Operators (Layers) This tutorials walks you through the process of creating new MXNet operators (or layers). diff --git a/docs/faq/nnpack.md b/docs/faq/nnpack.md index ed38cb07df7e..690315efe54a 100644 --- a/docs/faq/nnpack.md +++ b/docs/faq/nnpack.md @@ -1,3 +1,22 @@ + + ### NNPACK for Multi-Core CPU Support in MXNet [NNPACK](https://github.com/Maratyszcza/NNPACK) is an acceleration package for neural network computations, which can run on x86-64, ARMv7, or ARM64 architecture CPUs. diff --git a/docs/faq/perf.md b/docs/faq/perf.md index f116ede11d56..d00c904c0873 100644 --- a/docs/faq/perf.md +++ b/docs/faq/perf.md @@ -1,3 +1,22 @@ + + # Some Tips for Improving MXNet Performance Even after fixing the training or deployment environment and parallelization scheme, a number of configuration settings and data-handling choices can impact the _MXNet_ performance. diff --git a/docs/faq/recordio.md b/docs/faq/recordio.md index 3091052ef6f3..3ece38617513 100644 --- a/docs/faq/recordio.md +++ b/docs/faq/recordio.md @@ -1,3 +1,22 @@ + + ## Create a Dataset Using RecordIO RecordIO implements a file format for a sequence of records. We recommend storing images as records and packing them together. The benefits include: diff --git a/docs/faq/s3_integration.md b/docs/faq/s3_integration.md index 024356706339..18bd38df71df 100644 --- a/docs/faq/s3_integration.md +++ b/docs/faq/s3_integration.md @@ -1,3 +1,22 @@ + + # Use data from S3 for training AWS S3 is a cloud-based object storage service that allows storage and retrieval of large amounts of data at a very low cost. This makes it an attractive option to store large training datasets. MXNet is deeply integrated with S3 for this purpose. diff --git a/docs/faq/security.md b/docs/faq/security.md index 0615acda3435..05153e20aaf1 100644 --- a/docs/faq/security.md +++ b/docs/faq/security.md @@ -1,3 +1,22 @@ + + # MXNet Security Best Practices MXNet framework has no built-in security protections. It assumes that the MXNet entities involved in model training and inferencing (hosting) are fully trusted. It also assumes that their communications cannot be eavesdropped or tampered with. MXNet consumers shall ensure that the above assumptions are met. diff --git a/docs/faq/smart_device.md b/docs/faq/smart_device.md index 2584b4c36caf..1c4a8919d981 100644 --- a/docs/faq/smart_device.md +++ b/docs/faq/smart_device.md @@ -1,3 +1,22 @@ + + # Deep Learning in a Single File for Smart Devices Deep learning (DL) systems are complex and often depend on a number of libraries. diff --git a/docs/faq/visualize_graph.md b/docs/faq/visualize_graph.md index 06010213242c..4623346a5a81 100644 --- a/docs/faq/visualize_graph.md +++ b/docs/faq/visualize_graph.md @@ -1,3 +1,22 @@ + + # How to visualize Neural Networks as computation graph Here, we'll demonstrate how to use ```mx.viz.plot_network``` diff --git a/docs/faq/why_mxnet.md b/docs/faq/why_mxnet.md old mode 100755 new mode 100644 index ed8cef143070..00f21043cc41 --- a/docs/faq/why_mxnet.md +++ b/docs/faq/why_mxnet.md @@ -1,3 +1,22 @@ + + # Why MXNet? Probably, if you've stumbled upon this page, you've heard of _deep learning_. diff --git a/docs/gluon/index.md b/docs/gluon/index.md index 96e8e36dbf20..b136efbe0ae5 100644 --- a/docs/gluon/index.md +++ b/docs/gluon/index.md @@ -1,3 +1,22 @@ + + # About Gluon ![gluon logo](https://github.com/dmlc/web-data/blob/master/mxnet/image/image-gluon-logo.png?raw=true) diff --git a/docs/index.md b/docs/index.md index ab6a95dc0ddd..1ecdbde909d5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,22 @@ + + # MXNet ```eval_rst diff --git a/docs/install/amazonlinux_setup.md b/docs/install/amazonlinux_setup.md index 42a4fcb0eb89..baac53461ffd 100644 --- a/docs/install/amazonlinux_setup.md +++ b/docs/install/amazonlinux_setup.md @@ -1,3 +1,22 @@ + + diff --git a/docs/install/build_from_source.md b/docs/install/build_from_source.md index e807fb44b599..0effd3b30979 100644 --- a/docs/install/build_from_source.md +++ b/docs/install/build_from_source.md @@ -1,3 +1,22 @@ + + # Build MXNet from Source This document explains how to build MXNet from source code. diff --git a/docs/install/c_plus_plus.md b/docs/install/c_plus_plus.md index 6ad67e2803db..f95bcc645746 100644 --- a/docs/install/c_plus_plus.md +++ b/docs/install/c_plus_plus.md @@ -1,3 +1,22 @@ + + ## Build the C++ package The C++ package has the same prerequisites as the MXNet library. diff --git a/docs/install/centos_setup.md b/docs/install/centos_setup.md index e5efe42a61dd..a42c337c0f91 100644 --- a/docs/install/centos_setup.md +++ b/docs/install/centos_setup.md @@ -1,3 +1,22 @@ + + # Installing MXNet on CentOS and other non-Ubuntu Linux systems Step 1. Install build tools and git on `CentOS >= 7` and `Fedora >= 19`: diff --git a/docs/install/download.md b/docs/install/download.md index d7b9440e0a98..998336731d5f 100644 --- a/docs/install/download.md +++ b/docs/install/download.md @@ -1,3 +1,22 @@ + + # Source Download These source archives are generated from tagged releases. Updates and patches will not have been applied. For any updates refer to the corresponding branches in the [GitHub repository](https://github.com/apache/incubator-mxnet). Choose your flavor of download from the following links: diff --git a/docs/install/index.md b/docs/install/index.md index ad3d083a7d02..c4da719e72d9 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -1,3 +1,22 @@ + + # Installing MXNet ```eval_rst diff --git a/docs/install/java_setup.md b/docs/install/java_setup.md index bd20c9596013..39765730353a 100644 --- a/docs/install/java_setup.md +++ b/docs/install/java_setup.md @@ -1,3 +1,22 @@ + + # Setup the MXNet Package for Java The following instructions are provided for macOS and Ubuntu. Windows is not yet available. diff --git a/docs/install/osx_setup.md b/docs/install/osx_setup.md index 7d90d3d456f6..e39c006b86ee 100644 --- a/docs/install/osx_setup.md +++ b/docs/install/osx_setup.md @@ -1,3 +1,22 @@ + + # Installing MXNet from source on OS X (Mac) **NOTE:** For prebuild MXNet with Python installation, please refer to the [new install guide](http://mxnet.io/install/index.html). diff --git a/docs/install/raspbian_setup.md b/docs/install/raspbian_setup.md index 42a4fcb0eb89..baac53461ffd 100644 --- a/docs/install/raspbian_setup.md +++ b/docs/install/raspbian_setup.md @@ -1,3 +1,22 @@ + + diff --git a/docs/install/scala_setup.md b/docs/install/scala_setup.md index 9ee9ceac3a3c..a09fcc949e8f 100644 --- a/docs/install/scala_setup.md +++ b/docs/install/scala_setup.md @@ -1,3 +1,22 @@ + + # Setup the MXNet Package for Scala The following instructions are provided for macOS and Ubuntu. Windows is not yet available. diff --git a/docs/install/tx2_setup.md b/docs/install/tx2_setup.md index 42a4fcb0eb89..baac53461ffd 100644 --- a/docs/install/tx2_setup.md +++ b/docs/install/tx2_setup.md @@ -1,3 +1,22 @@ + + diff --git a/docs/install/ubuntu_setup.md b/docs/install/ubuntu_setup.md index bf964182b50a..726888f377cb 100644 --- a/docs/install/ubuntu_setup.md +++ b/docs/install/ubuntu_setup.md @@ -1,3 +1,22 @@ + + # Installing MXNet on Ubuntu The following installation instructions are for installing MXNet on computers running **Ubuntu 16.04**. Support for later versions of Ubuntu is [not yet available](#contributions). diff --git a/docs/install/validate_mxnet.md b/docs/install/validate_mxnet.md index dfe8d063f602..1dd4df89b149 100644 --- a/docs/install/validate_mxnet.md +++ b/docs/install/validate_mxnet.md @@ -1,3 +1,22 @@ + + # Validate Your MXNet Installation - [Python](#python) diff --git a/docs/install/windows_setup.md b/docs/install/windows_setup.md old mode 100755 new mode 100644 index b34936140aea..383bca0b9778 --- a/docs/install/windows_setup.md +++ b/docs/install/windows_setup.md @@ -1,3 +1,22 @@ + + # Installing MXNet on Windows The following describes how to install with pip for computers with CPUs, Intel CPUs, and NVIDIA GPUs. Further along in the document you can learn how to build MXNet from source on Windows, or how to install packages that support different language APIs to MXNet. diff --git a/docs/model_zoo/index.md b/docs/model_zoo/index.md index 034d360b985a..0a65a8d68ff8 100644 --- a/docs/model_zoo/index.md +++ b/docs/model_zoo/index.md @@ -1,3 +1,22 @@ + + # MXNet Model Zoo MXNet features fast implementations of many state-of-the-art models reported in the academic literature. This Model Zoo is an diff --git a/docs/settings.ini b/docs/settings.ini index e16177604e8d..ec64dd784cdb 100644 --- a/docs/settings.ini +++ b/docs/settings.ini @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + [mxnet] build_mxnet = 0 diff --git a/docs/tutorials/basic/data.md b/docs/tutorials/basic/data.md index 4a682e83f9fe..e62ea4fa9737 100644 --- a/docs/tutorials/basic/data.md +++ b/docs/tutorials/basic/data.md @@ -1,3 +1,22 @@ + + # Iterators - Loading data In this tutorial, we focus on how to feed data into a training or inference program. Most training and inference modules in MXNet accept data iterators, diff --git a/docs/tutorials/basic/index.md b/docs/tutorials/basic/index.md index 87d72894424f..aab7731342f7 100644 --- a/docs/tutorials/basic/index.md +++ b/docs/tutorials/basic/index.md @@ -1,3 +1,22 @@ + + # Tutorials ```eval_rst diff --git a/docs/tutorials/basic/module.md b/docs/tutorials/basic/module.md index f7a4d6e25de7..67f5d8aecd1f 100644 --- a/docs/tutorials/basic/module.md +++ b/docs/tutorials/basic/module.md @@ -1,3 +1,22 @@ + + # Module - Neural network training and inference diff --git a/docs/tutorials/basic/ndarray.md b/docs/tutorials/basic/ndarray.md index 2c171f2627e8..00cac64dd6ba 100644 --- a/docs/tutorials/basic/ndarray.md +++ b/docs/tutorials/basic/ndarray.md @@ -1,3 +1,22 @@ + + # NDArray - Imperative tensor operations on CPU/GPU In _MXNet_, `NDArray` is the core data structure for all mathematical diff --git a/docs/tutorials/basic/ndarray_indexing.md b/docs/tutorials/basic/ndarray_indexing.md index 35dd8c17f675..e06e5cb4482d 100644 --- a/docs/tutorials/basic/ndarray_indexing.md +++ b/docs/tutorials/basic/ndarray_indexing.md @@ -1,3 +1,22 @@ + + # NDArray Indexing - Array indexing features diff --git a/docs/tutorials/basic/reshape_transpose.md b/docs/tutorials/basic/reshape_transpose.md index 999b22ca2f7e..7407920b0aea 100644 --- a/docs/tutorials/basic/reshape_transpose.md +++ b/docs/tutorials/basic/reshape_transpose.md @@ -1,3 +1,22 @@ + + ## Difference between reshape and transpose operators What does it mean if MXNet gives you an error like the this? diff --git a/docs/tutorials/basic/symbol.md b/docs/tutorials/basic/symbol.md index 5e1e3cd8c62f..5642bab74d64 100644 --- a/docs/tutorials/basic/symbol.md +++ b/docs/tutorials/basic/symbol.md @@ -1,3 +1,22 @@ + + # Symbol - Neural network graphs In a [previous tutorial](http://mxnet.io/tutorials/basic/ndarray.html), we introduced `NDArray`, diff --git a/docs/tutorials/c++/basics.md b/docs/tutorials/c++/basics.md index aa73a7363b1c..a960b1817635 100644 --- a/docs/tutorials/c++/basics.md +++ b/docs/tutorials/c++/basics.md @@ -1,3 +1,22 @@ + + Basics ====== diff --git a/docs/tutorials/c++/index.md b/docs/tutorials/c++/index.md index 87d72894424f..aab7731342f7 100644 --- a/docs/tutorials/c++/index.md +++ b/docs/tutorials/c++/index.md @@ -1,3 +1,22 @@ + + # Tutorials ```eval_rst diff --git a/docs/tutorials/c++/mxnet_cpp_inference_tutorial.md b/docs/tutorials/c++/mxnet_cpp_inference_tutorial.md index ab55a0e787f1..c408b8a06f52 100644 --- a/docs/tutorials/c++/mxnet_cpp_inference_tutorial.md +++ b/docs/tutorials/c++/mxnet_cpp_inference_tutorial.md @@ -1,3 +1,22 @@ + + # MXNet C++ API inference tutorial ## Overview diff --git a/docs/tutorials/c++/subgraphAPI.md b/docs/tutorials/c++/subgraphAPI.md index 0ae4341b287c..a830bcbcf422 100644 --- a/docs/tutorials/c++/subgraphAPI.md +++ b/docs/tutorials/c++/subgraphAPI.md @@ -1,3 +1,22 @@ + + ## Subgraph API The subgraph API has been proposed and implemented as the default mechanism for integrating backend libraries to MXNet. The subgraph API is a very flexible interface. Although it was proposed as an integration mechanism, it has been used as a tool for manipulating NNVM graphs for graph-level optimizations, such as operator fusion. diff --git a/docs/tutorials/control_flow/ControlFlowTutorial.md b/docs/tutorials/control_flow/ControlFlowTutorial.md index 4b6a23136b5d..173027b13bcf 100644 --- a/docs/tutorials/control_flow/ControlFlowTutorial.md +++ b/docs/tutorials/control_flow/ControlFlowTutorial.md @@ -1,3 +1,22 @@ + + # Hybridize Gluon models with control flows. MXNet currently provides three control flow operators: `cond`, `foreach` and `while_loop`. Like other MXNet operators, they all have a version for NDArray and a version for Symbol. These two versions have exactly the same semantics. We can take advantage of this and use them in Gluon to hybridize models. diff --git a/docs/tutorials/control_flow/index.md b/docs/tutorials/control_flow/index.md index 87d72894424f..aab7731342f7 100644 --- a/docs/tutorials/control_flow/index.md +++ b/docs/tutorials/control_flow/index.md @@ -1,3 +1,22 @@ + + # Tutorials ```eval_rst diff --git a/docs/tutorials/embedded/index.md b/docs/tutorials/embedded/index.md index 87d72894424f..aab7731342f7 100644 --- a/docs/tutorials/embedded/index.md +++ b/docs/tutorials/embedded/index.md @@ -1,3 +1,22 @@ + + # Tutorials ```eval_rst diff --git a/docs/tutorials/embedded/wine_detector.md b/docs/tutorials/embedded/wine_detector.md index 65e6fbaa4d91..b59a52bd8649 100644 --- a/docs/tutorials/embedded/wine_detector.md +++ b/docs/tutorials/embedded/wine_detector.md @@ -1,3 +1,22 @@ + + # Real-time Object Detection with MXNet On The Raspberry Pi This tutorial shows developers who work with the Raspberry Pi or similar embedded ARM-based devices how to compile MXNet for those devices and run a pretrained deep network model. It also shows how to use AWS IoT to manage and monitor MXNet models running on your devices. diff --git a/docs/tutorials/gluon/autograd.md b/docs/tutorials/gluon/autograd.md index 4b296dd2dd5b..495db34de825 100644 --- a/docs/tutorials/gluon/autograd.md +++ b/docs/tutorials/gluon/autograd.md @@ -1,3 +1,22 @@ + + # Automatic differentiation MXNet supports automatic differentiation with the `autograd` package. diff --git a/docs/tutorials/gluon/custom_layer.md b/docs/tutorials/gluon/custom_layer.md index 97bdf05aff58..a45622d175cc 100644 --- a/docs/tutorials/gluon/custom_layer.md +++ b/docs/tutorials/gluon/custom_layer.md @@ -1,3 +1,22 @@ + + # How to write a custom layer in Apache MxNet Gluon API diff --git a/docs/tutorials/gluon/customop.md b/docs/tutorials/gluon/customop.md index df10788d6788..5552093484ba 100644 --- a/docs/tutorials/gluon/customop.md +++ b/docs/tutorials/gluon/customop.md @@ -1,3 +1,22 @@ + + # Creating custom operators with numpy diff --git a/docs/tutorials/gluon/data_augmentation.md b/docs/tutorials/gluon/data_augmentation.md index df7462c33044..ce631cea5fbf 100644 --- a/docs/tutorials/gluon/data_augmentation.md +++ b/docs/tutorials/gluon/data_augmentation.md @@ -1,3 +1,22 @@ + + # Methods of applying data augmentation (Gluon API) Data Augmentation is a regularization technique that's used to avoid overfitting when training Machine Learning models. Although the technique can be applied in a variety of domains, it's very common in Computer Vision. Adjustments are made to the original images in the training dataset before being used in training. Some example adjustments include translating, cropping, scaling, rotating, changing brightness and contrast. We do this to reduce the dependence of the model on spurious characteristics; e.g. training data may only contain faces that fill 1/4 of the image, so the model trained without data augmentation might unhelpfully learn that faces can only be of this size. diff --git a/docs/tutorials/gluon/datasets.md b/docs/tutorials/gluon/datasets.md index 0b0038def633..94b27bbbd331 100644 --- a/docs/tutorials/gluon/datasets.md +++ b/docs/tutorials/gluon/datasets.md @@ -1,3 +1,22 @@ + + # Gluon `Dataset`s and `DataLoader` diff --git a/docs/tutorials/gluon/gluon.md b/docs/tutorials/gluon/gluon.md index 518e99905c04..6cf27ff603d2 100644 --- a/docs/tutorials/gluon/gluon.md +++ b/docs/tutorials/gluon/gluon.md @@ -1,3 +1,22 @@ + + # Gluon - Neural network building blocks Gluon package is a high-level interface for MXNet designed to be easy to use while diff --git a/docs/tutorials/gluon/gluon_from_experiment_to_deployment.md b/docs/tutorials/gluon/gluon_from_experiment_to_deployment.md index 36c7a2e4dafa..06d9d0250e41 100644 --- a/docs/tutorials/gluon/gluon_from_experiment_to_deployment.md +++ b/docs/tutorials/gluon/gluon_from_experiment_to_deployment.md @@ -1,3 +1,22 @@ + + # Gluon: from experiment to deployment, an end to end tutorial diff --git a/docs/tutorials/gluon/gotchas_numpy_in_mxnet.md b/docs/tutorials/gluon/gotchas_numpy_in_mxnet.md index c82c63edbc2b..4b2fa95ce885 100644 --- a/docs/tutorials/gluon/gotchas_numpy_in_mxnet.md +++ b/docs/tutorials/gluon/gotchas_numpy_in_mxnet.md @@ -1,3 +1,22 @@ + + # Gotchas using NumPy in Apache MXNet diff --git a/docs/tutorials/gluon/hybrid.md b/docs/tutorials/gluon/hybrid.md index 17e9e1b20d74..c79f79692637 100644 --- a/docs/tutorials/gluon/hybrid.md +++ b/docs/tutorials/gluon/hybrid.md @@ -1,3 +1,22 @@ + + # Hybrid - Faster training and easy deployment *Related Content:* diff --git a/docs/tutorials/gluon/index.md b/docs/tutorials/gluon/index.md index 87d72894424f..aab7731342f7 100644 --- a/docs/tutorials/gluon/index.md +++ b/docs/tutorials/gluon/index.md @@ -1,3 +1,22 @@ + + # Tutorials ```eval_rst diff --git a/docs/tutorials/gluon/info_gan.md b/docs/tutorials/gluon/info_gan.md index 8b2668ab22e6..2b8cdfe3fc4e 100644 --- a/docs/tutorials/gluon/info_gan.md +++ b/docs/tutorials/gluon/info_gan.md @@ -1,3 +1,22 @@ + + # Image similarity search with InfoGAN diff --git a/docs/tutorials/gluon/learning_rate_finder.md b/docs/tutorials/gluon/learning_rate_finder.md index b571a53f674c..b4627f25bc39 100644 --- a/docs/tutorials/gluon/learning_rate_finder.md +++ b/docs/tutorials/gluon/learning_rate_finder.md @@ -1,3 +1,22 @@ + + # Learning Rate Finder diff --git a/docs/tutorials/gluon/learning_rate_schedules.md b/docs/tutorials/gluon/learning_rate_schedules.md index 88b109e7f33e..3416ab44f992 100644 --- a/docs/tutorials/gluon/learning_rate_schedules.md +++ b/docs/tutorials/gluon/learning_rate_schedules.md @@ -1,3 +1,22 @@ + + # Learning Rate Schedules diff --git a/docs/tutorials/gluon/learning_rate_schedules_advanced.md b/docs/tutorials/gluon/learning_rate_schedules_advanced.md index bdaf0a9ba38d..0d933997a2bb 100644 --- a/docs/tutorials/gluon/learning_rate_schedules_advanced.md +++ b/docs/tutorials/gluon/learning_rate_schedules_advanced.md @@ -1,3 +1,22 @@ + + # Advanced Learning Rate Schedules diff --git a/docs/tutorials/gluon/logistic_regression_explained.md b/docs/tutorials/gluon/logistic_regression_explained.md index 577a91413b33..93a93ccc9c32 100644 --- a/docs/tutorials/gluon/logistic_regression_explained.md +++ b/docs/tutorials/gluon/logistic_regression_explained.md @@ -1,3 +1,22 @@ + + # Logistic regression using Gluon API explained diff --git a/docs/tutorials/gluon/mnist.md b/docs/tutorials/gluon/mnist.md index 35fb40521f62..aa1efccfb653 100644 --- a/docs/tutorials/gluon/mnist.md +++ b/docs/tutorials/gluon/mnist.md @@ -1,3 +1,22 @@ + + # Hand-written Digit Recognition In this tutorial, we'll give you a step-by-step walkthrough of building a hand-written digit classifier using the [MNIST](https://en.wikipedia.org/wiki/MNIST_database) dataset. diff --git a/docs/tutorials/gluon/naming.md b/docs/tutorials/gluon/naming.md index 3606a03dcbd2..16383d309fc5 100644 --- a/docs/tutorials/gluon/naming.md +++ b/docs/tutorials/gluon/naming.md @@ -1,3 +1,22 @@ + + # Naming of Gluon Parameter and Blocks diff --git a/docs/tutorials/gluon/ndarray.md b/docs/tutorials/gluon/ndarray.md index 7cf08a88cbf3..f4bae9494454 100644 --- a/docs/tutorials/gluon/ndarray.md +++ b/docs/tutorials/gluon/ndarray.md @@ -1,3 +1,22 @@ + + # NDArray - Scientific computing on CPU and GPU NDArray is a tensor data structure similar to numpy's multi-dimensional array. diff --git a/docs/tutorials/gluon/pretrained_models.md b/docs/tutorials/gluon/pretrained_models.md index 0de5fdd0b44f..796fe05e731e 100644 --- a/docs/tutorials/gluon/pretrained_models.md +++ b/docs/tutorials/gluon/pretrained_models.md @@ -1,3 +1,22 @@ + + # Using pre-trained models in MXNet diff --git a/docs/tutorials/gluon/save_load_params.md b/docs/tutorials/gluon/save_load_params.md index ebc8103e7b45..feaf5eaf8547 100644 --- a/docs/tutorials/gluon/save_load_params.md +++ b/docs/tutorials/gluon/save_load_params.md @@ -1,3 +1,22 @@ + + # Saving and Loading Gluon Models Training large models take a lot of time and it is a good idea to save the trained models to files to avoid training them again and again. There are a number of reasons to do this. For example, you might want to do inference on a machine that is different from the one where the model was trained. Sometimes model's performance on validation set decreases towards the end of the training because of overfitting. If you saved your model parameters after every epoch, at the end you can decide to use the model that performs best on the validation set. Another reason would be to train your model using one language (like Python that has a lot of tools for training) and run inference using a different language (like Scala probably because your application is built on Scala). diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md index cad9099fcc71..562c66170a01 100644 --- a/docs/tutorials/index.md +++ b/docs/tutorials/index.md @@ -1,3 +1,22 @@ + + # Tutorials ```eval_rst diff --git a/docs/tutorials/java/index.md b/docs/tutorials/java/index.md index 87d72894424f..aab7731342f7 100644 --- a/docs/tutorials/java/index.md +++ b/docs/tutorials/java/index.md @@ -1,3 +1,22 @@ + + # Tutorials ```eval_rst diff --git a/docs/tutorials/java/mxnet_java_on_intellij.md b/docs/tutorials/java/mxnet_java_on_intellij.md index ef2c009f66e8..b36ee3cb0ebc 100644 --- a/docs/tutorials/java/mxnet_java_on_intellij.md +++ b/docs/tutorials/java/mxnet_java_on_intellij.md @@ -1,3 +1,22 @@ + + # Run MXNet Java Examples Using the IntelliJ IDE (macOS) This tutorial guides you through setting up a simple Java project in IntelliJ IDE on macOS and demonstrates usage of the MXNet Java APIs. diff --git a/docs/tutorials/java/ssd_inference.md b/docs/tutorials/java/ssd_inference.md index 3a20329f9a91..b61fe97036ef 100644 --- a/docs/tutorials/java/ssd_inference.md +++ b/docs/tutorials/java/ssd_inference.md @@ -1,3 +1,22 @@ + + # Multi Object Detection using pre-trained SSD Model via Java Inference APIs This tutorial shows how to use MXNet Java Inference APIs to run inference on a pre-trained Single Shot Detector (SSD) Model. diff --git a/docs/tutorials/nlp/cnn.md b/docs/tutorials/nlp/cnn.md index b3d7d0d38941..128f5caaae26 100644 --- a/docs/tutorials/nlp/cnn.md +++ b/docs/tutorials/nlp/cnn.md @@ -1,3 +1,22 @@ + + # Text Classification Using a Convolutional Neural Network on MXNet This tutorial is based of Yoon Kim's [paper](https://arxiv.org/abs/1408.5882) on using convolutional neural networks for sentence sentiment classification. The tutorial has been tested on MXNet 1.0 running under Python 2.7 and Python 3.6. diff --git a/docs/tutorials/nlp/index.md b/docs/tutorials/nlp/index.md index 87d72894424f..aab7731342f7 100644 --- a/docs/tutorials/nlp/index.md +++ b/docs/tutorials/nlp/index.md @@ -1,3 +1,22 @@ + + # Tutorials ```eval_rst diff --git a/docs/tutorials/onnx/export_mxnet_to_onnx.md b/docs/tutorials/onnx/export_mxnet_to_onnx.md index 3f925c7b5b84..6190b9242a74 100644 --- a/docs/tutorials/onnx/export_mxnet_to_onnx.md +++ b/docs/tutorials/onnx/export_mxnet_to_onnx.md @@ -1,3 +1,22 @@ + + # Exporting MXNet model to ONNX format diff --git a/docs/tutorials/onnx/fine_tuning_gluon.md b/docs/tutorials/onnx/fine_tuning_gluon.md index 750a6757272f..70c1469afa94 100644 --- a/docs/tutorials/onnx/fine_tuning_gluon.md +++ b/docs/tutorials/onnx/fine_tuning_gluon.md @@ -1,3 +1,22 @@ + + # Fine-tuning an ONNX model with MXNet/Gluon diff --git a/docs/tutorials/onnx/index.md b/docs/tutorials/onnx/index.md index 87d72894424f..aab7731342f7 100644 --- a/docs/tutorials/onnx/index.md +++ b/docs/tutorials/onnx/index.md @@ -1,3 +1,22 @@ + + # Tutorials ```eval_rst diff --git a/docs/tutorials/onnx/inference_on_onnx_model.md b/docs/tutorials/onnx/inference_on_onnx_model.md index b2522ad0c1f1..f500956f72c6 100644 --- a/docs/tutorials/onnx/inference_on_onnx_model.md +++ b/docs/tutorials/onnx/inference_on_onnx_model.md @@ -1,3 +1,22 @@ + + # Running inference on MXNet/Gluon from an ONNX model diff --git a/docs/tutorials/onnx/super_resolution.md b/docs/tutorials/onnx/super_resolution.md index 36c06b743c8e..d9825090e8ee 100644 --- a/docs/tutorials/onnx/super_resolution.md +++ b/docs/tutorials/onnx/super_resolution.md @@ -1,3 +1,22 @@ + + # Importing an ONNX model into MXNet In this tutorial we will: diff --git a/docs/tutorials/python/data_augmentation.md b/docs/tutorials/python/data_augmentation.md index e4dbbb672997..1034f621ba6f 100644 --- a/docs/tutorials/python/data_augmentation.md +++ b/docs/tutorials/python/data_augmentation.md @@ -1,3 +1,22 @@ + + # Methods of applying data augmentation (Module API) Data Augmentation is a regularization technique that's used to avoid overfitting when training Machine Learning models. Although the technique can be applied in a variety of domains, it's very common in Computer Vision. Adjustments are made to the original images in the training dataset before being used in training. Some example adjustments include translating, cropping, scaling, rotating, changing brightness and contrast. We do this to reduce the dependence of the model on spurious characteristics; e.g. training data may only contain faces that fill 1/4 of the image, so the model trained without data augmentation might unhelpfully learn that faces can only be of this size. diff --git a/docs/tutorials/python/data_augmentation_with_masks.md b/docs/tutorials/python/data_augmentation_with_masks.md index ac587ac2f5e2..080708caedb1 100644 --- a/docs/tutorials/python/data_augmentation_with_masks.md +++ b/docs/tutorials/python/data_augmentation_with_masks.md @@ -1,3 +1,22 @@ + + # Data Augmentation with Masks diff --git a/docs/tutorials/python/index.md b/docs/tutorials/python/index.md index 87d72894424f..aab7731342f7 100644 --- a/docs/tutorials/python/index.md +++ b/docs/tutorials/python/index.md @@ -1,3 +1,22 @@ + + # Tutorials ```eval_rst diff --git a/docs/tutorials/python/kvstore.md b/docs/tutorials/python/kvstore.md index 3e6bbf12c393..593c240ad17c 100644 --- a/docs/tutorials/python/kvstore.md +++ b/docs/tutorials/python/kvstore.md @@ -1,3 +1,22 @@ + + # Distributed Key-Value Store KVStore is a place for data sharing. Think of it as a single object shared diff --git a/docs/tutorials/python/linear-regression.md b/docs/tutorials/python/linear-regression.md index fd336ad2aed5..77ca7f9a7ceb 100644 --- a/docs/tutorials/python/linear-regression.md +++ b/docs/tutorials/python/linear-regression.md @@ -1,3 +1,22 @@ + + # Linear Regression In this tutorial we'll walk through how one can implement *linear regression* using MXNet APIs. diff --git a/docs/tutorials/python/matrix_factorization.md b/docs/tutorials/python/matrix_factorization.md index 154fa4b3e127..62674e7ad646 100644 --- a/docs/tutorials/python/matrix_factorization.md +++ b/docs/tutorials/python/matrix_factorization.md @@ -1,3 +1,22 @@ + + # Matrix Factorization In a recommendation system, there is a group of users and a set of items. Given diff --git a/docs/tutorials/python/mnist.md b/docs/tutorials/python/mnist.md index df949d487b63..a8eee40e095e 100644 --- a/docs/tutorials/python/mnist.md +++ b/docs/tutorials/python/mnist.md @@ -1,3 +1,22 @@ + + # Handwritten Digit Recognition In this tutorial, we'll give you a step by step walk-through of how to build a hand-written digit classifier using the [MNIST](https://en.wikipedia.org/wiki/MNIST_database) dataset. For someone new to deep learning, this exercise is arguably the "Hello World" equivalent. diff --git a/docs/tutorials/python/predict_image.md b/docs/tutorials/python/predict_image.md index 8be98d991366..e02db165d7f6 100644 --- a/docs/tutorials/python/predict_image.md +++ b/docs/tutorials/python/predict_image.md @@ -1,3 +1,22 @@ + + # Predict with pre-trained models This tutorial explains how to recognize objects in an image with a pre-trained model, and how to perform feature extraction. diff --git a/docs/tutorials/python/profiler.md b/docs/tutorials/python/profiler.md index 7dcda10f11b8..1d6c0b2fc7f6 100644 --- a/docs/tutorials/python/profiler.md +++ b/docs/tutorials/python/profiler.md @@ -1,3 +1,22 @@ + + # Profiling MXNet Models It is often helpful to understand what operations take how much time while running a model. This helps optimize the model to run faster. In this tutorial, we will learn how to profile MXNet models to measure their running time and memory consumption using the MXNet profiler. diff --git a/docs/tutorials/python/types_of_data_augmentation.md b/docs/tutorials/python/types_of_data_augmentation.md index 4308932bf483..344f3cd4d34a 100644 --- a/docs/tutorials/python/types_of_data_augmentation.md +++ b/docs/tutorials/python/types_of_data_augmentation.md @@ -1,3 +1,22 @@ + + # Types of Data Augmentation diff --git a/docs/tutorials/r/CallbackFunction.md b/docs/tutorials/r/CallbackFunction.md index 103352dd2907..f3156cd969e8 100644 --- a/docs/tutorials/r/CallbackFunction.md +++ b/docs/tutorials/r/CallbackFunction.md @@ -1,3 +1,22 @@ + + Callback Function ====================================== diff --git a/docs/tutorials/r/CustomIterator.md b/docs/tutorials/r/CustomIterator.md index 1ad634bcd669..62a618a51590 100644 --- a/docs/tutorials/r/CustomIterator.md +++ b/docs/tutorials/r/CustomIterator.md @@ -1,3 +1,22 @@ + + Custom Iterator Tutorial ====================================== diff --git a/docs/tutorials/r/CustomLossFunction.md b/docs/tutorials/r/CustomLossFunction.md index afb99518894c..87ac40dafc63 100644 --- a/docs/tutorials/r/CustomLossFunction.md +++ b/docs/tutorials/r/CustomLossFunction.md @@ -1,3 +1,22 @@ + + Customized loss function ====================================== diff --git a/docs/tutorials/r/MultidimLstm.md b/docs/tutorials/r/MultidimLstm.md index 8692086d180b..49a07361c9d4 100644 --- a/docs/tutorials/r/MultidimLstm.md +++ b/docs/tutorials/r/MultidimLstm.md @@ -1,3 +1,22 @@ + + LSTM time series example ============================================= diff --git a/docs/tutorials/r/charRnnModel.md b/docs/tutorials/r/charRnnModel.md index cb21e77559b5..f0d1f9e4d1fb 100644 --- a/docs/tutorials/r/charRnnModel.md +++ b/docs/tutorials/r/charRnnModel.md @@ -1,3 +1,22 @@ + + # Character-level Language Model using RNN diff --git a/docs/tutorials/r/classifyRealImageWithPretrainedModel.md b/docs/tutorials/r/classifyRealImageWithPretrainedModel.md index b2f2035426ec..8a7daf87e4f1 100644 --- a/docs/tutorials/r/classifyRealImageWithPretrainedModel.md +++ b/docs/tutorials/r/classifyRealImageWithPretrainedModel.md @@ -1,3 +1,22 @@ + + Classify Images with a PreTrained Model ================================================= MXNet is a flexible and efficient deep learning framework. One of the interesting things that a deep learning diff --git a/docs/tutorials/r/fiveMinutesNeuralNetwork.md b/docs/tutorials/r/fiveMinutesNeuralNetwork.md index 6d79cd288d2c..56688a65338e 100644 --- a/docs/tutorials/r/fiveMinutesNeuralNetwork.md +++ b/docs/tutorials/r/fiveMinutesNeuralNetwork.md @@ -1,3 +1,22 @@ + + Develop a Neural Network with MXNet in Five Minutes ============================================= diff --git a/docs/tutorials/r/index.md b/docs/tutorials/r/index.md index fbc8911f2a6d..6ab039561886 100644 --- a/docs/tutorials/r/index.md +++ b/docs/tutorials/r/index.md @@ -1,3 +1,22 @@ + + # R Tutorials These tutorials introduce a few fundamental concepts in deep learning and how to implement them in R using _MXNet_. diff --git a/docs/tutorials/r/mnistCompetition.md b/docs/tutorials/r/mnistCompetition.md index ed3c2827011d..95efbfd6d7af 100644 --- a/docs/tutorials/r/mnistCompetition.md +++ b/docs/tutorials/r/mnistCompetition.md @@ -1,3 +1,22 @@ + + Handwritten Digits Classification Competition ============================================= diff --git a/docs/tutorials/r/ndarray.md b/docs/tutorials/r/ndarray.md index cb7639a8a44d..30f5d887a3b6 100644 --- a/docs/tutorials/r/ndarray.md +++ b/docs/tutorials/r/ndarray.md @@ -1,3 +1,22 @@ + + # NDArray: Vectorized Tensor Computations on CPUs and GPUs `NDArray` is the basic vectorized operation unit in MXNet for matrix and tensor computations. diff --git a/docs/tutorials/r/symbol.md b/docs/tutorials/r/symbol.md index 4a87643b9f50..0ab560856bb4 100644 --- a/docs/tutorials/r/symbol.md +++ b/docs/tutorials/r/symbol.md @@ -1,3 +1,22 @@ + + # Symbol and Automatic Differentiation The computational unit `NDArray` requires a way to construct neural networks. MXNet provides a symbolic interface, named Symbol, to do this. Symbol combines both flexibility and efficiency. diff --git a/docs/tutorials/scala/char_lstm.md b/docs/tutorials/scala/char_lstm.md index 4d6a5aee921e..fafd5d5a0bd9 100644 --- a/docs/tutorials/scala/char_lstm.md +++ b/docs/tutorials/scala/char_lstm.md @@ -1,3 +1,22 @@ + + # Developing a Character-level Language model This tutorial shows how to train a character-level language model with a multilayer recurrent neural network (RNN) using Scala. This model takes one text file as input and trains an RNN that learns to predict the next character in the sequence. In this tutorial, you train a multilayer LSTM (Long Short-Term Memory) network that generates relevant text using Barack Obama's speech patterns. diff --git a/docs/tutorials/scala/index.md b/docs/tutorials/scala/index.md index f14337f90f08..55e41e428d38 100644 --- a/docs/tutorials/scala/index.md +++ b/docs/tutorials/scala/index.md @@ -1,3 +1,22 @@ + + # MXNet-Scala Tutorials ## Installation & Setup diff --git a/docs/tutorials/scala/mnist.md b/docs/tutorials/scala/mnist.md index 79f2129ef0ef..1f05fb464fb0 100644 --- a/docs/tutorials/scala/mnist.md +++ b/docs/tutorials/scala/mnist.md @@ -1,3 +1,22 @@ + + # Handwritten Digit Recognition This Scala tutorial guides you through a classic computer vision application: identifying hand written digits. diff --git a/docs/tutorials/scala/mxnet_scala_on_intellij.md b/docs/tutorials/scala/mxnet_scala_on_intellij.md index 769a6b4fe506..cae70567de4d 100644 --- a/docs/tutorials/scala/mxnet_scala_on_intellij.md +++ b/docs/tutorials/scala/mxnet_scala_on_intellij.md @@ -1,3 +1,22 @@ + + # Run MXNet Scala Examples Using the IntelliJ IDE (macOS) This tutorial guides you through setting up a Scala project in the IntelliJ IDE on macOS, and shows how to use the MXNet package from your application. diff --git a/docs/tutorials/sparse/csr.md b/docs/tutorials/sparse/csr.md index 0aede1ab4313..f1718687cfb0 100644 --- a/docs/tutorials/sparse/csr.md +++ b/docs/tutorials/sparse/csr.md @@ -1,3 +1,22 @@ + + # CSRNDArray - NDArray in Compressed Sparse Row Storage Format diff --git a/docs/tutorials/sparse/index.md b/docs/tutorials/sparse/index.md index 87d72894424f..aab7731342f7 100644 --- a/docs/tutorials/sparse/index.md +++ b/docs/tutorials/sparse/index.md @@ -1,3 +1,22 @@ + + # Tutorials ```eval_rst diff --git a/docs/tutorials/sparse/row_sparse.md b/docs/tutorials/sparse/row_sparse.md index 46a5edad075e..2986c4d3ab8f 100644 --- a/docs/tutorials/sparse/row_sparse.md +++ b/docs/tutorials/sparse/row_sparse.md @@ -1,3 +1,22 @@ + + # RowSparseNDArray - NDArray for Sparse Gradient Updates diff --git a/docs/tutorials/sparse/train.md b/docs/tutorials/sparse/train.md index fde4c0e65521..d22fbe9e8f0c 100644 --- a/docs/tutorials/sparse/train.md +++ b/docs/tutorials/sparse/train.md @@ -1,3 +1,22 @@ + + # Train a Linear Regression Model with Sparse Symbols In previous tutorials, we introduced `CSRNDArray` and `RowSparseNDArray`, diff --git a/docs/tutorials/speech_recognition/ctc.md b/docs/tutorials/speech_recognition/ctc.md index 0b01fb48999c..3f1b8d4ff9f7 100644 --- a/docs/tutorials/speech_recognition/ctc.md +++ b/docs/tutorials/speech_recognition/ctc.md @@ -1,3 +1,22 @@ + + # Connectionist Temporal Classification ```python diff --git a/docs/tutorials/speech_recognition/index.md b/docs/tutorials/speech_recognition/index.md index 87d72894424f..aab7731342f7 100644 --- a/docs/tutorials/speech_recognition/index.md +++ b/docs/tutorials/speech_recognition/index.md @@ -1,3 +1,22 @@ + + # Tutorials ```eval_rst diff --git a/docs/tutorials/tensorrt/index.md b/docs/tutorials/tensorrt/index.md index 9515a5b9fd1e..d3dcaeb9db84 100644 --- a/docs/tutorials/tensorrt/index.md +++ b/docs/tutorials/tensorrt/index.md @@ -1,3 +1,22 @@ + + # Tutorials ```eval_rst diff --git a/docs/tutorials/tensorrt/inference_with_trt.md b/docs/tutorials/tensorrt/inference_with_trt.md index 489a92ec1014..77f82a7a1039 100644 --- a/docs/tutorials/tensorrt/inference_with_trt.md +++ b/docs/tutorials/tensorrt/inference_with_trt.md @@ -1,3 +1,22 @@ + + # Optimizing Deep Learning Computation Graphs with TensorRT NVIDIA's TensorRT is a deep learning library that has been shown to provide large speedups when used for network inference. MXNet 1.3.0 is shipping with experimental integrated support for TensorRT. This means MXNet users can noew make use of this acceleration library to efficiently run their networks. In this blog post we'll see how to install, enable and run TensorRT with MXNet. We'll also give some insight into what is happening behind the scenes in MXNet to enable TensorRT graph execution. diff --git a/docs/tutorials/unsupervised_learning/gan.md b/docs/tutorials/unsupervised_learning/gan.md index 0efdc5565519..9c50fcfdf15b 100644 --- a/docs/tutorials/unsupervised_learning/gan.md +++ b/docs/tutorials/unsupervised_learning/gan.md @@ -1,3 +1,22 @@ + + # Generative Adversarial Network (GAN) diff --git a/docs/tutorials/unsupervised_learning/index.md b/docs/tutorials/unsupervised_learning/index.md index 87d72894424f..aab7731342f7 100644 --- a/docs/tutorials/unsupervised_learning/index.md +++ b/docs/tutorials/unsupervised_learning/index.md @@ -1,3 +1,22 @@ + + # Tutorials ```eval_rst diff --git a/docs/tutorials/vision/cnn_visualization.md b/docs/tutorials/vision/cnn_visualization.md index 5ded6f1587e0..f528d35bfd32 100644 --- a/docs/tutorials/vision/cnn_visualization.md +++ b/docs/tutorials/vision/cnn_visualization.md @@ -1,3 +1,22 @@ + + # Visualizing Decisions of Convolutional Neural Networks Convolutional Neural Networks have made a lot of progress in Computer Vision. Their accuracy is as good as humans in some tasks. However, it remains difficult to explain the predictions of convolutional neural networks, as they lack the interpretability offered by other models such as decision trees. diff --git a/docs/tutorials/vision/index.md b/docs/tutorials/vision/index.md index 87d72894424f..aab7731342f7 100644 --- a/docs/tutorials/vision/index.md +++ b/docs/tutorials/vision/index.md @@ -1,3 +1,22 @@ + + # Tutorials ```eval_rst diff --git a/docs/tutorials/vision/large_scale_classification.md b/docs/tutorials/vision/large_scale_classification.md index aac03e4dd903..5fa87b14821d 100644 --- a/docs/tutorials/vision/large_scale_classification.md +++ b/docs/tutorials/vision/large_scale_classification.md @@ -1,3 +1,22 @@ + + # Large Scale Image Classification Training a neural network with a large number of images presents several challenges. Even with the latest GPUs, it is not possible to train large networks using a large number of images in a reasonable amount of time using a single GPU. This problem can be somewhat mitigated by using multiple GPUs in a single machine. But there is a limit to the number of GPUs that can be attached to one machine (typically 8 or 16). This tutorial explains how to train large networks with terabytes of data using multiple machines each containing multiple GPUs. diff --git a/julia/docs/src/api.md b/julia/docs/src/api.md index 4984129863d0..92c04581c7e8 100644 --- a/julia/docs/src/api.md +++ b/julia/docs/src/api.md @@ -1,3 +1,22 @@ + + # API Documentation ```@contents diff --git a/julia/docs/src/api/callback.md b/julia/docs/src/api/callback.md index f67811cc41fe..327014d7dbfc 100644 --- a/julia/docs/src/api/callback.md +++ b/julia/docs/src/api/callback.md @@ -1,3 +1,22 @@ + + # Callback in training ```@autodocs diff --git a/julia/docs/src/api/context.md b/julia/docs/src/api/context.md index 93ccf83e51ba..e82504663b06 100644 --- a/julia/docs/src/api/context.md +++ b/julia/docs/src/api/context.md @@ -1,3 +1,22 @@ + + # Context ```@autodocs diff --git a/julia/docs/src/api/executor.md b/julia/docs/src/api/executor.md index b560c7a0864d..81ce7fa17ef7 100644 --- a/julia/docs/src/api/executor.md +++ b/julia/docs/src/api/executor.md @@ -1,3 +1,22 @@ + + # Executor ```@autodocs diff --git a/julia/docs/src/api/initializer.md b/julia/docs/src/api/initializer.md index d0aad2def4cd..8f55b6e1da51 100644 --- a/julia/docs/src/api/initializer.md +++ b/julia/docs/src/api/initializer.md @@ -1,3 +1,22 @@ + + # Initializer ```@autodocs diff --git a/julia/docs/src/api/io.md b/julia/docs/src/api/io.md index 7312259dbf3c..bd53d2ca667e 100644 --- a/julia/docs/src/api/io.md +++ b/julia/docs/src/api/io.md @@ -1,3 +1,22 @@ + + # Data Providers Data providers are wrappers that load external data, be it images, text, or general tensors, diff --git a/julia/docs/src/api/kvstore.md b/julia/docs/src/api/kvstore.md index 34a5027f85fb..a8407b54bd34 100644 --- a/julia/docs/src/api/kvstore.md +++ b/julia/docs/src/api/kvstore.md @@ -1,3 +1,22 @@ + + # Key-Value Store ```@autodocs diff --git a/julia/docs/src/api/metric.md b/julia/docs/src/api/metric.md index 63cca0cc41ba..a31bc92e49e6 100644 --- a/julia/docs/src/api/metric.md +++ b/julia/docs/src/api/metric.md @@ -1,3 +1,22 @@ + + # Evaluation Metrics Evaluation metrics provide a way to evaluate the performance of a learned model. diff --git a/julia/docs/src/api/model.md b/julia/docs/src/api/model.md index f793c7c406c7..8240aeb022bb 100644 --- a/julia/docs/src/api/model.md +++ b/julia/docs/src/api/model.md @@ -1,3 +1,22 @@ + + # Model The model API provides convenient high-level interface to do training and predicting on diff --git a/julia/docs/src/api/ndarray.md b/julia/docs/src/api/ndarray.md index 5877d8257758..41161d547881 100644 --- a/julia/docs/src/api/ndarray.md +++ b/julia/docs/src/api/ndarray.md @@ -1,3 +1,22 @@ + + # NDArray API ## Arithmetic Operations diff --git a/julia/docs/src/api/nn-factory.md b/julia/docs/src/api/nn-factory.md index 833d9a3efd53..d8106eff158f 100644 --- a/julia/docs/src/api/nn-factory.md +++ b/julia/docs/src/api/nn-factory.md @@ -1,3 +1,22 @@ + + # Neural Network Factory Neural network factory provide convenient helper functions to define diff --git a/julia/docs/src/api/symbolic-node.md b/julia/docs/src/api/symbolic-node.md index ef731d9f7d00..c23b67602627 100644 --- a/julia/docs/src/api/symbolic-node.md +++ b/julia/docs/src/api/symbolic-node.md @@ -1,3 +1,22 @@ + + # Symbolic API ```@autodocs diff --git a/julia/docs/src/api/visualize.md b/julia/docs/src/api/visualize.md index 429a927012e4..843922420a30 100644 --- a/julia/docs/src/api/visualize.md +++ b/julia/docs/src/api/visualize.md @@ -1,3 +1,22 @@ + + # Network Visualization ```@autodocs diff --git a/julia/docs/src/index.md b/julia/docs/src/index.md index b6a51fc162ad..8274c712e549 100644 --- a/julia/docs/src/index.md +++ b/julia/docs/src/index.md @@ -1,3 +1,22 @@ + + # MXNet Documentation [MXNet.jl](https://github.com/dmlc/MXNet.jl) is the diff --git a/julia/docs/src/tutorial/char-lstm.md b/julia/docs/src/tutorial/char-lstm.md index 369bcddd53e9..53a371e028fe 100644 --- a/julia/docs/src/tutorial/char-lstm.md +++ b/julia/docs/src/tutorial/char-lstm.md @@ -1,3 +1,22 @@ + + Generating Random Sentence with LSTM RNN ======================================== diff --git a/julia/docs/src/tutorial/mnist.md b/julia/docs/src/tutorial/mnist.md index 916e46deb853..96423266db1b 100644 --- a/julia/docs/src/tutorial/mnist.md +++ b/julia/docs/src/tutorial/mnist.md @@ -1,3 +1,22 @@ + + Digit Recognition on MNIST ========================== diff --git a/julia/docs/src/user-guide/faq.md b/julia/docs/src/user-guide/faq.md index 8fd8a6b34551..d288ad0b3b8e 100644 --- a/julia/docs/src/user-guide/faq.md +++ b/julia/docs/src/user-guide/faq.md @@ -1,3 +1,22 @@ + + FAQ === diff --git a/julia/docs/src/user-guide/install.md b/julia/docs/src/user-guide/install.md index f1d5eeefacfe..52628de7a255 100644 --- a/julia/docs/src/user-guide/install.md +++ b/julia/docs/src/user-guide/install.md @@ -1,3 +1,22 @@ + + Installation Guide ================== diff --git a/julia/docs/src/user-guide/overview.md b/julia/docs/src/user-guide/overview.md index 5815bc6d772c..f0189f7bcd2e 100644 --- a/julia/docs/src/user-guide/overview.md +++ b/julia/docs/src/user-guide/overview.md @@ -1,3 +1,22 @@ + + # Overview ## MXNet.jl Namespace diff --git a/tests/nightly/apache_rat_license_check/rat-excludes b/tests/nightly/apache_rat_license_check/rat-excludes index 95b9a4793ad1..b3f64c246e6d 100755 --- a/tests/nightly/apache_rat_license_check/rat-excludes +++ b/tests/nightly/apache_rat_license_check/rat-excludes @@ -14,7 +14,6 @@ trunk/* .*svg .*cfg .*config -docs/* __init__.py build/* .*\\.t @@ -48,3 +47,5 @@ Project.toml include/* .*.iml .*.json.ref +searchtools_custom.js +theme.conf