mxnet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] aaronmarkham commented on a change in pull request #12737: [MXNET-1017] Updating the readme file for cpp-package and adding readme file for example directory.
Date Tue, 09 Oct 2018 16:55:04 GMT
aaronmarkham commented on a change in pull request #12737: [MXNET-1017] Updating the readme
file for cpp-package and adding readme file for example directory.
URL: https://github.com/apache/incubator-mxnet/pull/12737#discussion_r223775042
 
 

 ##########
 File path: cpp-package/example/README.md
 ##########
 @@ -0,0 +1,112 @@
+# MXNet C++ Package Examples
+
+## Building C++ examples
+
+The examples are built while building the MXNet library and cpp-package from source . However,
they can be built manually as follows
+
+From cpp-package/examples directory
+
+-  Build all examples in release mode: **make all**
+-  Build all examples in debug mode: **make debug**
+
+By default, the examples are build to be run on GPU. To build examples to run on CPU:
+
+-  Release: **make all MXNET\_USE\_CPU=1**
+-  Debug: **make debug MXNET\_USE\_CPU=1**
+
+The examples that are build to be run on GPU may not work on the non-GPU machines.
+The makefile will also download the necessary data files and store in data folder. (The download
will take couple of minutes, but will be done only once on a fresh installation.)
 
 Review comment:
   in a data folder.

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message