Skip to content

Commit c6b72fc

Browse files
shoumikhinmalfet
authored andcommitted
Update README.md (pytorch#856)
* Update README.md Addressing pytorch/torchchat#757 * Update README.md
1 parent d0f620e commit c6b72fc

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -238,31 +238,31 @@ run `python3 torchchat.py export`
238238

239239
### Deploy and run on iOS
240240

241-
The following assumes you've completed the steps for [Setting up
242-
Executorch](#set-up-executorch) and
241+
The following assumes you've completed the steps for [Setting up Executorch](#set-up-executorch).
243242

244-
Open the xcode project
245-
```
246-
open et-build/src/executorch/examples/demo-apps/apple_ios/LLaMA/LLaMA.xcodeproj
247-
```
248-
Then click the Play button to launch the app in Simulator.
243+
#### Requirements
244+
- Xcode 15.0 or later
245+
- A development provisioning profile with the [`increased-memory-limit`](https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_developer_kernel_increased-memory-limit) entitlement.
249246

250-
To run on a device, given that you already have it set up for
251-
development, you'll need to have a provisioning profile with the
252-
[`increased-memory-limit`](https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_developer_kernel_increased-memory-limit)
253-
entitlement. Just change the app's bundle identifier to whatever
254-
matches your provisioning profile with the aforementioned capability
255-
enabled.
247+
#### Steps
256248

257-
After the app launched successfully, copy an exported ExecuTorch model (`.pte`) and tokenizer (`.bin`) files to the iLLaMA folder.
249+
1. Open the Xcode project:
250+
```bash
251+
open et-build/src/executorch/examples/demo-apps/apple_ios/LLaMA/LLaMA.xcodeproj
252+
```
253+
2. Click the Play button to launch the app in the Simulator.
258254

259-
For the Simulator, just drag&drop both files onto the Simulator window and save at `On My iPhone > iLLaMA` folder.
255+
3. To run on a device, ensure you have it set up for development and a provisioning profile with the `increased-memory-limit` entitlement. Update the app's bundle identifier to match your provisioning profile with the required capability.
260256
261-
For a device, open it in a separate Finder window, navigate to the Files tab, drag&drop both files to the iLLaMA folder and wait till the copying finishes.
257+
4. After successfully launching the app, copy the exported ExecuTorch model (`.pte`) and tokenizer (`.model`) files to the iLLaMA folder. You can find the model file called `llama3.pte` in the current `torchchat` directory and the tokenizer file at `$(python3 torchchat.py where llama3)/tokenizer.model` path.
262258
263-
Now, follow the app's UI guidelines to pick the model and tokenizer files from the local filesystem and issue a prompt.
259+
- **For the Simulator:** Drag and drop both files onto the Simulator window and save them in the `On My iPhone > iLLaMA` folder.
260+
- **For a device:** Open a separate Finder window, navigate to the Files tab, drag and drop both files into the iLLaMA folder, and wait for the copying to finish.
261+
262+
5. Follow the app's UI guidelines to select the model and tokenizer files from the local filesystem and issue a prompt.
264263

265264
*Click the image below to see it in action!*
265+
266266
<a href="https://pytorch.org/executorch/main/_static/img/llama_ios_app.mp4">
267267
<img src="https://pytorch.org/executorch/main/_static/img/llama_ios_app.png" width="600" alt="iOS app running a LlaMA model">
268268
</a>

0 commit comments

Comments
 (0)