-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
installation guide (or what we wanted to be...)
- Loading branch information
Showing
3 changed files
with
26 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters