Skip to content

Commit

Permalink
Broken Link Fixes (apache#9562)
Browse files Browse the repository at this point in the history
* fixed broken links from the latest blc check

* added two files in faq from how_to

* removed the two backslahes typo

* git mv files from how_to to faq and fixed the Camel case in security.md
  • Loading branch information
thinksanky authored and eric-haibin-lin committed Jan 25, 2018
1 parent 52219e8 commit 1fc46e0
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion docs/api/python/ndarray/sparse.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ array([0, 1, 1, 3])
```

A detailed tutorial is available at
[CSRNDArray - NDArray in Compressed Sparse Row Storage Format](https:https://mxnet.incubator.apache.org/versions/master/tutorials/sparse/csr.html).
[CSRNDArray - NDArray in Compressed Sparse Row Storage Format](https://mxnet.incubator.apache.org/versions/master/tutorials/sparse/csr.html).
<br>

An `RowSparseNDArray` inherits from `NDArray`, and represents a multi-dimensional, fixed-size array in row sparse format.
Expand Down
4 changes: 2 additions & 2 deletions docs/community/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ We track bugs and new feature requests in the MXNet Github repo in the issues fo
## Contributors
MXNet has been developed and is used by a group of active community members. Contribute to improving it! For more information, see [contributions](http://mxnet.io/community/contribute.html).

Please join the contributor mailing list. [subscribe](mailto:[email protected]) [archive](https://lists.apache.org/[email protected])
Please join the contributor mailing list. [subscribe]('mailto:[email protected]') [archive](https://lists.apache.org/[email protected])

To join the MXNet slack channel send request to the contributor mailing list. [subscribe](mailto:[email protected]) [archive](https://the-asf.slackarchive.io/mxnet)
To join the MXNet slack channel send request to the contributor mailing list. [subscribe]('mailto:[email protected]') [archive](https://the-asf.slackarchive.io/mxnet)

## Roadmap

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/faq/bucketing.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ and then randomly chooses sequences from that bucket to form a mini-batch.
It also applies padding for sequences of different length within the mini-batch as necessary.

For a full, working implementation of a `DataIter`
that reads text sequences by as described above, see [example/rnn/lstm_ptb_bucketing.py](https://github.com/dmlc/mxnet/blob/master/example/rnn/lstm_bucketing.py).
that reads text sequences by as described above, see [example/rnn/lstm_ptb_bucketing.py](https://github.com/dmlc/mxnet/blob/master/example/rnn/bucketing/lstm_bucketing.py).
In this example, you can use bucketing with a static configuration (e.g., `buckets = [10, 20, 30, 40, 50, 60]`), or let MXNet generate buckets automatically according to the characteristics of the dataset (`buckets = []`). The latter approach is implemented by adding a bucket as long as the number of sequences assigned to that bucket is exceeds some minimum count. For more information, see [default_gen_buckets()](https://github.com/dmlc/mxnet/blob/master/example/rnn/old/bucket_io.py#L43).

## Beyond Sequence Training
Expand Down
26 changes: 13 additions & 13 deletions docs/faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,29 @@ and full working examples, visit the [tutorials section](../tutorials/index.md).


## Modeling
* [How do I fine-tune pre-trained models to a new dataset?](http://mxnet.io/how_to/finetune.html)
* [How do I fine-tune pre-trained models to a new dataset?](http://mxnet.io/faq/finetune.html)

* [How do I work with variable-length input in MXNet (bucketing)?](http://mxnet.io/how_to/bucketing.html)
* [How do I work with variable-length input in MXNet (bucketing)?](http://mxnet.io/faq/bucketing.html)

* [How do I visualize neural networks as computation graphs?](http://mxnet.io/how_to/visualize_graph.html)
* [How do I visualize neural networks as computation graphs?](http://mxnet.io/faq/visualize_graph.html)


## Scale
* [How can I train with multiple CPU/GPUs with data parallelism?](http://mxnet.io/how_to/multi_devices.html)
* [How can I train with multiple CPU/GPUs with data parallelism?](http://mxnet.io/faq/multi_devices.html)

* [How can I train with multiple GPUs with model parallelism?](http://mxnet.io/how_to/model_parallel_lstm.html)
* [How can I train with multiple GPUs with model parallelism?](http://mxnet.io/faq/model_parallel_lstm.html)


## Speed
* [How do I use gradient compression with distributed training?](http://mxnet.io/how_to/gradient_compression.html)
* [How do I use gradient compression with distributed training?](http://mxnet.io/faq/gradient_compression.html)

* [Can I use nnpack to improve the CPU performance of MXNet?](http://mxnet.io/how_to/nnpack.html)
* [Can I use nnpack to improve the CPU performance of MXNet?](http://mxnet.io/faq/nnpack.html)

* [What are the best setup and data-handling tips and tricks for improving speed?](http://mxnet.io/how_to/perf.html)
* [What are the best setup and data-handling tips and tricks for improving speed?](http://mxnet.io/faq/perf.html)


## Deployment Environments
* [Can I run MXNet on smart or mobile devices?](http://mxnet.io/how_to/smart_device.html)
* [Can I run MXNet on smart or mobile devices?](http://mxnet.io/faq/smart_device.html)

* [How to use data from S3 for training?](s3_integration.md)

Expand All @@ -44,19 +44,19 @@ and full working examples, visit the [tutorials section](../tutorials/index.md).
* [How to convert MXNet models to Apple CoreML format?](https://github.com/apache/incubator-mxnet/tree/master/tools/coreml)

## Security
* [How to run MXNet securely?](http://mxnet.io/how_to/security.html)
* [How to run MXNet securely?](http://mxnet.io/faq/security.html)

## Extend and Contribute to MXNet

* [How do I join the MXNet development discussion?](http://mxnet.io/community/mxnet_channels.html)

* [How do I contribute a patch to MXNet?](http://mxnet.io/community/contribute.html)

* [How do I implement operators in MXNet backend?](http://mxnet.io/how_to/add_op_in_backend.html)
* [How do I implement operators in MXNet backend?](http://mxnet.io/faq/add_op_in_backend.html)

* [How do I create new operators in MXNet?](http://mxnet.io/how_to/new_op.html)
* [How do I create new operators in MXNet?](http://mxnet.io/faq/new_op.html)

* [How do I set MXNet's environmental variables?](http://mxnet.io/how_to/env_var.html)
* [How do I set MXNet's environmental variables?](http://mxnet.io/faq/env_var.html)

## Questions about Using MXNet
If you need help with using MXNet, have questions about applying it to a particular kind of problem, or have a discussion topic, please use our [forum](https://discuss.mxnet.io).
Expand Down
2 changes: 1 addition & 1 deletion docs/how_to/security.md → docs/faq/security.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# MXNet Security best practices
# 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.

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/unsupervised_learning/gan.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,5 +385,5 @@ As a result, we have created two neural nets: a Generator, which is able to crea
Along the way, we have learned how to do the image manipulation and visualization that is associated with the training of deep neural nets. We have also learned how to use MXNet's Module APIs to perform advanced model training functionality to fit the model.

## Acknowledgements
This tutorial is based on [MXNet DCGAN codebase](https://github.com/apache/incubator-mxnet/blob/master/example/gan/dcgan.py),
This tutorial is based on [MXNet DCGAN codebase](https://github.com/apache/incubator-mxnet/blob/master/example/gluon/dcgan.py),
[The original paper on GANs](https://arxiv.org/abs/1406.2661), as well as [this paper on deep convolutional GANs](https://arxiv.org/abs/1511.06434).

0 comments on commit 1fc46e0

Please sign in to comment.