Skip to content

Commit ff45aae

Browse files
kirklandsignpytorchbot
authored andcommitted
Update docs (#2919)
Summary: Pull Request resolved: #2919 The note directive on sphinx doesn't render well on markdown. Remove it to avoid cause confusion. Reviewed By: mergennachin, cccclai Differential Revision: D55881939 fbshipit-source-id: a4252f0b70593ecd97e5cc352c601e772a9c222a (cherry picked from commit dc7e4d5)
1 parent 1f1f357 commit ff45aae

File tree

1 file changed

+6
-11
lines changed
  • examples/demo-apps/android/LlamaDemo

1 file changed

+6
-11
lines changed

examples/demo-apps/android/LlamaDemo/README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@ This app demonstrates the use of the LLaMA chat app demonstrating local inferenc
1313
* Alternatively, you can follow [this guide](https://github.com/pytorch/executorch/blob/856e085b9344c8b0bf220a97976140a5b76356aa/examples/demo-apps/android/LlamaDemo/SDK.md) to set up Java/SDK/NDK with CLI.
1414
* Supported Host OS: CentOS, macOS Sonoma on Apple Silicon.
1515

16-
```{note}
17-
This demo app and tutorial has only been validated with arm64-v8a [ABI](https://developer.android.com/ndk/guides/abis), with NDK 25.0.8775105.
18-
```
16+
Note: This demo app and tutorial has only been validated with arm64-v8a [ABI](https://developer.android.com/ndk/guides/abis), with NDK 25.0.8775105.
1917

2018
## Getting models
2119
Please refer to the [ExecuTorch Llama2 docs](https://github.com/pytorch/executorch/blob/main/examples/models/llama2/README.md) to export the model.
@@ -27,22 +25,19 @@ adb push llama2.pte /data/local/tmp/llama
2725
adb push tokenizer.bin /data/local/tmp/llama
2826
```
2927

30-
```{note}
31-
The demo app searches in `/data/local/tmp/llama` for .pte and .bin files as LLAMA model and tokenizer.
32-
```
28+
Note: The demo app searches in `/data/local/tmp/llama` for .pte and .bin files as LLAMA model and tokenizer.
3329

3430
## Build JNI library
3531
1. Open a terminal window and navigate to the root directory of the `executorch`.
3632
2. Set the following environment variables:
37-
```{note}
38-
<path_to_android_ndk> is the root for the NDK, which is usually under
39-
~/Library/Android/sdk/ndk/XX.Y.ZZZZZ for macOS, and contains NOTICE and README.md.
40-
We use <path_to_android_ndk>/build/cmake/android.toolchain.cmake for CMake to cross-compile.
41-
```
4233
```bash
4334
export ANDROID_NDK=<path_to_android_ndk>
4435
export ANDROID_ABI=arm64-v8a
4536
```
37+
Note: `<path_to_android_ndk>` is the root for the NDK, which is usually under
38+
`~/Library/Android/sdk/ndk/XX.Y.ZZZZZ` for macOS, and contains NOTICE and README.md.
39+
We use `<path_to_android_ndk>/build/cmake/android.toolchain.cmake` for CMake to cross-compile.
40+
4641
3. Run the following command set up the required JNI library:
4742
```bash
4843
pushd examples/demo-apps/android/LlamaDemo

0 commit comments

Comments
 (0)