validate_model.sh

#!/bin/bash
# Must run at root dir of mace project.
set +x
Usage() {
  echo 'Usage: bash tools/validate_model.sh tools/model.config'
}

if [ $# -lt 1 ];then
  Usage
  exit -1
fi

source $1

LIB_FOLDER_NAME="libmace"
if [ x"${ANDROID_ABI}" = x"armeabi-v7a" ]; then
  LIB_FOLDER_NAME="${LIB_FOLDER_NAME}_v7"
elif [ x"${ANDROID_ABI}" = x"arm64-v8a" ]; then
  LIB_FOLDER_NAME="${LIB_FOLDER_NAME}_v8"
else
  echo "Unsopported android abi"
  exit -1
fi

MACE_RUNTIME=cpu

if [ x"$RUNTIME" = x"dsp" ]; then
  DATA_TYPE="DT_UINT8"
  DEVICE_TYPE="HEXAGON"
  LIB_FOLDER_NAME="${LIB_FOLDER_NAME}_dsp"
  MACE_RUNTIME=$RUNTIME
elif [ x"$RUNTIME" = x"gpu" ]; then
  DATA_TYPE="DT_HALF"
  DEVICE_TYPE="OPENCL"
  MACE_RUNTIME=$RUNTIME
elif [ x"$RUNTIME" = x"cpu" ]; then
  DATA_TYPE="DT_FLOAT"
  DEVICE_TYPE="CPU"
elif [ x"$RUNTIME" = x"local" ];then
  DATA_TYPE="DT_FLOAT"
  DEVICE_TYPE="CPU"
else
  Usage
  exit -1
fi

LIBMACE_TAG=`git describe --abbrev=0 --tags` || exit -1

VLOG_LEVEL=0
MODEL_DIR=$(dirname ${TF_MODEL_FILE_PATH})
LIBMACE_SOURCE_DIR=`/bin/pwd`
LIBMACE_BUILD_DIR="${LIBMACE_SOURCE_DIR}/build"
INPUT_FILE_NAME="model_input"
OUTPUT_FILE_NAME="model.out"
OUTPUT_LIST_FILE="model.list"
PHONE_DATA_DIR="/data/local/tmp/mace_run"
KERNEL_DIR="${PHONE_DATA_DIR}/cl/"
CODEGEN_DIR=${LIBMACE_SOURCE_DIR}/codegen
MODEL_CODEGEN_DIR=${CODEGEN_DIR}/models/${MODEL_TAG}
CL_CODEGEN_DIR=${CODEGEN_DIR}/opencl
CL_BIN_DIR=${CODEGEN_DIR}/opencl_bin
TUNING_CODEGEN_DIR=${CODEGEN_DIR}/tuning
VERSION_SOURCE_PATH=${CODEGEN_DIR}/version

build_and_run()
{
  PRODUCTION_MODE=$1
  if [ "$PRODUCTION_MODE" = true ]; then
    PRODUCTION_MODE_BUILD_FLAGS="--define production=true"
  fi

  if [[ "${TUNING_OR_NOT}" != "0" && "$PRODUCTION_MODE" != true ]];then
    tuning_flag=1
    round=0 # only warm up
  elif [[ "$PRODUCTION_MODE" != true ]];then
    tuning_flag=0
    round=1
  else
    tuning_flag=0
    round=2
  fi

  bazel build --verbose_failures -c opt --strip always examples:mace_run \
    --crosstool_top=//external:android/crosstool \
    --host_crosstool_top=@bazel_tools//tools/cpp:toolchain \
    --cpu=${ANDROID_ABI} \
    --copt="-std=c++11" \
    --copt="-D_GLIBCXX_USE_C99_MATH_TR1" \
    --copt="-Werror=return-type" \
    --copt="-DMACE_MODEL_TAG=${MODEL_TAG}" \
    $PRODUCTION_MODE_BUILD_FLAGS \
    --define hexagon=true || exit -1

  adb shell "mkdir -p ${PHONE_DATA_DIR}" || exit -1
  if [ "$PRODUCTION_MODE" = false ]; then
    adb shell "mkdir -p ${KERNEL_DIR}" || exit -1
  fi
  adb push ${MODEL_DIR}/${INPUT_FILE_NAME} ${PHONE_DATA_DIR} || exit -1
  adb push bazel-bin/examples/mace_run ${PHONE_DATA_DIR} || exit -1
  adb push lib/hexagon/libhexagon_controller.so ${PHONE_DATA_DIR} || exit 0

  adb </dev/null shell \
    LD_LIBRARY_PATH=${PHONE_DATA_DIR} \
    MACE_TUNING=${tuning_flag} \
    MACE_CPP_MIN_VLOG_LEVEL=$VLOG_LEVEL \
    MACE_RUN_PARAMETER_PATH=${PHONE_DATA_DIR}/mace_run.config \
    MACE_KERNEL_PATH=$KERNEL_DIR \
    MACE_LIMIT_OPENCL_KERNEL_TIME=${LIMIT_OPENCL_KERNEL_TIME} \
    ${PHONE_DATA_DIR}/mace_run \
    --input_shape="${INPUT_SHAPE}"\
    --output_shape="${OUTPUT_SHAPE}"\
    --input_file=${PHONE_DATA_DIR}/${INPUT_FILE_NAME} \
    --output_file=${PHONE_DATA_DIR}/${OUTPUT_FILE_NAME} \
    --device=${DEVICE_TYPE}   \
    --round=$round || exit -1
}

local_build_and_run()
{
  bazel build --verbose_failures -c opt --strip always codegen:generated_models \
    --copt="-std=c++11" \
    --copt="-D_GLIBCXX_USE_C99_MATH_TR1" \
    --copt="-Werror=return-type" \
    --copt="-DMACE_MODEL_TAG=${MODEL_TAG}" \
    --define openmp=true \
    --define production=true || exit -1

  bazel build --verbose_failures -c opt --strip always examples:mace_run \
    --copt="-std=c++11" \
    --copt="-D_GLIBCXX_USE_C99_MATH_TR1" \
    --copt="-Werror=return-type" \
    --copt="-DMACE_MODEL_TAG=${MODEL_TAG}" \
    --define openmp=true \
    --define production=true || exit -1

  MACE_CPP_MIN_VLOG_LEVEL=$VLOG_LEVEL \
  bazel-bin/examples/mace_run \
      --input_shape="${INPUT_SHAPE}"\
      --output_shape="${OUTPUT_SHAPE}"\
      --input_file=${MODEL_DIR}/${INPUT_FILE_NAME} \
      --output_file=${MODEL_DIR}/${OUTPUT_FILE_NAME} \
      --device=${DEVICE_TYPE}   \
      --round=1 || exit -1
}

download_and_link_lib()
{
  if [ ! -d "${LIBMACE_SOURCE_DIR}/lib/${LIB_FOLDER_NAME}" ]; then
    wget -P ${LIBMACE_SOURCE_DIR}/lib http://cnbj1-inner-fds.api.xiaomi.net/libmace/libs/${LIBMACE_TAG}/${LIB_FOLDER_NAME}.tar.gz && \
      tar xvzf ${LIBMACE_SOURCE_DIR}/lib/${LIB_FOLDER_NAME}.tar.gz -C ${LIBMACE_SOURCE_DIR}/lib/ || exit -1
    echo "${LIB_FOLDER_NAME} download successfully!"
  else
    echo "${LIB_FOLDER_NAME} already exists!"
  fi

  echo "Create link 'mace' of downloaded or existed ${LIB_FOLDER_NAME}"
  if [ -L ${LIBMACE_SOURCE_DIR}/lib/mace ]; then
    unlink ${LIBMACE_SOURCE_DIR}/lib/mace
  fi
  ln -s ${LIBMACE_SOURCE_DIR}/lib/${LIB_FOLDER_NAME} ${LIBMACE_SOURCE_DIR}/lib/mace && \
    rm -rf ${LIBMACE_SOURCE_DIR}/lib/${LIB_FOLDER_NAME}.tar.gz || exit -1
}

echo "Step 1: Generate input data"
rm -rf ${MODEL_DIR}/${INPUT_FILE_NAME}
python tools/validate.py --generate_data true \
 --input_file=${MODEL_DIR}/${INPUT_FILE_NAME} \
 --input_shape="${INPUT_SHAPE}" || exit -1

echo "Step 2: Convert tf model to mace model and optimize memory"
bazel build //lib/python/tools:tf_converter || exit -1
rm -rf ${MODEL_CODEGEN_DIR}
mkdir -p ${MODEL_CODEGEN_DIR}
if [ ${DSP_MODE} ]; then
    DSP_MODE_FLAG="--dsp_mode=${DSP_MODE}"
fi
bazel-bin/lib/python/tools/tf_converter --input=${TF_MODEL_FILE_PATH} \
                                        --output=${MODEL_CODEGEN_DIR}/model.cc \
                                        --input_node=${TF_INPUT_NODE} \
                                        --output_node=${TF_OUTPUT_NODE} \
                                        --data_type=${DATA_TYPE} \
                                        --runtime=${MACE_RUNTIME} \
                                        --output_type=source \
                                        --template=${LIBMACE_SOURCE_DIR}/lib/python/tools/model.template \
                                        --model_tag=${MODEL_TAG} \
                                        ${DSP_MODE_FLAG} \
                                        --input_shape="${INPUT_SHAPE}" \
                                        --obfuscate=True || exit -1

echo "Step 3: Download mace static library"
download_and_link_lib

if [ x"$RUNTIME" = x"local" ]; then

  echo "Step 4: remove the mace run result."
  rm -rf ${MODEL_DIR}/${OUTPUT_FILE_NAME}

  echo "Step 8: Run model on the local pc using binary"
  local_build_and_run

else
  echo "Step 4: Run model on the phone with files"
  build_and_run false

  echo "Step 5: Generate OpenCL binary program and config code"
  rm -rf ${CL_BIN_DIR}
  rm -rf ${CL_CODEGEN_DIR}
  mkdir -p ${CL_BIN_DIR}
  mkdir -p ${CL_CODEGEN_DIR}
  adb pull ${KERNEL_DIR}/. ${CL_BIN_DIR}
  python lib/python/tools/opencl_codegen.py \
    --cl_binary_dir=${CL_BIN_DIR} --output_path=${CL_CODEGEN_DIR}/opencl_compiled_program.cc

  echo "Step 6: Generate tuning source file"
  adb pull ${PHONE_DATA_DIR}/mace_run.config ${CL_BIN_DIR}
  rm -rf ${TUNING_CODEGEN_DIR}
  mkdir -p ${TUNING_CODEGEN_DIR}
  python lib/python/tools/binary_codegen.py \
    --binary_file=${CL_BIN_DIR}/mace_run.config --output_path=${TUNING_CODEGEN_DIR}/tuning_params.cc

  echo "Step 7: Run model on the phone using binary"
  build_and_run true

  echo "Step 8: Pull the mace run result."
  rm -rf ${MODEL_DIR}/${OUTPUT_FILE_NAME}
  adb </dev/null pull ${PHONE_DATA_DIR}/${OUTPUT_FILE_NAME} ${MODEL_DIR}

fi

echo "Step 9: Validate the result"
python tools/validate.py --model_file ${TF_MODEL_FILE_PATH} \
    --input_file ${MODEL_DIR}/${INPUT_FILE_NAME} \
    --mace_out_file ${MODEL_DIR}/${OUTPUT_FILE_NAME} \
    --mace_runtime ${MACE_RUNTIME} \
    --input_node ${TF_INPUT_NODE} \
    --output_node ${TF_OUTPUT_NODE} \
    --input_shape ${INPUT_SHAPE} \
    --output_shape ${OUTPUT_SHAPE}

echo "Step 10: Generate project static lib"
rm -rf ${LIBMACE_BUILD_DIR}
mkdir -p ${LIBMACE_BUILD_DIR}/lib
cp -rf ${LIBMACE_SOURCE_DIR}/include ${LIBMACE_BUILD_DIR}

if [ x"$RUNTIME" = x"local" ]; then
  $ANDROID_NDK_HOME/toolchains/aarch64-linux-android-4.9/prebuilt/linux-x86_64/bin/aarch64-linux-android-ar \
    -M < tools/libmace_local.mri || exit -1
else
  cp ${LIBMACE_SOURCE_DIR}/lib/hexagon/libhexagon_controller.so ${LIBMACE_BUILD_DIR}/lib
  $ANDROID_NDK_HOME/toolchains/aarch64-linux-android-4.9/prebuilt/linux-x86_64/bin/aarch64-linux-android-ar \
    -M < tools/libmace.mri || exit -1
fi

echo "Done"