Skip to content

Commit 7e9eaa8

Browse files
Riandyfacebook-github-bot
authored andcommitted
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
1 parent 9d224a5 commit 7e9eaa8

File tree

1 file changed

+22
-20
lines changed

1 file changed

+22
-20
lines changed

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

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
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.
5+
This tutorial covers the end to end workflow for building an iOS demo app using XNNPACK backend on device.
66
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.
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.
99
3. Building the iOS demo app itself.
1010

1111
## Prerequisites
1212
* [Xcode 15](https://developer.apple.com/xcode)
1313
* [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:
1514

1615
## Setup ExecuTorch
1716
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 +47,7 @@ sh examples/models/llama2/install_requirements.sh
4847
```
4948

5049
### 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.
50+
We have supported BFloat16 as a data type on the XNNPACK backend for Llama 3.2 1B/3B models.
5251
* You can download original model weights for Llama through Meta official [website](https://llama.meta.com/).
5352
* For chat use-cases, download the instruct models instead of pretrained.
5453
* Run “examples/models/llama2/install_requirements.sh” to install dependencies.
@@ -59,8 +58,6 @@ We have supported BFloat16 as a data type on the XNNPack backend for Llama 3.2 1
5958
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"
6059
```
6160

62-
* Convert tokenizer for Llama 3.2 - Rename 'tokenizer.model' to 'tokenizer.bin'.
63-
6461
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)-).
6562

6663
### For Llama 3.1 and Llama 2 models
@@ -80,16 +77,6 @@ python -m executorch.examples.models.llava.export_llava --pte-name llava.pte --w
8077
```
8178
* You can find more information [here](https://github.com/pytorch/executorch/tree/main/examples/models/llava).
8279

83-
## Pushing Model and Tokenizer
84-
85-
### Copy the model to Simulator
86-
* Drag&drop the model and tokenizer files onto the Simulator window and save them somewhere inside the iLLaMA folder.
87-
* Pick the files in the app dialog, type a prompt and click the arrow-up button.
88-
89-
### Copy the model to Device
90-
* Wire-connect the device and open the contents in Finder.
91-
* Navigate to the Files tab and drag & drop the model and tokenizer files onto the iLLaMA folder.
92-
* Wait until the files are copied.
9380

9481
## Configure the XCode Project
9582

@@ -134,12 +121,27 @@ Then select which ExecuTorch framework should link against which target.
134121
<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">
135122
</p>
136123

137-
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:
124+
Click “Run” to build the app and run in on your iPhone.
125+
126+
## Pushing Model and Tokenizer
127+
128+
### Copy the model to Simulator
129+
* Drag&drop the model and tokenizer files onto the Simulator window and save them somewhere inside the iLLaMA folder.
130+
* Pick the files in the app dialog, type a prompt and click the arrow-up button.
131+
132+
### Copy the model to Device
133+
* Wire-connect the device and open the contents in Finder.
134+
* Navigate to the Files tab and drag & drop the model and tokenizer files onto the iLLaMA folder.
135+
* Wait until the files are copied.
136+
137+
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:
138138

139139
<p align="center">
140140
<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">
141141
</p>
142142

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

145147
<p align="center">

0 commit comments

Comments
 (0)