anijain2305 commented on a change in pull request #5354: [Tutorial] AutoTVM for TFLite model on ARM CPUs. URL: https://github.com/apache/incubator-tvm/pull/5354#discussion_r409919577
########## File path: tutorials/autotvm/tune_relay_tflite_arm.py ########## @@ -0,0 +1,427 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +""" +Auto-tuning a TFLite network for ARM CPUs +========================================= +**Author**: `Animesh Jain <https://github.com/anijain2305>`_ + +This is a tutorial on tuning a TFLite model for ARM CPUs. This tutorial is largely based on previous +twp tutorials - `Compile TFLite Models <https://docs.tvm.ai/tutorials/frontend/from_tflite.html#sphx-glr-tutorials-frontend-from-tflite-py>`_ and `Auto-tuning a convolutional network for ARM CPUs <https://docs.tvm.ai/tutorials/autotvm/tune_relay_arm.html#sphx-glr-tutorials-autotvm-tune-relay-arm-py>`_. + +Here, we will demonstrate reading a TFLite model, auto-tuning, compiling and executing it. While, most of the demonstration will be similar to previous two, we will discuss different types of data layouts options for conv2d. We will also demonstrate how a TVM user can control the set of configurations options while tuning. +""" + + +""" +First we use Compile TFLite model tutorial to setup and read a TFLite model. The instructions are copied here for user friendliness. + +To get started, Flatbuffers and TFLite package needs to be installed as prerequisites. +A quick solution is to install Flatbuffers via pip + +.. code-block:: bash + + pip install flatbuffers --user + + +To install TFlite packages, you could use our prebuilt wheel: + +.. code-block:: bash + + # For python3: + wget https://github.com/FrozenGene/tflite/releases/download/v1.13.1/tflite-1.13.1-py3-none-any.whl + pip3 install -U tflite-1.13.1-py3-none-any.whl --user + + # For python2: + wget https://github.com/FrozenGene/tflite/releases/download/v1.13.1/tflite-1.13.1-py2-none-any.whl + pip install -U tflite-1.13.1-py2-none-any.whl --user + + +or you could generate TFLite package yourself. The steps are the following: + +.. code-block:: bash + + # Get the flatc compiler. + # Please refer to https://github.com/google/flatbuffers for details + # and make sure it is properly installed. + flatc --version + + # Get the TFLite schema. + wget https://raw.githubusercontent.com/tensorflow/tensorflow/r1.13/tensorflow/lite/schema/schema.fbs + + # Generate TFLite package. + flatc --python schema.fbs + + # Add current folder (which contains generated tflite module) to PYTHONPATH. + export PYTHONPATH=${PYTHONPATH:+$PYTHONPATH:}$(pwd) + + +Now please check if TFLite package is installed successfully, ``python -c "import tflite"`` + +Below you can find an example on how to compile TFLite model using TVM. + +""" + +###################################################################### +# First, necessary imports +import os +import tvm +from tvm import te +from tvm import autotvm +from tvm import relay +import tvm.relay.testing +from tvm.autotvm.tuner import XGBTuner, GATuner, RandomTuner, GridSearchTuner +from tvm.contrib.util import tempdir +import tvm.contrib.graph_runtime as runtime + +###################################################################### +# Load a test image +# ----------------- +# A single cat dominates the examples! +def load_image(): + from PIL import Image + import numpy as np + + image_url = 'https://github.com/dmlc/mxnet.js/blob/master/data/cat.png?raw=true' + image_path = download_testdata(image_url, 'cat.png', module='data') + resized_image = Image.open(image_path).resize((224, 224)) + image_data = np.asarray(resized_image).astype("float32") + + # Add a dimension to the image so that we have NHWC format layout + image_data = np.expand_dims(image_data, axis=0) + + # Preprocess image as described here: + # https://github.com/tensorflow/models/blob/edb6ed22a801665946c63d650ab9a0b23d98e1b1/research/slim/preprocessing/inception_preprocessing.py#L243 + image_data[:, :, :, 0] = 2.0 / 255.0 * image_data[:, :, :, 0] - 1 + image_data[:, :, :, 1] = 2.0 / 255.0 * image_data[:, :, :, 1] - 1 + image_data[:, :, :, 2] = 2.0 / 255.0 * image_data[:, :, :, 2] - 1 + return image_data + + +###################################################################### +# Load pretrained TFLite model +# ---------------------------- +# Load mobilenet V1 TFLite model provided by Google +def get_network(): + def extract(path): + import tarfile + if path.endswith("tgz") or path.endswith("gz"): + dir_path = os.path.dirname(path) + tar = tarfile.open(path) + tar.extractall(path=dir_path) + tar.close() + else: + raise RuntimeError('Could not decompress the file: ' + path) + + from tvm.contrib.download import download_testdata + + model_url = "http://download.tensorflow.org/models/mobilenet_v1_2018_08_02/mobilenet_v1_1.0_224.tgz"; + + # Download model tar file and extract it to get mobilenet_v1_1.0_224.tflite + model_path = download_testdata(model_url, "mobilenet_v1_1.0_224.tgz", module=['tf', 'official']) + model_dir = os.path.dirname(model_path) + extract(model_path) + + # Now we can open mobilenet_v1_1.0_224.tflite + tflite_model_file = os.path.join(model_dir, "mobilenet_v1_1.0_224.tflite") + tflite_model_buf = open(tflite_model_file, "rb").read() + + # Get TFLite model from buffer + try: + import tflite + tflite_model = tflite.Model.GetRootAsModel(tflite_model_buf, 0) + except AttributeError: + import tflite.Model + tflite_model = tflite.Model.Model.GetRootAsModel(tflite_model_buf, 0) + + # TFLite input tensor name, shape and type + input_tensor = "input" + input_shape = (1, 224, 224, 3) + input_dtype = "float32" + + # Parse TFLite model and convert it to a Relay module + from tvm import relay + mod, params = relay.frontend.from_tflite(tflite_model, + shape_dict={input_tensor: input_shape}, + dtype_dict={input_tensor: input_dtype}) + return mod, params, input_shape, input_dtype + + +################################################################# +# Start RPC Tracker +# ----------------- +# TVM uses RPC session to communicate with ARM boards. +# During tuning, the tuner will send the generated code to the board and +# measure the speed of code on the board. +# +# To scale up the tuning, TVM uses RPC Tracker to manage distributed devices. +# The RPC Tracker is a centralized master node. We can register all devices to +# the tracker. For example, if we have 10 phones, we can register all of them +# to the tracker, and run 10 measurements in parallel, accelerating the tuning process. +# +# To start an RPC tracker, run this command on the host machine. The tracker is +# required during the whole tuning process, so we need to open a new terminal for +# this command: +# +# .. code-block:: bash +# +# python -m tvm.exec.rpc_tracker --host=0.0.0.0 --port=9190 +# +# The expected output is +# +# .. code-block:: bash +# +# INFO:RPCTracker:bind to 0.0.0.0:9190 + +################################################################# +# Register devices to RPC Tracker +# ----------------------------------- +# Now we can register our devices to the tracker. The first step is to +# build the TVM runtime for the ARM devices. +# +# * For Linux: +# Follow this section :ref:`build-tvm-runtime-on-device` to build +# the TVM runtime on the device. Then register the device to tracker by +# +# .. code-block:: bash +# +# python -m tvm.exec.rpc_server --tracker=[HOST_IP]:9190 --key=rk3399 +# +# (replace :code:`[HOST_IP]` with the IP address of your host machine) +# +# * For Android: +# Follow this `readme page <https://github.com/apache/incubator-tvm/tree/master/apps/android_rpc>`_ to +# install the TVM RPC APK on the android device. Make sure you can pass the android rpc test. +# Then you have already registered your device. During tuning, you have to go to developer option +# and enable "Keep screen awake during changing" and charge your phone to make it stable. +# +# After registering devices, we can confirm it by querying rpc_tracker +# +# .. code-block:: bash +# +# python -m tvm.exec.query_rpc_tracker --host=0.0.0.0 --port=9190 +# +# For example, if we have 2 Huawei mate10 pro, 11 Raspberry Pi 3B and 2 rk3399, +# the output can be +# +# .. code-block:: bash +# +# Queue Status +# ---------------------------------- +# key total free pending +# ---------------------------------- +# mate10pro 2 2 0 +# rk3399 2 2 0 +# rpi3b 11 11 0 +# ---------------------------------- +# +# You can register multiple devices to the tracker to accelerate the measurement in tuning. + +########################################### +# Set Tuning Options +# ------------------ +# Before tuning, we should apply some configurations. Here I use an RK3399 board +# as example. In your setting, you should modify the target and device_key accordingly. +# set :code:`use_android` to True if you use android phone. + +#### DEVICE CONFIG #### + +# Replace "armv8a-linux-gnueabihf" with the correct target of your board. +# This target is used for cross compilation. You can query it by :code:`gcc -v` on your device. +target = tvm.target.create('llvm -device=arm_cpu -target=armv8a-linux-gnueabihf -mattr=+neon,fp-armv8,thumb-mode -mfloat-abi=hard') + +# Also replace this with the device key in your tracker +device_key = 'rk3399' + +# Set this to True if you use android phone +use_android = False + +#### TUNING OPTION #### +network = 'mobilenet_v1_1.0_224' +log_file = "%s.%s.log" % (device_key, network) +dtype = 'float32' + +tuning_option = { + 'log_filename': log_file, + + 'tuner': 'xgb', + 'n_trial': 1500, + 'early_stopping': 800, + + 'measure_option': autotvm.measure_option( + builder=autotvm.LocalBuilder( + build_func='ndk' if use_android else 'default'), + runner=autotvm.RPCRunner( + device_key, host='0.0.0.0', port=9190, + number=5, + timeout=10, + ), + ), +} + +#################################################################### +# +# .. note:: How to set tuning options +# +# In general, the default values provided here work well. +# If you have enough time budget, you can set :code:`n_trial`, :code:`early_stopping` larger, +# which makes the tuning run longer. +# If your device runs very slow or your conv2d operators have many GFLOPs, considering to +# set timeout larger. +# +# If your model has depthwise convolution, you could consider setting +# :code:`try_spatial_pack_depthwise` be :code:`True`, which perform better than default +# optimization in general. For example, on ARM CPU A53 2.0GHz, we find it could boost 1.6x +# performance of depthwise convolution on Mobilenet V1 model. + +################################################################### +# Begin Tuning +# ------------ +# Now we can extract tuning tasks from the network and begin tuning. +# Here, we provide a simple utility function to tune a list of tasks. +# This function is just an initial implementation which tunes them in sequential order. +# We will introduce a more sophisticated tuning scheduler in the future. + +# You can skip the implementation of this function for this tutorial. +def tune_tasks(tasks, + measure_option, + tuner='xgb', + n_trial=1000, + early_stopping=None, + log_filename='tuning.log', + use_transfer_learning=True): + # create tmp log file + tmp_log_file = log_filename + ".tmp" + if os.path.exists(tmp_log_file): + os.remove(tmp_log_file) + + for i, tsk in enumerate(reversed(tasks)): + prefix = "[Task %2d/%2d] " % (i+1, len(tasks)) + + # create tuner + if tuner == 'xgb' or tuner == 'xgb-rank': + tuner_obj = XGBTuner(tsk, loss_type='rank') + elif tuner == 'xgb_knob': + tuner_obj = XGBTuner(tsk, loss_type='rank', feature_type='knob') + elif tuner == 'ga': + tuner_obj = GATuner(tsk, pop_size=50) + elif tuner == 'random': + tuner_obj = RandomTuner(tsk) + elif tuner == 'gridsearch': + tuner_obj = GridSearchTuner(tsk) + else: + raise ValueError("Invalid tuner: " + tuner) + + if use_transfer_learning: + if os.path.isfile(tmp_log_file): + tuner_obj.load_history(autotvm.record.load_from_file(tmp_log_file)) + + # do tuning + tsk_trial = min(n_trial, len(tsk.config_space)) + tuner_obj.tune(n_trial=tsk_trial, + early_stopping=early_stopping, + measure_option=measure_option, + callbacks=[ + autotvm.callback.progress_bar(tsk_trial, prefix=prefix), + autotvm.callback.log_to_file(tmp_log_file) + ]) + + # pick best records to a cache file + autotvm.record.pick_best(tmp_log_file, log_filename) + os.remove(tmp_log_file) + +# At commit baff99c83f9f691174434e7c78a4fee48b558547, ARM NHWC schedule is not high performance. So, +# we first switch to NCHW. Further, Relay build calls AlterOpLayout to optimize the data layout to +# NCHWc. If you want to use NHWC layout, please set use_nchw to False. +use_nchw = True + +# TVM has many conv2d schedules for different platforms. As of commit +# baff99c83f9f691174434e7c78a4fee48b558547, we observed that x86 NCHWc schdules are faster than ARM +# NCHW or ARM NHWC schedule. If you want to use ARM NCHW spatial pack schedule, set this to false. +use_x86_schedules = True +if use_x86_schedules: + # We must convert to NCHW first to use x86 schedules + assert use_nchw + +######################################################################## +# Finally, we launch tuning jobs and evaluate the end-to-end performance. +def tune_and_evaluate(tuning_opt): + # extract workloads from relay program + print("Extract tasks...") + mod, params, input_shape, _ = get_network() + + if use_nchw: + # Convert the layout to NCHW + seq = tvm.transform.Sequential([relay.transform.RemoveUnusedFunctions(), + relay.transform.ConvertLayout('NCHW')]) + with tvm.transform.PassContext(opt_level=3): + mod = seq(mod) + + tasks = autotvm.task.extract_from_program(mod["main"], target=target, + params=params, + ops=(relay.op.get("nn.conv2d"),)) + + + if use_x86_schedules: + tasks = autotvm.util.remove_template(tasks, ["conv2d_nchw_spatial_pack.arm_cpu", + "depthwise_conv2d_nchw.arm_cpu"]) + Review comment: New additions to this tutorial - L347 - L382 ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
