Skip to content
This repository has been archived by the owner on Jan 3, 2023. It is now read-only.

Commit

Permalink
update readme (#506)
Browse files Browse the repository at this point in the history
* update readme

* re-arrange sections
  • Loading branch information
Matthew Brookhart authored Nov 30, 2018
1 parent 5c91b04 commit ee69ced
Showing 1 changed file with 39 additions and 38 deletions.
77 changes: 39 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,9 @@
# nGraph - MXNet Integration

## Building with nGraph support
MXnet's experimental support for the Intel nGraph graph compiler can be enabled
using MXnet's Makefile-based build system.

When building MXnet with experimental nGraph integration enabled, MXnet's build
system builds its own copy of the nGraph-supplied libraries. Upon successful
completion of an nGraph-enabled build, these libraries and related symbolic links
can be found in the same build directory as `libmxnet.so`.
## Installation

The experimental MXnet nGraph integration does not currently support externally
supplied builds of nGraph's libraries to be used by MXnet. However, it is possible
to use control which particular version of the nGraph source code is built by
executing an appropriate `git checkout ...` command in the `3rdparty/ngraph-mxnet-bridge`
MXnet source tree.
Warning, this package has only been tested on Ubuntu 16.04 with Intel CPUs from the Haswell line and later. Use on other platforms/CPUs may or may not work.

Some of the Make-variable influential for experimental nGraph MXnet integration
are as follows:
- `USE_NGRAPH` - If set to `1`, build MXnet with experimental nGraph integration
enabled.
- `NGRAPH_EXTRA_CMAKE_FLAGS` - nGraph uses a CMake-based build system. This variable
can provide additional command-line arguments to the `cmake` invocation used to
configure nGraph for compilation.
- `NGRAPH_EXTRA_MAKE_FLAGS` - This variable can provide additional command-line
arguments to the invocation of `make` used to compile and link nGraph.

Please see the files `3rdparty/ngraph-mxnet-bridge/ngraph.mk` and `make/config.mk` for more details.

## Compilation instructions for Ubuntu 16.04

A. **Option 1: Use a pre-built Mxnet package**

1. **Install Ubuntu prerequisites**
Run the following commands from a command-line:

Expand Down Expand Up @@ -61,23 +34,51 @@ A. **Option 1: Use a pre-built Mxnet package**

1. **Install the pip package.**

Warning, this package has only been tested on Ubuntu 16.04 with Intel CPUs from the Haswell line and later. Use on other platforms/CPUs may or may not work.

``` sh
pip install ngraph-mxnet
```

B. **Option 2: Clone the nGraph-MXNet repository**
## Building with nGraph support
MXnet's experimental support for the Intel nGraph graph compiler can be enabled
using MXnet's Makefile-based build system.

When building MXnet with experimental nGraph integration enabled, MXnet's build
system builds its own copy of the nGraph-supplied libraries. Upon successful
completion of an nGraph-enabled build, these libraries and related symbolic links
can be found in the same build directory as `libmxnet.so`.
If you have not already done so, create a clone on the local file system of
the official nGraph-enabled Apache MXNet repository:
The experimental MXnet nGraph integration does not currently support externally
supplied builds of nGraph's libraries to be used by MXnet. However, it is possible
to use control which particular version of the nGraph source code is built by
executing an appropriate `git checkout ...` command in the `3rdparty/ngraph-mxnet-bridge`
MXnet source tree.

``` sh
git clone --recursive https://github.com/NervanaSystems/ngraph-mxnet.git
```
Some of the Make-variable influential for experimental nGraph MXnet integration
are as follows:
- `USE_NGRAPH` - If set to `1`, build MXnet with experimental nGraph integration
enabled.
- `NGRAPH_EXTRA_CMAKE_FLAGS` - nGraph uses a CMake-based build system. This variable
can provide additional command-line arguments to the `cmake` invocation used to
configure nGraph for compilation.
- `NGRAPH_EXTRA_MAKE_FLAGS` - This variable can provide additional command-line
arguments to the invocation of `make` used to compile and link nGraph.

Please see the files `3rdparty/ngraph-mxnet-bridge/ngraph.mk` and `make/config.mk` for more details.


## Compilation instructions for Ubuntu 16.04

If you have not already done so, create a clone on the local file system of
the official nGraph-enabled Apache MXNet repository:

``` sh
git clone --recursive https://github.com/NervanaSystems/ngraph-mxnet.git
```

In the instructions below, the root directory of the cloned repository shall
be referred to as `MXNET_ROOT`.

In the instructions below, the root directory of the cloned repository shall
be referred to as `MXNET_ROOT`.
1. **Install Ubuntu prerequisites**
Run the following commands from a command-line:

Expand Down

0 comments on commit ee69ced

Please sign in to comment.