Google Git
Sign in
apache / mxnet / refs/heads/dependabot/bundler/docs/static_site/src/addressable-2.8.1 / . / cpp-package
tree: f2ce4154122449ec5894b2e2c33fae886912c642 [path history] [tgz]
  1. example/
  2. include/
  3. scripts/
  4. tests/
  5. CMakeLists.txt
  6. README.md
cpp-package/README.md

MXNet - C++ API

The MXNet C++ Package provides C++ API bindings to the users of MXNet. Currently, these bindings are not available as standalone package. The users of these bindings are required to build this package as mentioned below.

Building C++ Package

The cpp-package directory contains the implementation of C++ API. Users are required to build this directory or package before using it. The cpp-package is built while building the MXNet shared library, libmxnet.so, with USE_CPP_PACKAGE option turned on. Please follow the steps to build the C++ package

Steps to build the C++ package:

  1. Building the MXNet C++ package requires building MXNet from source.

  2. Clone the MXNet GitHub repository recursively to ensure the code in submodules is available for building MXNet.

    git clone --recursive https://github.com/apache/mxnet mxnet

  3. Install the recommended dependencies and optional dependencies for building MXNet from source.

  4. There is a configuration file for cmake, config/*.cmake that contains all the compilation options. You can edit this file and set the appropriate options prior to running the cmake command.

  5. Please refer to cmake configuration files for more details on how to configure and compile MXNet.

  6. For enabling the build of C++ Package, set the -DUSE_CPP_PACKAGE = 1 in cmake options.

Cross-Compilation steps:

  1. Build the C++ package for the host platform to generate op.h file.
  2. Remove the following line in CMakeLists.txt.
    COMMAND python OpWrapperGenerator.py $<TARGET_FILE:mxnet>
  3. Re-configure cmake for cross-compilation to build the target C++ package.

Usage

In order to consume the C++ API please follow the steps below.

  1. Ensure that the MXNet shared library is built from source with the USE_CPP_PACKAGE = 1.
  2. Include the MxNetCpp.h in the program that is going to consume MXNet C++ API.
    	#include <mxnet-cpp/MxNetCpp.h>
  3. While building the program, ensure that the correct paths to the directories containing header files and MXNet shared library.
  4. The program links the MXNet shared library dynamically. Hence the library needs to be accessible to the program during runtime. This can be achieved by including the path to the shared library in the environment variable LD_LIBRARY_PATH for Linux, Mac. and Ubuntu OS and PATH for Windows OS.

Tutorial

A basic tutorial can be found at https://mxnet.apache.org/api/cpp/docs/tutorials/basics.

Examples

The example directory contains examples for you to get started. Please build the MXNet C++ Package before building the examples.