Skip to content

Commit

Permalink
installation guide (or what we wanted to be...)
Browse files Browse the repository at this point in the history
  • Loading branch information
pluskid committed Oct 21, 2015
1 parent 2c945ea commit 1da331c
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# MXNet.jl

MXNet.jl is a [Julia](http://julialang.org/) package for *efficient* and *flexible* deep learning, built on top of [dmlc/mxnet](https://github.com/dmlc/mxnet).
MXNet.jl is the [dmlc/mxnet](https://github.com/dmlc/mxnet) [Julia](http://julialang.org/) package. MXNet.jl brings flexible and efficient GPU 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.
20 changes: 20 additions & 0 deletions docs/user-guide/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Automatic Installation

To install MXNet.jl, simply type
```jl
Pkg.add("MXNet")
```
in the Julia REPL. MXNet.jl is built on top of [libmxnet](https://github.com/dmlc/mxnet). Upon installation, Julia will try to automatically download and build libmxnet. If the compilation fails due to unresolved dependency, or if you prefer to work with a customized installation of libmxnet, please see [below](#manual-compilation).

To use the latest git version of MXNet.jl, use the following command instead
```jl
Pkg.checkout("MXNet")
```

# 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.

To build libmxnet, please refer to [the installation guide of libmxnet](http://mxnet.readthedocs.org/en/latest/build.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`.

When the `MXNET_HOME` environment variable is detected and the corresponding `libmxnet.so` could be loaded successfully, MXNet.jl will skip automatic building during installation and use the specified libmxnet instead.
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ repo_url: https://github.com/dmlc/MXNet.jl
theme: readthedocs
pages:
- Home: index.md
- User Guide:
- 'Installation Guide' : 'user-guide/install.md'
- API Documentation:
- 'ndarray': 'api/ndarray.md'
- 'symbol': 'api/symbol.md'

0 comments on commit 1da331c

Please sign in to comment.