Skip to content

[Doc] Minor update to Build Android Package from Source section #785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 22, 2023
Merged

[Doc] Minor update to Build Android Package from Source section #785

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions docs/deploy/android.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ The MLC LLM Android app is free and available for download and can be tried out
Build Android Package from Source
---------------------------------

If you're a developer looking to integrate new functionality or support different model architectures in the Android Package, you may need to build it from source. To do so, please follow the instructions provided below on building the Android package from source.
If you're a developer looking to integrate new functionality or support different model architectures in the Android Package, you may need to build it from source. To do so, please follow the instructions provided below on building the Android package from source.
Before you begin, clone this repository and initialize the submodules, as well as install and initalize rustup.

App Build Instructions
^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -72,19 +73,22 @@ App Build Instructions
.. code:: bash

# replace the /path/to/android/ndk to your NDK path
# e.g. export ANDROID_NDK=/Users/me/Library/Android/sdk/ndk/25.2.9519653
# e.g. for MacOS: export ANDROID_NDK=/Users/me/Library/Android/sdk/ndk/25.2.9519653
# e.g. for Linux: export ANDROID_NDK=/home/user/Downloads/android-studio/plugins/android-ndk
export ANDROID_NDK=/path/to/android/ndk

# replace the /path/to/android/ndk/clang to your NDK compiler path
# e.g. export TVM_NDK_CC=/Users/me/Library/Android/sdk/ndk/25.2.9519653/toolchains/llvm/prebuilt/darwin-x86_64/bin/aarch64-linux-android24-clang
# e.g. for MacOS: export TVM_NDK_CC=/Users/me/Library/Android/sdk/ndk/25.2.9519653/toolchains/llvm/prebuilt/darwin-x86_64/bin/aarch64-linux-android24-clang
# e.g. for Linux: export TVM_NDK_CC=/home/user/Downloads/android-studio/plugins/c-clangd/bin/clang/linux/x64/clangd
export TVM_NDK_CC=/path/to/android/ndk/clang

5. Setup ``JAVA_HOME`` environment varh:
5. Setup ``JAVA_HOME`` environment variable:

.. code:: bash

# replace the /path/to/jdk to your JDK path
# e.g. export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk-17.jdk/Contents/Home
# e.g. for MacOS: export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk-17.jdk/Contents/Home
# e.g. for Linux: export JAVA_HOME=/home/user/Downloads/jdk-20
export JAVA_HOME=/path/to/jdk

6. Build the libs for Android app and then copy the built files to the ``android/MLCChat/app/src/main/src/libs``:
Expand Down