Allow switching between two backends

kirklandsign · facebook-github-bot · commit 8f0ba2538fd2 · 2023-10-05T15:42:04.000-07:00
Summary: Now we can handle both XNNPACK and HTP (if built) Also update tutorial, and handle different input sizes https://pxl.cl/3wxXr Reviewed By: shoumikhin Differential Revision: D49969848 fbshipit-source-id: bae5ce2a7016336589b4c664dddd039eb8e0f727
diff --git a/examples/demo-apps/android/ExecuTorchDemo/README.md b/examples/demo-apps/android/ExecuTorchDemo/README.md
@@ -58,6 +58,10 @@ cd ../../..
 
 Configure the libraries for Android:
 
+1. Configure a library with XNNPACK backend only
+
+Note: This demo app and tutorial is only validated with arm64-v8a [ABI](https://developer.android.com/ndk/guides/abis).
+
 ```bash
 rm -rf cmake-out && mkdir cmake-out && cd cmake-out
 cmake .. \
@@ -71,6 +75,23 @@ cmake .. \
     -DEXECUTORCH_BUILD_EXTENSION_DATA_LOADER=ON
 ```
 
+2. Configure a library with XNNPACK and Qualcomm HTP backend
+
+```bash
+rm -rf cmake-out && mkdir cmake-out && cd cmake-out
+cmake .. \
+    -DCMAKE_TOOLCHAIN_FILE=/path/to/ndk/build/cmake/android.toolchain.cmake \
+    -DANDROID_ABI=arm64-v8a \
+    -DBUCK2=/tmp/buck2 \
+    -DFLATC_EXECUTABLE=$(realpath ../third-party/flatbuffers/cmake-out/flatc) \
+    -DEXECUTORCH_BUILD_ANDROID_DEMO_APP_JNI=ON \
+    -DEXECUTORCH_BUILD_XNNPACK=ON \
+    -DEXECUTORCH_BUILD_FLATC=OFF \
+    -DEXECUTORCH_BUILD_QNN=ON \
+    -DQNN_SDK_ROOT=/path/to/qnn/sdk \
+    -DEXECUTORCH_BUILD_EXTENSION_DATA_LOADER=ON
+```
+
 ## Building and Copying Libraries
 
 1. Build the libraries:
@@ -104,6 +125,8 @@ cd ..
 
 ## Model Download and Bundling
 
+Note: Please refer to [XNNPACK backend](../../../backend/README.md) and [Qualcomm backend](../../../../backends/qualcomm/README.md) for the full export tutorial on backends.
+
 1. Export a DeepLab v3 model and Inception v4 model backed with XNNPACK delegate and bundle it with
    the app:
 
@@ -118,4 +141,4 @@ cp dl3_xnnpack_fp32.pte ic4_xnnpack_fp32.pte examples/android_demo_apps/ExecuTor
 
 1. Open the project `examples/android_demo_apps/ExecuTorchDemo` with Android Studio.
 
-2. Run the app (^R)
+2. [Run](https://developer.android.com/studio/run) the app (^R)
diff --git a/examples/demo-apps/android/ExecuTorchDemo/app/src/main/java/com/example/executorchdemo/ClassificationActivity.java b/examples/demo-apps/android/ExecuTorchDemo/app/src/main/java/com/example/executorchdemo/ClassificationActivity.java
@@ -33,7 +33,7 @@ private void populateBitmap(String file) {
     Bitmap bitmap = null;
     try {
       bitmap = BitmapFactory.decodeStream(getAssets().open(file));
-      bitmap = Bitmap.createScaledBitmap(bitmap, 224, 224, true);
+      bitmap = Bitmap.createScaledBitmap(bitmap, 299, 299, true);
     } catch (IOException e) {
       Log.e("Classification", "Error reading assets", e);
       finish();
@@ -50,8 +50,8 @@ public void run() {
     Module module = null;
     try {
       bitmap = BitmapFactory.decodeStream(getAssets().open("corgi2.jpg"));
-      bitmap = Bitmap.createScaledBitmap(bitmap, 224, 224, true);
-      module = Module.load(MainActivity.assetFilePath(this, "ic3_xnnpack_fp32.pte"));
+      bitmap = Bitmap.createScaledBitmap(bitmap, 299, 299, true);
+      module = Module.load(MainActivity.assetFilePath(this, "ic4_qnn.pte"));
     } catch (IOException e) {
       Log.e("PytorchHelloWorld", "Error reading assets", e);
       finish();
diff --git a/examples/demo-apps/android/ExecuTorchDemo/app/src/main/java/com/example/executorchdemo/MainActivity.java b/examples/demo-apps/android/ExecuTorchDemo/app/src/main/java/com/example/executorchdemo/MainActivity.java
@@ -22,6 +22,7 @@
 import android.widget.Button;
 import android.widget.ImageView;
 import android.widget.ProgressBar;
+import android.widget.Toast;
 import com.example.executorchdemo.executor.EValue;
 import com.example.executorchdemo.executor.Module;
 import com.example.executorchdemo.executor.Tensor;
@@ -39,6 +40,7 @@ public class MainActivity extends Activity implements Runnable {
   private ProgressBar mProgressBar;
   private Bitmap mBitmap = null;
   private Module mModule = null;
+  private String mBackend = "xnnpack";
   private String mImagename = "corgi.jpeg";
 
   // see http://host.robots.ox.ac.uk:8080/pascal/VOC/voc2007/segexamples/index.html for the list of
@@ -99,8 +101,13 @@ protected void onCreate(Bundle savedInstanceState) {
     buttonRestart.setOnClickListener(
         new View.OnClickListener() {
           public void onClick(View v) {
-            if (Objects.equals(mImagename, "corgi.jpeg")) mImagename = "dog.jpg";
-            else mImagename = "deeplab.jpg";
+            if (Objects.equals(mImagename, "corgi.jpeg")) {
+              mImagename = "dog.jpg";
+            } else if (Objects.equals(mImagename, "dog.jpg")) {
+              mImagename = "deeplab.jpg";
+            } else {
+              mImagename = "corgi.jpeg";
+            }
             try {
               mBitmap = BitmapFactory.decodeStream(getAssets().open(mImagename));
               mBitmap = Bitmap.createScaledBitmap(mBitmap, 224, 224, true);
@@ -112,6 +119,39 @@ public void onClick(View v) {
           }
         });
 
+    final Button buttonSwitchBackend = findViewById(R.id.switchBackendButton);
+    buttonSwitchBackend.setText("Use Qualcomm backend");
+    buttonSwitchBackend.setOnClickListener(
+        new View.OnClickListener() {
+          public void onClick(View v) {
+            try {
+              if (Objects.equals(mBackend, "xnnpack")) {
+                mBackend = "qnn";
+                mModule.destroy();
+                mModule =
+                    Module.load(
+                        MainActivity.assetFilePath(getApplicationContext(), "dlv3_qnn.pte"));
+                buttonSwitchBackend.setText("Use XNNPACK backend");
+              } else {
+                mBackend = "xnnpack";
+                mModule.destroy();
+                mModule =
+                    Module.load(
+                        MainActivity.assetFilePath(
+                            getApplicationContext(), "dl3_xnnpack_fp32.pte"));
+                buttonSwitchBackend.setText("Use Qualcomm backend");
+              }
+            } catch (IOException e) {
+              Log.e("ImageSegmentation", "Error reading assets", e);
+              finish();
+            }
+            Toast toast =
+                Toast.makeText(getApplicationContext(), "Using: " + mBackend, Toast.LENGTH_SHORT);
+            toast.setMargin(50, 50);
+            toast.show();
+          }
+        });
+
     final Button classificationDemoButton = findViewById(R.id.classificationDemoButton);
     classificationDemoButton.setOnClickListener(
         new View.OnClickListener() {
@@ -203,6 +243,14 @@ public void run() {
             mButtonSegment.setEnabled(true);
             mButtonSegment.setText("segment");
             mProgressBar.setVisibility(ProgressBar.INVISIBLE);
+
+            Toast toast =
+                Toast.makeText(
+                    getApplicationContext(),
+                    "Inference time (ms): " + inferenceTime,
+                    Toast.LENGTH_SHORT);
+            toast.setMargin(50, 50);
+            toast.show();
           }
         });
   }
diff --git a/examples/demo-apps/android/ExecuTorchDemo/app/src/main/res/layout/activity_main.xml b/examples/demo-apps/android/ExecuTorchDemo/app/src/main/res/layout/activity_main.xml
@@ -10,7 +10,7 @@
         android:id="@+id/imageView"
         android:layout_width="388dp"
         android:layout_height="405dp"
-        android:layout_marginTop="60dp"
+        android:layout_marginTop="30dp"
         android:contentDescription="@string/image_view"
         app:layout_constraintDimensionRatio="1:1"
         app:layout_constraintEnd_toEndOf="parent"
@@ -34,7 +34,7 @@
     <ProgressBar
         android:id="@+id/progressBar"
         android:visibility="invisible"
-        android:layout_marginTop="20dp"
+        android:layout_marginTop="10dp"
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
         app:layout_constraintEnd_toEndOf="parent"
@@ -46,25 +46,37 @@
         android:id="@+id/restartButton"
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
-        android:layout_marginTop="20dp"
+        android:layout_marginTop="10dp"
         android:text="@string/restart"
         android:textAllCaps="false"
         app:layout_constraintEnd_toEndOf="parent"
         app:layout_constraintHorizontal_bias="0.498"
         app:layout_constraintStart_toStartOf="parent"
         app:layout_constraintTop_toBottomOf="@+id/segmentButton" />
 
+    <Button
+        android:id="@+id/switchBackendButton"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"
+        android:layout_marginTop="10dp"
+        android:text="@string/switch_backend"
+        android:textAllCaps="false"
+        app:layout_constraintEnd_toEndOf="parent"
+        app:layout_constraintHorizontal_bias="0.498"
+        app:layout_constraintStart_toStartOf="parent"
+        app:layout_constraintTop_toBottomOf="@+id/restartButton" />
+
     <Button
         android:id="@+id/classificationDemoButton"
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
-        android:layout_marginTop="20dp"
+        android:layout_marginTop="10dp"
         android:text="@string/classification_demo"
         android:textAllCaps="false"
         app:layout_constraintEnd_toEndOf="parent"
         app:layout_constraintHorizontal_bias="0.498"
         app:layout_constraintStart_toStartOf="parent"
-        app:layout_constraintTop_toBottomOf="@+id/restartButton" />
+        app:layout_constraintTop_toBottomOf="@+id/switchBackendButton" />
 
 
 </androidx.constraintlayout.widget.ConstraintLayout>
diff --git a/examples/demo-apps/android/ExecuTorchDemo/app/src/main/res/values/strings.xml b/examples/demo-apps/android/ExecuTorchDemo/app/src/main/res/values/strings.xml
@@ -8,4 +8,5 @@
     <string name="live">Live</string>
     <string name="classification_demo">Classification demo</string>
     <string name="segmentation_demo">Segmentation Demo</string>
+    <string name="switch_backend">Switch backend</string>
 </resources>
diff --git a/examples/demo-apps/android/jni/CMakeLists.txt b/examples/demo-apps/android/jni/CMakeLists.txt
@@ -12,5 +12,8 @@ add_subdirectory(third-party/fbjni)
 if(NOT CMAKE_TOOLCHAIN_FILE MATCHES ".*ios\.toolchain\.cmake$")
   add_library(executorchdemo SHARED jni_layer.cpp)
   target_link_libraries(executorchdemo xnn_executor_runner_lib fbjni)
+  if(EXECUTORCH_BUILD_QNN)
+    target_link_libraries(executorchdemo qnn_executorch_backend)
+  endif()
   target_compile_options(executorchdemo PUBLIC ${_common_compile_options})
 endif()
diff --git a/examples/demo-apps/android/jni/jni_layer.cpp b/examples/demo-apps/android/jni/jni_layer.cpp
@@ -185,6 +185,9 @@ class JEValue : public facebook::jni::JavaClass<JEValue> {
       auto numel = 1;
       for (int i = 0; i < rank; i++) {
         shapeVec.push_back(shapeArr[i]);
+      }
+      for (int i = rank - 1; i >= 0; --i) {
+        strides[i] = numel;
         numel *= shapeArr[i];
       }
       JNIEnv* jni = facebook::jni::Environment::current();
@@ -318,15 +321,12 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
           jinputs) {
     size_t n = jinputs->size();
     auto kDimOrder = std::vector<uint8_t>({0, 1, 2, 3});
-    constexpr int32_t kChannels = 3;
-    constexpr int32_t kHeight = 224;
-    constexpr int32_t kWidth = 224;
-    auto kStrides = std::vector<int32_t>(
-        {kChannels * kHeight * kWidth, kHeight * kWidth, kWidth, 1});
+    // strides will be filled by JEValueToTensorImpl
+    auto strides = std::vector<int32_t>({1, 1, 1, 1});
     std::vector<exec_aten::SizesType> shapeVec;
     // TODO: Inline the function
     auto tensor_impl = JEValue::JEValueToTensorImpl(
-        jinputs->getElement(0), shapeVec, kDimOrder, kStrides);
+        jinputs->getElement(0), shapeVec, kDimOrder, strides);
     EValue atEValue = EValue(exec_aten::Tensor(&tensor_impl));
     Error set_input_status = method_->set_input(atEValue, 0);
     ET_CHECK(set_input_status == Error::Ok);
