From 514307c48155da22969f5fb651a1d4b5f7d481dd Mon Sep 17 00:00:00 2001 From: Edward Chen <18449977+edgchen1@users.noreply.github.com> Date: Thu, 8 Aug 2024 19:20:02 -0700 Subject: [PATCH] address comments --- docs/build/android.md | 13 +++++++------ docs/tutorials/mobile/index.md | 4 ++-- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/build/android.md b/docs/build/android.md index 427035deb1037..70a6a21b29d15 100644 --- a/docs/build/android.md +++ b/docs/build/android.md @@ -23,6 +23,8 @@ The SDK and NDK packages can be installed via Android Studio or the sdkmanager c Android Studio is more convenient but a larger installation. The command line tools are smaller and usage can be scripted, but are a little more complicated to setup. They also require a Java runtime environment to be available. +Generally, you'll want to use the latest stable NDK version. We'll refer to the version that you use as `` from here on. + Resources: * [API levels](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html) @@ -36,7 +38,7 @@ Resources: 2. Install any additional SDK Platforms if necessary * File->Settings->Appearance & Behavior->System Settings->Android SDK to see what is currently installed - * Note that the SDK path you need to use as --android_sdk_path when building ORT is also on this configuration page + * Note that the SDK path you need to use as `--android_sdk_path` when building ORT is also on this configuration page * Most likely you don't require additional SDK Platform packages as the latest platform can target earlier API levels. 3. Install an NDK version @@ -44,8 +46,7 @@ Resources: * File->Settings->Appearance & Behavior->System Settings->Android SDK * 'SDK Tools' tab * Select 'Show package details' checkbox at the bottom to see specific versions. By default the latest will be installed which should be fine. - * The NDK path will be the 'ndk/{version}' subdirectory of the SDK path shown - * e.g. if 21.1.6352462 is installed it will be {SDK path}/ndk/21.1.6352462 + * The NDK path will be the `ndk/` subdirectory of the SDK path shown ### sdkmanager from command line tools @@ -81,8 +82,8 @@ Resources: * Install the NDK * Find the available NDK versions by running `sdkmanager --list` * Install - * install the desired version, e.g., `sdkmanager --install "ndk;21.1.6352462"` - * NDK path in our example with this install would be `.../Android/ndk/21.1.6352462` + * install the desired version, e.g., `sdkmanager --install "ndk;"` + * NDK path in our example with this install would be `.../Android/ndk/` ## Android Build Instructions @@ -97,7 +98,7 @@ The [Ninja](https://ninja-build.org/) generator needs to be used to build on Win e.g. using the paths from our example ``` -./build.bat --android --android_sdk_path .../Android --android_ndk_path .../Android/ndk/21.1.6352462 --android_abi arm64-v8a --android_api 27 --cmake_generator Ninja +./build.bat --android --android_sdk_path .../Android --android_ndk_path .../Android/ndk/ --android_abi arm64-v8a --android_api 27 --cmake_generator Ninja ``` ### Cross compiling on Linux and macOS diff --git a/docs/tutorials/mobile/index.md b/docs/tutorials/mobile/index.md index bb64c8c25fc2c..852320521d4c5 100644 --- a/docs/tutorials/mobile/index.md +++ b/docs/tutorials/mobile/index.md @@ -88,10 +88,10 @@ One of the outputs of the ORT format conversion is a build configuration file, c To give an idea of the binary size difference between the pre-built package and a custom build: -File|Pre-built package size (bytes)|Custom build size (bytes) +File|1.18.0 pre-built package size (bytes)|1.18.0 custom build size (bytes) -|-|- AAR|24415212|7532309 `jni/arm64-v8a/libonnxruntime.so`, uncompressed|16276832|3962832 `jni/x86_64/libonnxruntime.so`, uncompressed|18222208|4240864 -This custom build supports the operators needed to run a ResNet50 model. It also has limited framework support (built with `--minimal_build=extended`), only supporting ORT format models. It has support for the NNAPI and XNNPACK execution providers. +This custom build supports the operators needed to run a ResNet50 model. It requires the use of ORT format models (as it was built with `--minimal_build=extended`). It has support for the NNAPI and XNNPACK execution providers.