前言
依据mxnet的官方文档,将其整体移植到移动平台上是非常困难的,只有预测部分可以整合成单文件的形式应用到移动平台上。但网上有关这部分的资料极其稀少,而且已经是很多年以前的了,按照官方文档编译的时候也出现了很多错误,故有此文,将自己这几天踩过的坑记录一下,同时也为想在iOS上使用mxnet的同学们提供一点帮助。
环境
Xcode 9.3
iOS >= 10.0, macOS 10.13.4
mxnet 1.2.1
安装OpenBLAS
mxnet的本地编译需要OpenBLAS作为基础,可以通过Homebrew安装:
brew install openblas
一般情况下,openblas的安装路径是/usr/local/opt/openblas
下载mxnet及其第三方依赖库
下载mxnet源码,定位到3rdParty目录,查看它所有第三方依赖库的目录下面是否有内容,如果没有,需要继续下载那些第三方库。
在这里推荐使用Github Desktop直接clone到本地,这样会顺便把那些第三方依赖库也同时下好。
如果您把OpenBLAS安装在了其他位置,请相应调整amalgamation/Makefile中的OPENBLAS_ROOT,将其指向OpenBLAS的真实安装位置。
修改dmlc-minimum0.cc
打开amalgamation/dmlc-minimum0.cc,找到
#include "../3rdparty/dmlc-core/src/io/local_filesys.cc"
在下方增加
#include "../3rdparty/dmlc-core/src/io/filesys.cc"
修改mxnet_predict0.cc
打开amalgamation/mxnet_predict0.cc,找到
#include "src/ndarray/ndarray_function.cc"
在其上方增加(注意!这个是上方!)
#include "src/common/utils.cc"
找到
#include "src/imperative/cached_op.cc"
在其下方增加
#include "src/imperative/imperative.cc"
找到
#include "src/engine/naive_engine.cc"
在其下方增加
#include "src/engine/openmp.cc"
找到
#include "src/profiler/profiler.cc"
在其下方增加
#include "src/profiler/aggregate_stats.cc"
找到
#include "src/executor/inplace_addto_detect_pass.cc"
在其下方增加
#include "src/executor/infer_graph_attr_pass.cc"
找到
#include "src/c_api/c_api_error.cc"
在其下方增加
#include "src/c_api/c_api_profile.cc"
编译mxnet_predict-all.cc
定位到amalgamation目录,在命令行里面输入
make
并等待一段时间,如果一切顺利,最终会输出:
ar rcs libmxnet_predict.a mxnet_predict-all.o
如果在这个过程中出现任何error信息(包括在ar命令执行过程中出现任何erorr信息),需要检查mxnet_predict0.cc和dmlc-minimum0.cc两个文件是否修改正确。
在amalgamation目录下会多出一些文件,我们需要mxnet_predict-all.cc,这就是mxnet预测部分的单文件版本。
修改mxnet_predict-all.cc
打开mxnet_predict-all.cc,找到
#include <cblas.h>
改为
#include <Accelerate/Accelerate.h>
增加
#include <execinfo.h>
#include <shared_mutex>
删除以下两个头文件的引用
#include <emmintrin.h>
#include <x86intrin.h>
找到
#ifndef MSHADOW_USE_SSE
#define MSHADOW_USE_SSE 1
#endif
改为
#ifndef MSHADOW_USE_SSE
#define MSHADOW_USE_SSE 0
#endif
找到
#if defined(_MSC_VER) || defined(__CUDACC__)
#define MSHADOW_USE_F16C 0
#elif defined(__clang__) && \
((__clang_major__ < 8) || ((__clang_major__ == 8) && (__clang_minor__ < 1)))
#define MSHADOW_USE_F16C 0
#else
#define MSHADOW_USE_F16C 1
#endif
改为
#define MSHADOW_USE_F16C 0
注释掉以下部分:
#if MSHADOW_USE_MKL == 0
//中间的代码段全部注释掉
#endif // MSHADOW_USE_MKL == 0
将mxnet_predict-all.cc以及../include/mxnet/c_predict_api.h拷出来备用。
建立iOS工程
新建一个iOS工程,不管是APP也好,静态库也好,还是动态库也好,都可以。
将刚才的mxnet_predict-all.cc以及c_predict_api.h加入工程。
在Build Phases的Link Binary with Libraries中,加入Accelerate.framework,然后编译。
一些资源
- 如果觉得上面的步骤太麻烦,可以直接用我修改好的版本,只用其中的dmlc-minimum0.cc和mxnet_predict0.cc
- 很久没有更新的生成predict-all的官方文档可以作为参考
mxnet_predict-all生成原理
从amalgamation/Makefile文件可以看出,mxnet_predict-all.cc主要依靠dmlc-minimum0.cc、nnvm.cc和mxnet_predict0.cc等若干个模板文件,依据amalgamation.py这个脚本文件解析模板文件,将其展开、合并到一个大的文件中。
所以如果最后生成的文件中存在什么问题,直接到模板文件里面找原因就行了。
常见问题
1 Undefined Symbol for archetecture xxx
检查mxnet_predict-all.cc里面有没有对应的实现,如果没有,继续检查mxnet_predict0.cc以及dmlc-minimum0.cc两个文件是否有正确修改。
2 mxnet_predict-all.cc里面include文件未找到
仔细对比mxnet_predict-all.cc是否有按前述过程修改,我遇到的很多种情况是因为某些其他平台的宏未关闭(例如MSHADOW_USE_SSE未置0)引起的
3 其他问题请在评论区留言,我将及时更新这份文档。