reminisce commented on a change in pull request #12502: [NGRAPH] MXNet - nGraph initial integration URL: https://github.com/apache/incubator-mxnet/pull/12502#discussion_r221000246
########## File path: NGRAPH_README.md ########## @@ -0,0 +1,38 @@ +# nGraph - MXNet Integration +MXNet nGraph integration is based on [Unified integration with external backend libraries](https://cwiki.apache.org/confluence/display/MXNET/Unified+integration+with+external+backend+libraries) + +After building MXNet with nGraph support, users can enable nGraph backend by setting `MXNET_SUBGRAPH_BACKEND="ngraph"`environmental variable. + +Gluon support is experimental and may or may not yield good performance. Gluon-NGraph +integration can be enabled by setting the environmental variable `MXNET_NGRAPH_GLUON=1` + +## Building with nGraph support +MXnet's experimental support for the Intel nGraph graph compiler can be enabled +using MXnet's build system. Current support is for Linux-based OS's, Mac and Windows +support will be added in future releases. + +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 building with gnu make, use the command: + +`make -j USE_NGRAPH=1` + +If building with cmake, use the command: + +`mkdir build && cd build && cmake ../ -DUSE_NGRAPH=1 && make -j` + +## Runtime environment variables +Some environment variables influence the behavior of the +nGraph-enabled MXNet software and supporting libraries. Here is a partial list of those variables: + +| Variable | Description | +| :-------- | :---------- | +| `OMP_NUM_THREADS` | Suggested value: `16`. For more information please see [here](https://software.intel.com/en-us/mkl-windows-developer-guide-setting-the-number-of-threads-using-an-openmp-environment-variable) | +| `KMP_AFFINITY` | Suggested value: `granularity=fine,compact,1,0`. For more information please see [here](https://software.intel.com/en-us/node/522691). | +| `MXNET_NGRAPH_VERBOSE_GRAPH` | When set to `1`, nGraph-enabled MXNet will create in the current directory a JSON file representing each subgraph being compiled by the nGraph library. Each of these JSON files is a graph serialization that can be loaded by nGraph's `ngraph::deserialize` functions. | + +## Supported nGraph back-ends +The nGraph library supports a number of backends, including `"CPU"`, `"INTERPETER"`, and `"GPU"`. Current experimental integration enables `"CPU"` backend by default. More backends will be supported in future releases. Review comment: What is INTERPRETER? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
