[Android] Update ERNIE 3.0 Tiny Android deploy demo (#4437)

DefTruth · web-flow · commit 704fb69e9b7f · 2023-01-11T20:47:44.000+08:00
diff --git a/model_zoo/ernie-tiny/deploy/android/README.md b/model_zoo/ernie-tiny/deploy/android/README.md
@@ -36,11 +36,21 @@
 
 
 4. 点击 Run 按钮，自动编译 APP 并安装到手机。(该过程会自动下载预编译的 FastDeploy Android 库 以及 模型文件，需要联网)
-   成功后效果如下，图一：APP 安装到手机；图二： APP 打开后的效果，输入文本后点击"开始分析意图"后即会自动进行意图识别和槽位分析；图三：APP设置选项，点击右上角的设置图片，可以设置不同选项进行体验。
+   成功后效果如下，图一：APP 安装到手机；图二： APP 打开后的效果，输入文本后点击"开始分析意图"后即会自动进行意图识别和槽位分析；图三：APP 设置选项，点击右上角的设置图片，可以设置不同选项进行体验。
 
 | APP 效果 | APP 演示 | APP设置项 |
   | ---     | --- | --- |
-| <img width="300" height="500" alt="image" src="https://user-images.githubusercontent.com/31974251/210737269-0fe175c9-7b87-40b3-8249-1c6378e4a5e9.jpg">  | <img width="300" height="500" alt="image" src="https://user-images.githubusercontent.com/31974251/210737041-0e79bd6b-90a8-42b0-8f66-97868386d9f3.gif"> | <img width="300" height="500" alt="image" src="https://user-images.githubusercontent.com/31974251/210774693-b199734c-442c-48ef-90ea-4d2e72ff7304.jpg"> |  
+| <img width="300" height="500" alt="image" src="https://user-images.githubusercontent.com/31974251/210737269-0fe175c9-7b87-40b3-8249-1c6378e4a5e9.jpg">  | <img width="300" height="500" alt="image" src="https://user-images.githubusercontent.com/31974251/211800602-2790c799-0823-4f91-8ce3-7b4a45896b41.gif"> | <img width="300" height="500" alt="image" src="https://user-images.githubusercontent.com/31974251/211800645-bc274593-26a4-4ed0-a258-c0615fcafce1.jpg"> |  
+
+5. 点击 APP 右上角的设置选项，可以跳转到设置页。在设置页，您可以选择不同的模型和不同的推理精度，即是否开启 FP16 和 Int8 推理，两种推理精度只能二选一。FP32各模型都支持的，只要设置项中的 FP16 和 Int8 选项都为 false 时，即使用FP32进行推理。各模型FP16和Int8推理的支持情况为：  
+
+|模型选项|模型名称|FP16|Int8|  
+|---|---|---|---|  
+|models/ernie-tiny|原模型|✅|-|   
+|models/ernie-tiny-clip|原模型+裁剪（词表+模型宽度）|✅|-|   
+|models/ernie-tiny-clip-qat|原模型+裁剪（词表+模型宽度）+量化（矩阵乘）|-|✅|   
+|models/ernie-tiny-clip-qat-embedding-int8|原模型+裁剪（词表+模型宽度）+量化（矩阵乘+Embedding）|-|✅|   
+
 
 ## ERNIE Tiny Java SDK 说明和使用
 
@@ -216,13 +226,13 @@ class TestERNIETiny extends Activity {
 
 ## 替换 App 示例中的 ERNIE 3.0 Tiny 模型    
 
-替换 App 示例中的模型的步骤非常简单，模型所在的位置为 `app/src/main/assets/models`。替换模型之前请确保您的模型目录中包含 vocab.txt、slots_label.txt、intent_label.txt以及added_token.json 等意图识别和槽位分析所需要的词表和标签文件。替换模型的步骤为：  
+替换 App 示例中的模型的步骤非常简单，模型所在的位置为 `app/src/main/assets/models`。替换模型之前请确保您的模型目录中包含 vocab.txt、slots_label.txt、intent_label.txt 以及 added_token.json 等意图识别和槽位分析所需要的词表和标签文件。替换模型的步骤为：  
   - 将您的 ERNIE 3.0 Tiny 模型放在 `app/src/main/assets/models` 目录下；
   - 修改 `app/src/main/res/values/strings.xml` 中模型路径的默认值，如：
 
 ```xml
-<!-- 将这个路径指修改成您的模型，如 models/ernie-tiny -->
-<string name="ERNIE_TINY_MODEL_DIR_DEFAULT">models/ernie-tiny</string>
+<!-- 将这个路径指修改成您的模型，如 models/ernie-tiny-clip-qat-embedding-int8 -->
+<string name="ERNIE_TINY_MODEL_DIR_DEFAULT">models/ernie-tiny-clip-qat-embedding-int8</string>
 ```  
 
 ## 关于 ERNIE 3.0 Tiny JNI 的封装  
diff --git a/model_zoo/ernie-tiny/deploy/android/app/src/main/java/com/baidu/paddle/paddlenlp/app/ernie_tiny/ERNIETinyMainActivity.java b/model_zoo/ernie-tiny/deploy/android/app/src/main/java/com/baidu/paddle/paddlenlp/app/ernie_tiny/ERNIETinyMainActivity.java
@@ -14,6 +14,7 @@
 import android.support.annotation.Nullable;
 import android.support.v4.app.ActivityCompat;
 import android.support.v4.content.ContextCompat;
+import android.util.Log;
 import android.view.View;
 import android.widget.Button;
 import android.widget.EditText;
@@ -28,8 +29,7 @@
 
 
 public class ERNIETinyMainActivity extends Activity implements View.OnClickListener {
-    private static final String TAG = ERNIETinyMainActivity.class.getSimpleName()
-            + "[FastDeploy][ERNIE][Java]";
+    private static final String TAG = ERNIETinyMainActivity.class.getSimpleName();
     private ImageView back;
     private ImageButton btnSettings;
     private EditText etERNIETinyInput;
@@ -179,6 +179,10 @@ public void initSettings() {
 
     public void checkAndUpdateSettings() {
         if (ERNIETinySettingsActivity.checkAndUpdateSettings(this)) {
+            // Clear output text first
+            etERNIETinyOutput.setText("");
+
+            // Update predictor
             String realModelDir = getCacheDir() + "/" + ERNIETinySettingsActivity.modelDir;
             Utils.copyDirectoryFromAssets(this, ERNIETinySettingsActivity.modelDir, realModelDir);
 
@@ -191,10 +195,14 @@ public void checkAndUpdateSettings() {
             RuntimeOption option = new RuntimeOption();
             option.setCpuThreadNum(ERNIETinySettingsActivity.cpuThreadNum);
             option.setLitePowerMode(ERNIETinySettingsActivity.cpuPowerMode);
-            if (Boolean.parseBoolean(ERNIETinySettingsActivity.enableLiteFp16)) {
-                option.enableLiteFp16();
+            if (Boolean.parseBoolean(ERNIETinySettingsActivity.enableLiteInt8)) {
+                option.enableLiteInt8(); // For quantized models
+            } else {
+                // Enable FP16 if Int8 option is not ON.
+                if (Boolean.parseBoolean(ERNIETinySettingsActivity.enableLiteFp16)) {
+                    option.enableLiteFp16();
+                }
             }
-            // option.enableLiteInt8(); // For quantized models
             predictor.init(modelFile, paramsFile, vocabFile, slotLabelsFile,
                     intentLabelsFile, addedTokensFile, option, 16);
         }
diff --git a/model_zoo/ernie-tiny/deploy/android/app/src/main/java/com/baidu/paddle/paddlenlp/app/ernie_tiny/ERNIETinySettingsActivity.java b/model_zoo/ernie-tiny/deploy/android/app/src/main/java/com/baidu/paddle/paddlenlp/app/ernie_tiny/ERNIETinySettingsActivity.java
@@ -4,38 +4,28 @@
 import android.content.Context;
 import android.content.SharedPreferences;
 import android.os.Bundle;
-import android.preference.EditTextPreference;
 import android.preference.ListPreference;
 import android.preference.PreferenceManager;
 import android.support.v7.app.ActionBar;
 
 import com.baidu.paddle.paddlenlp.app.R;
-import com.baidu.paddle.paddlenlp.ui.Utils;
 import com.baidu.paddle.paddlenlp.ui.view.AppCompatPreferenceActivity;
 
-import java.util.ArrayList;
-import java.util.List;
-
 
 public class ERNIETinySettingsActivity extends AppCompatPreferenceActivity implements
         SharedPreferences.OnSharedPreferenceChangeListener {
     private static final String TAG = ERNIETinySettingsActivity.class.getSimpleName();
-    static public int selectedModelIdx = -1;
     static public String modelDir = "";
     static public int cpuThreadNum = 2;
     static public String cpuPowerMode = "";
-    static public String enableLiteFp16 = "true";
+    static public String enableLiteFp16 = "false";
+    static public String enableLiteInt8 = "true";
 
     ListPreference lpChoosePreInstalledModel = null;
-    EditTextPreference etModelDir = null;
     ListPreference lpCPUThreadNum = null;
     ListPreference lpCPUPowerMode = null;
     ListPreference lpEnableLiteFp16 = null;
-
-    List<String> preInstalledModelDirs = null;
-    List<String> preInstalledCPUThreadNums = null;
-    List<String> preInstalledCPUPowerModes = null;
-    List<String> preInstalledEnableLiteFp16s = null;
+    ListPreference lpEnableLiteInt8 = null;
 
     @Override
     public void onCreate(Bundle savedInstanceState) {
@@ -46,75 +36,49 @@ public void onCreate(Bundle savedInstanceState) {
             supportActionBar.setDisplayHomeAsUpEnabled(true);
         }
 
-        // Initialize pre-installed models
-        preInstalledModelDirs = new ArrayList<String>();
-        preInstalledCPUThreadNums = new ArrayList<String>();
-        preInstalledCPUPowerModes = new ArrayList<String>();
-        preInstalledEnableLiteFp16s = new ArrayList<String>();
-        preInstalledModelDirs.add(getString(R.string.ERNIE_TINY_MODEL_DIR_DEFAULT));
-        preInstalledCPUThreadNums.add(getString(R.string.CPU_THREAD_NUM_DEFAULT));
-        preInstalledCPUPowerModes.add(getString(R.string.CPU_POWER_MODE_DEFAULT));
-        preInstalledEnableLiteFp16s.add(getString(R.string.ENABLE_LITE_FP16_MODE_DEFAULT));
-
         // Setup UI components
         lpChoosePreInstalledModel =
                 (ListPreference) findPreference(getString(R.string.CHOOSE_PRE_INSTALLED_MODEL_KEY));
-        String[] preInstalledModelNames = new String[preInstalledModelDirs.size()];
-        for (int i = 0; i < preInstalledModelDirs.size(); i++) {
-            preInstalledModelNames[i] = preInstalledModelDirs.get(i).substring(preInstalledModelDirs.get(i).lastIndexOf("/") + 1);
-        }
-        lpChoosePreInstalledModel.setEntries(preInstalledModelNames);
-        lpChoosePreInstalledModel.setEntryValues(preInstalledModelDirs.toArray(new String[preInstalledModelDirs.size()]));
         lpCPUThreadNum = (ListPreference) findPreference(getString(R.string.CPU_THREAD_NUM_KEY));
         lpCPUPowerMode = (ListPreference) findPreference(getString(R.string.CPU_POWER_MODE_KEY));
-        etModelDir = (EditTextPreference) findPreference(getString(R.string.MODEL_DIR_KEY));
-        etModelDir.setTitle("Model dir (SDCard: " + Utils.getSDCardDirectory() + ")");
         lpEnableLiteFp16 = (ListPreference) findPreference(getString(R.string.ENABLE_LITE_FP16_MODE_KEY));
+        lpEnableLiteInt8 = (ListPreference) findPreference(getString(R.string.ENABLE_LITE_INT8_MODE_KEY));
     }
 
     @SuppressLint("ApplySharedPref")
     private void reloadSettingsAndUpdateUI() {
         SharedPreferences sharedPreferences = getPreferenceScreen().getSharedPreferences();
 
-        String selected_model_dir = sharedPreferences.getString(getString(R.string.CHOOSE_PRE_INSTALLED_MODEL_KEY),
-                getString(R.string.ERNIE_TINY_MODEL_DIR_DEFAULT));
-        int selected_model_idx = lpChoosePreInstalledModel.findIndexOfValue(selected_model_dir);
-        if (selected_model_idx >= 0 && selected_model_idx < preInstalledModelDirs.size() && selected_model_idx != selectedModelIdx) {
-            SharedPreferences.Editor editor = sharedPreferences.edit();
-            editor.putString(getString(R.string.MODEL_DIR_KEY), preInstalledModelDirs.get(selected_model_idx));
-            editor.putString(getString(R.string.CPU_THREAD_NUM_KEY), preInstalledCPUThreadNums.get(selected_model_idx));
-            editor.putString(getString(R.string.CPU_POWER_MODE_KEY), preInstalledCPUPowerModes.get(selected_model_idx));
-            editor.putString(getString(R.string.ENABLE_LITE_FP16_MODE_DEFAULT), preInstalledEnableLiteFp16s.get(selected_model_idx));
-            editor.commit();
-            lpChoosePreInstalledModel.setSummary(selected_model_dir);
-            selectedModelIdx = selected_model_idx;
-        }
+        String model_dir = sharedPreferences.getString(getString(R.string.CHOOSE_PRE_INSTALLED_MODEL_KEY),
+                getString(R.string.CHOOSE_PRE_INSTALLED_MODEL_DEFAULT));
 
-        String model_dir = sharedPreferences.getString(getString(R.string.MODEL_DIR_KEY),
-                getString(R.string.ERNIE_TINY_MODEL_DIR_DEFAULT));
         String cpu_thread_num = sharedPreferences.getString(getString(R.string.CPU_THREAD_NUM_KEY),
                 getString(R.string.CPU_THREAD_NUM_DEFAULT));
         String cpu_power_mode = sharedPreferences.getString(getString(R.string.CPU_POWER_MODE_KEY),
                 getString(R.string.CPU_POWER_MODE_DEFAULT));
         String enable_lite_fp16 = sharedPreferences.getString(getString(R.string.ENABLE_LITE_FP16_MODE_KEY),
                 getString(R.string.ENABLE_LITE_FP16_MODE_DEFAULT));
+        String enable_lite_int8 = sharedPreferences.getString(getString(R.string.ENABLE_LITE_INT8_MODE_KEY),
+                getString(R.string.ENABLE_LITE_FP16_MODE_DEFAULT));
 
-        etModelDir.setSummary(model_dir);
+        lpChoosePreInstalledModel.setSummary(model_dir);
+        lpChoosePreInstalledModel.setValue(model_dir);
         lpCPUThreadNum.setValue(cpu_thread_num);
         lpCPUThreadNum.setSummary(cpu_thread_num);
         lpCPUPowerMode.setValue(cpu_power_mode);
         lpCPUPowerMode.setSummary(cpu_power_mode);
         lpEnableLiteFp16.setValue(enable_lite_fp16);
         lpEnableLiteFp16.setSummary(enable_lite_fp16);
-
+        lpEnableLiteInt8.setValue(enable_lite_int8);
+        lpEnableLiteInt8.setSummary(enable_lite_int8);
     }
 
     static boolean checkAndUpdateSettings(Context ctx) {
         boolean settingsChanged = false;
         SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(ctx);
 
-        String model_dir = sharedPreferences.getString(ctx.getString(R.string.MODEL_DIR_KEY),
-                ctx.getString(R.string.ERNIE_TINY_MODEL_DIR_DEFAULT));
+        String model_dir = sharedPreferences.getString(ctx.getString(R.string.CHOOSE_PRE_INSTALLED_MODEL_KEY),
+                ctx.getString(R.string.CHOOSE_PRE_INSTALLED_MODEL_DEFAULT));
         settingsChanged |= !modelDir.equalsIgnoreCase(model_dir);
         modelDir = model_dir;
 
@@ -133,15 +97,20 @@ static boolean checkAndUpdateSettings(Context ctx) {
         settingsChanged |= !enableLiteFp16.equalsIgnoreCase(enable_lite_fp16);
         enableLiteFp16 = enable_lite_fp16;
 
+        String enable_lite_int8 = sharedPreferences.getString(ctx.getString(R.string.ENABLE_LITE_INT8_MODE_KEY),
+                ctx.getString(R.string.ENABLE_LITE_INT8_MODE_DEFAULT));
+        settingsChanged |= !enableLiteInt8.equalsIgnoreCase(enable_lite_int8);
+        enableLiteInt8 = enable_lite_int8;
+
         return settingsChanged;
     }
 
     static void resetSettings() {
-        selectedModelIdx = -1;
         modelDir = "";
         cpuThreadNum = 2;
         cpuPowerMode = "";
-        enableLiteFp16 = "true";
+        enableLiteFp16 = "false";
+        enableLiteInt8 = "true";
     }
 
     @Override
@@ -161,5 +130,4 @@ protected void onPause() {
     public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key) {
         reloadSettingsAndUpdateUI();
     }
-
 }
diff --git a/model_zoo/ernie-tiny/deploy/android/app/src/main/res/values/arrays.xml b/model_zoo/ernie-tiny/deploy/android/app/src/main/res/values/arrays.xml
@@ -36,4 +36,25 @@
         <item>true</item>
         <item>false</item>
     </string-array>
+    <string-array name="enable_lite_int8_mode_entries">
+        <item>true</item>
+        <item>false</item>
+    </string-array>
+    <string-array name="enable_lite_int8_mode_values">
+        <item>true</item>
+        <item>false</item>
+    </string-array>
+    <string-array name="preinstalled_models_entries">
+        <item>models/ernie-tiny</item>
+        <item>models/ernie-tiny-clip</item>
+        <item>models/ernie-tiny-clip-qat</item>
+        <item>models/ernie-tiny-clip-qat-embedding-int8</item>
+    </string-array>
+
+    <string-array name="preinstalled_models_values">
+        <item>models/ernie-tiny</item>
+        <item>models/ernie-tiny-clip</item>
+        <item>models/ernie-tiny-clip-qat</item>
+        <item>models/ernie-tiny-clip-qat-embedding-int8</item>
+    </string-array>
 </resources>
diff --git a/model_zoo/ernie-tiny/deploy/android/app/src/main/res/values/strings.xml b/model_zoo/ernie-tiny/deploy/android/app/src/main/res/values/strings.xml
@@ -5,19 +5,19 @@
     <string name="start_ui_activity">开始使用</string>
     <!-- Keys for PreferenceScreen -->
     <string name="CHOOSE_PRE_INSTALLED_MODEL_KEY">CHOOSE_INSTALLED_MODEL_KEY</string>
-    <string name="MODEL_DIR_KEY">MODEL_DIR_KEY</string>
     <string name="LABEL_PATH_KEY">LABEL_PATH_KEY</string>
     <string name="CPU_THREAD_NUM_KEY">CPU_THREAD_NUM_KEY</string>
     <string name="CPU_POWER_MODE_KEY">CPU_POWER_MODE_KEY</string>
     <string name="SCORE_THRESHOLD_KEY">SCORE_THRESHOLD_KEY</string>
     <string name="ENABLE_LITE_FP16_MODE_KEY">ENABLE_LITE_FP16_MODE_KEY</string>
+    <string name="ENABLE_LITE_INT8_MODE_KEY">ENABLE_LITE_INT8_MODE_KEY</string>
     <!-- Common default values ... -->
     <string name="CPU_THREAD_NUM_DEFAULT">2</string>
-    <string name="CPU_POWER_MODE_DEFAULT">LITE_POWER_HIGH</string>
-    <string name="SCORE_THRESHOLD_DEFAULT">0.4</string>
-    <string name="ENABLE_LITE_FP16_MODE_DEFAULT">true</string>
+    <string name="CPU_POWER_MODE_DEFAULT">LITE_POWER _HIGH</string>
+    <string name="ENABLE_LITE_FP16_MODE_DEFAULT">false</string>
+    <string name="ENABLE_LITE_INT8_MODE_DEFAULT">true</string>
+    <string name="CHOOSE_PRE_INSTALLED_MODEL_DEFAULT">models/ernie-tiny-clip-qat-embedding-int8</string>
     <!-- ERNIE Tiny values -->
-    <string name="ERNIE_TINY_MODEL_DIR_DEFAULT">models/ernie-tiny</string>
     <string name="ERNIE_TINY_INPUT_TEXTS_HINT">请输入需要分析的文本，如：来一首周华健的花心</string>
     <string name="ERNIE_TINY_INPUT_TEXTS_DEFAULT">来一首周华健的花心；播放我们都一样；到信阳市汽车配件城</string>
 </resources>
diff --git a/model_zoo/ernie-tiny/deploy/android/app/src/main/res/xml/ernie_tiny_settings.xml b/model_zoo/ernie-tiny/deploy/android/app/src/main/res/xml/ernie_tiny_settings.xml
@@ -1,15 +1,13 @@
 <?xml version="1.0" encoding="utf-8"?>
 <PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android">
     <ListPreference
-        android:defaultValue="@string/ERNIE_TINY_MODEL_DIR_DEFAULT"
+        android:defaultValue="@string/CHOOSE_PRE_INSTALLED_MODEL_DEFAULT"
         android:key="@string/CHOOSE_PRE_INSTALLED_MODEL_KEY"
+        android:entries="@array/preinstalled_models_entries"
+        android:entryValues="@array/preinstalled_models_values"
         android:negativeButtonText="@null"
         android:positiveButtonText="@null"
         android:title="Choose Pre-Installed Models" />
-    <EditTextPreference
-        android:defaultValue="@string/ERNIE_TINY_MODEL_DIR_DEFAULT"
-        android:key="@string/MODEL_DIR_KEY"
-        android:title="Model Dir" />
     <ListPreference
         android:defaultValue="@string/CPU_THREAD_NUM_DEFAULT"
         android:entries="@array/cpu_thread_num_entries"
@@ -34,4 +32,12 @@
         android:negativeButtonText="@null"
         android:positiveButtonText="@null"
         android:title="Enable Lite FP16" />
+    <ListPreference
+        android:defaultValue="@string/ENABLE_LITE_INT8_MODE_DEFAULT"
+        android:entries="@array/enable_lite_int8_mode_entries"
+        android:entryValues="@array/enable_lite_int8_mode_values"
+        android:key="@string/ENABLE_LITE_INT8_MODE_KEY"
+        android:negativeButtonText="@null"
+        android:positiveButtonText="@null"
+        android:title="Enable Lite Int8" />
 </PreferenceScreen>
