Skip to content

Commit f2bed68

Browse files
pytorchbotRiandy
andauthored
Readme docs update (#5713)
Readme docs update (#5695) Summary: Pull Request resolved: #5695 - rename XNNPACK - remove duplicate executorch setup instructions - remove tokenizer conversion step (since iOS supports both .bin and .model) - move model copying section to after xcode setup Reviewed By: cmodi-meta, kirklandsign Differential Revision: D63479985 fbshipit-source-id: bd1030588fa997f26c0c8da59f5850b06141aa43 (cherry picked from commit 7e9eaa8) Co-authored-by: Riandy Riandy <[email protected]>
1 parent 25a1be8 commit f2bed68

File tree

1 file changed

+30
-19
lines changed

1 file changed

+30
-19
lines changed

examples/demo-apps/apple_ios/LLaMA/docs/delegates/xnnpack_README.md

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
1-
# Building Llama iOS Demo for XNNPack Backend
1+
# Building Llama iOS Demo for XNNPACK Backend
22

3-
**[UPDATE - 09/25]** We have added support for running [Llama 3.2 models](#for-llama-32-1b-and-3b-models) on the XNNPack backend. We currently support inference on their original data type (BFloat16).
3+
**[UPDATE - 09/25]** We have added support for running [Llama 3.2 models](#for-llama-32-1b-and-3b-models) on the XNNPACK backend. We currently support inference on their original data type (BFloat16).
44

5-
This tutorial covers the end to end workflow for building an iOS demo app using XNNPack backend on device.
6-
More specifically, it covers:
7-
1. Export and quantization of Llama models against the XNNPack backend.
8-
2. Building and linking libraries that are required to inference on-device for iOS platform using XNNPack.
5+
This tutorial covers the end to end workflow for building an iOS demo app using XNNPACK backend on device. More specifically, it covers:
6+
1. Export and quantization of Llama models against the XNNPACK backend.
7+
2. Building and linking libraries that are required to inference on-device for iOS platform using XNNPACK.
98
3. Building the iOS demo app itself.
109

1110
## Prerequisites
1211
* [Xcode 15](https://developer.apple.com/xcode)
1312
* [iOS 17 SDK](https://developer.apple.com/ios)
14-
* Set up your ExecuTorch repo and environment if you haven’t done so by following the [Setting up ExecuTorch](https://pytorch.org/executorch/stable/getting-started-setup) to set up the repo and dev environment:
1513

1614
## Setup ExecuTorch
1715
In this section, we will need to set up the ExecuTorch repo first with Conda environment management. Make sure you have Conda available in your system (or follow the instructions to install it [here](https://conda.io/projects/conda/en/latest/user-guide/install/index.html)). The commands below are running on Linux (CentOS).
@@ -48,7 +46,7 @@ sh examples/models/llama2/install_requirements.sh
4846
```
4947

5048
### For Llama 3.2 1B and 3B models
51-
We have supported BFloat16 as a data type on the XNNPack backend for Llama 3.2 1B/3B models.
49+
We have supported BFloat16 as a data type on the XNNPACK backend for Llama 3.2 1B/3B models.
5250
* You can download original model weights for Llama through Meta official [website](https://llama.meta.com/).
5351
* For chat use-cases, download the instruct models instead of pretrained.
5452
* Run “examples/models/llama2/install_requirements.sh” to install dependencies.
@@ -59,8 +57,6 @@ We have supported BFloat16 as a data type on the XNNPack backend for Llama 3.2 1
5957
python -m examples.models.llama2.export_llama --checkpoint <checkpoint.pth> --params <params.json> -kv -X -d bf16 --metadata '{"get_bos_id":128000, "get_eos_ids":[128009, 128001]}' --output_name="llama3_2.pte"
6058
```
6159

62-
* Convert tokenizer for Llama 3.2 - Rename 'tokenizer.model' to 'tokenizer.bin'.
63-
6460
For more detail using Llama 3.2 lightweight models including prompt template, please go to our official [website](https://www.llama.com/docs/model-cards-and-prompt-formats/llama3_2#-llama-3.2-lightweight-models-(1b/3b)-).
6561

6662
### For Llama 3.1 and Llama 2 models
@@ -70,16 +66,16 @@ Export the model
7066
python -m examples.models.llama2.export_llama --checkpoint <consolidated.00.pth> -p <params.json> -kv --use_sdpa_with_kv_cache -X -qmode 8da4w --group_size 128 -d fp32 --metadata '{"get_bos_id":128000, "get_eos_ids":[128009, 128001]}' --embedding-quantize 4,32 --output_name="llama3_kv_sdpa_xnn_qe_4_32.pte"
7167
```
7268

73-
## Pushing Model and Tokenizer
69+
### For LLaVA model
70+
* For the Llava 1.5 model, you can get it from Huggingface [here](https://huggingface.co/llava-hf/llava-1.5-7b-hf).
71+
* Run `examples/models/llava/install_requirements.sh` to install dependencies.
72+
* Run the following command to generate llava.pte, tokenizer.bin and an image tensor (serialized in TorchScript) image.pt.
7473

75-
### Copy the model to Simulator
76-
* Drag&drop the model and tokenizer files onto the Simulator window and save them somewhere inside the iLLaMA folder.
77-
* Pick the files in the app dialog, type a prompt and click the arrow-up button.
74+
```
75+
python -m executorch.examples.models.llava.export_llava --pte-name llava.pte --with-artifacts
76+
```
77+
* You can find more information [here](https://github.com/pytorch/executorch/tree/main/examples/models/llava).
7878

79-
### Copy the model to Device
80-
* Wire-connect the device and open the contents in Finder.
81-
* Navigate to the Files tab and drag & drop the model and tokenizer files onto the iLLaMA folder.
82-
* Wait until the files are copied.
8379

8480
## Configure the XCode Project
8581

@@ -124,12 +120,27 @@ Then select which ExecuTorch framework should link against which target.
124120
<img src="https://raw.githubusercontent.com/pytorch/executorch/refs/heads/main/docs/source/_static/img/ios_demo_app_choosing_package.png" alt="iOS LLaMA App Choosing package" style="width:600px">
125121
</p>
126122

127-
Click “Run” to build the app and run in on your iPhone. If the app successfully run on your device, you should see something like below:
123+
Click “Run” to build the app and run in on your iPhone.
124+
125+
## Pushing Model and Tokenizer
126+
127+
### Copy the model to Simulator
128+
* Drag&drop the model and tokenizer files onto the Simulator window and save them somewhere inside the iLLaMA folder.
129+
* Pick the files in the app dialog, type a prompt and click the arrow-up button.
130+
131+
### Copy the model to Device
132+
* Wire-connect the device and open the contents in Finder.
133+
* Navigate to the Files tab and drag & drop the model and tokenizer files onto the iLLaMA folder.
134+
* Wait until the files are copied.
135+
136+
Open the iLLaMA app, click the settings button at the top left of the app to select the model and tokenizer files. When the app successfully runs on your device, you should see something like below:
128137

129138
<p align="center">
130139
<img src="https://raw.githubusercontent.com/pytorch/executorch/refs/heads/main/docs/source/_static/img/ios_demo_app.jpg" alt="iOS LLaMA App" style="width:300px">
131140
</p>
132141

142+
143+
133144
For Llava 1.5 models, you can select and image (via image/camera selector button) before typing prompt and send button.
134145

135146
<p align="center">

0 commit comments

Comments
 (0)