Skip to content

Commit

Permalink
docs: update examples in overview (#317)
Browse files Browse the repository at this point in the history
* docs: update examples in overview

close #286

* docs: add Makefile
  • Loading branch information
iblislin authored and pluskid committed Nov 13, 2017
1 parent 8071186 commit e4b6c0e
Show file tree
Hide file tree
Showing 4 changed files with 128 additions and 115 deletions.
3 changes: 3 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
all:
julia --color=yes ./make.jl
mkdocs build
32 changes: 27 additions & 5 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,50 @@
computing and state-of-art deep learning to Julia. Some highlight of features
include:

* Efficient tensor/matrix computation across multiple devices, including multiple CPUs, GPUs and distributed server nodes.
* Flexible symbolic manipulation to composite and construct state-of-the-art deep learning models.
* Efficient tensor/matrix computation across multiple devices,
including multiple CPUs, GPUs and distributed server nodes.
* Flexible symbolic manipulation to composite and construct
state-of-the-art deep learning models.

For more details, see documentation below. Please also checkout the
[examples](https://github.com/dmlc/MXNet.jl/tree/master/examples) directory.

## Tutorials

```@contents
Pages = ["tutorial/mnist.md", "tutorial/char-lstm.md"]
Pages = [
"tutorial/mnist.md",
"tutorial/char-lstm.md",
]
Depth = 2
```

## User's Guide

```@contents
Pages = ["user-guide/install.md", "user-guide/overview.md", "user-guide/faq.md"]
Pages = [
"user-guide/install.md",
"user-guide/overview.md",
"user-guide/faq.md",
]
Depth = 2
```

## API Documentation

```@contents
Pages = ["api/context.md", "api/model.md", "api/initializers.md", "api/optimizers.md", "api/callbacks.md", "api/metric.md", "api/io.md", "api/ndarray.md", "api/symbolic-node.md", "api/nn-factory.md", "api/executor.md", "api/visualize.md"]
Pages = [
"api/context.md",
"api/ndarray.md",
"api/symbolic-node.md",
"api/model.md",
"api/initializers.md",
"api/optimizers.md",
"api/callbacks.md",
"api/metric.md",
"api/io.md",
"api/nn-factory.md",
"api/executor.md",
"api/visualize.md",
]
```
16 changes: 8 additions & 8 deletions docs/src/user-guide/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To install MXNet.jl, simply type
Pkg.add("MXNet")
```

in the Julia REPL. Or to use the latest git version of MXNet.jl, use the
In the Julia REPL. Or to use the latest git version of MXNet.jl, use the
following command instead

```julia
Expand All @@ -27,9 +27,9 @@ to point the build-process in the right direction. If the automatic
cuda detection fails you can also set `CUDA_HOME` to override the process.
To control which version of libmxnet will be compiled, you can use the
`MXNET_COMMIT` variable to point to either a version tag (e.g. `v0.10.0`), a
branch name (e.g. `master`) or a specific commit hash (e.g. `a0b1c2d3`).
branch name (e.g. `master`) or a specific commit hash (e.g. `a0b1c2d3`).

The libmxnet source is downloaded to `Pkg.dir("MXNet")/deps/src/mxnet`.
The libmxnet source is downloaded to `Pkg.dir("MXNet", "deps", "src", "mxnet")`.
The automatic build is using default configurations, with OpenCV disabled.
If the compilation failed due to unresolved dependency, or if
you want to customize the build, you can compile and
Expand All @@ -39,12 +39,12 @@ Manual Compilation
------------------

It is possible to compile libmxnet separately and point MXNet.jl to a
the existing library in case automatic compilation fails due to
unresolved dependencies in an un-standard environment; Or when one want
to work with a seperate, maybe customized libmxnet.
existing library in case automatic compilation fails due to
unresolved dependencies in an non-standard environment; Or when one want
to work with a separate, maybe customized libmxnet.

To build libmxnet, please refer to [the installation guide of
libmxnet](http://mxnet.readthedocs.org/en/latest/build.html). After
libmxnet](https://mxnet.incubator.apache.org/install/index.html). After
successfully installing libmxnet, set the `MXNET_HOME` *environment
variable* to the location of libmxnet. In other words, the compiled
`libmxnet.so` should be found in `$MXNET_HOME/lib`.
Expand All @@ -65,7 +65,7 @@ Basically, MXNet.jl will search `libmxnet.so` or `libmxnet.dll` in the
following paths (and in that order):

- `$MXNET_HOME/lib`: customized libmxnet builds
- `Pkg.dir("MXNet")/deps/usr/lib`: automatic builds
- `Pkg.dir("MXNet", "deps", "usr", "lib")`: automatic builds
- Any system wide library search path

Note that MXNet.jl can not load `libmxnet.so` even if it is on one of
Expand Down

0 comments on commit e4b6c0e

Please sign in to comment.