onnxruntime/java/src/test/android/README.md

2.3 KiB

Android Test Application for ORT-Mobile

This directory contains a simple android application for testing ONNX Runtime AAR package.

Background

For general usage and build purpose of ORT-Mobile Android, please see the documentation here.

Test Android Application Overview

This android application is mainly aimed for testing:

  • Model used: A simple sigmoid ONNX model (converted to ORT format under app\src\androidTest\assets folder).
    • Here's a documentation about how you can convert an ONNX model into ORT format.
  • Main test file: An android instrumentation test under app\src\androidtest\java\ai.onnxruntime.example.javavalidator\SimpleTest.kt
  • The main dependency of this application is onnxruntime aar package under app\libs.
  • The MainActivity of this application is set to be empty.

Requirements

Building

Use the android's build instructions with --build_java and --android_run_emulator option.

Please note that you may need to set the --android_abi=x86_64 (the default option is arm64-v8a). This is because android instrumentation test is run on an android emulator which requires an abi of x86_64.

Build Output

The build will generate two apks which is required to run the test application in $YOUR_BUILD_DIR/java/androidtest/android/app/build/outputs/apk:

  • androidtest/debug/app-debug-androidtest.apk
  • debug/app-debug.apk

After running the build script, the two apks will be installed on ort_android emulator and it will automatically run the test application in an adb shell.