Skip to content

Commit 1cabf8d

Browse files
pytorchbotRiandy
andauthored
Fix missing newline typo on ios docs (#5510)
Fix missing newline typo on ios docs (#5491) Summary: Pull Request resolved: #5491 Missing newline in the docs is causing "rm -rf" command to get swallowed up by markdown. This diff fix that by adding a newline. Reviewed By: kirklandsign Differential Revision: D63037094 fbshipit-source-id: 549c4158ed54efdf29095926c77ea77f71b92dac (cherry picked from commit 2df0cc1) Co-authored-by: Riandy Riandy <[email protected]>
1 parent 93ea1f1 commit 1cabf8d

File tree

3 files changed

+41
-0
lines changed

3 files changed

+41
-0
lines changed

examples/demo-apps/apple_ios/LLaMA/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,15 @@ This section will provide the main steps to use the app, along with a code snipp
3636
```{note}
3737
ExecuTorch runtime is distributed as a Swift package providing some .xcframework as prebuilt binary targets.
3838
Xcode will download and cache the package on the first run, which will take some time.
39+
40+
Note: If you're running into any issues related to package dependencies, quit Xcode entirely, delete the whole executorch repo, clean the caches by running the command below in terminal and clone the repo again.
41+
42+
```
43+
rm -rf \
44+
~/Library/org.swift.swiftpm \
45+
~/Library/Caches/org.swift.swiftpm \
46+
~/Library/Caches/com.apple.dt.Xcode \
47+
~/Library/Developer/Xcode/DerivedData
3948
```
4049
4150
* Open XCode and select "Open an existing project" to open `examples/demo-apps/apple_ios/LLama`.

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,22 @@ The prebuilt ExecuTorch runtime, backend, and kernels are available as a Swift P
7878
### Xcode
7979
Open the project in Xcode.In Xcode, go to `File > Add Package Dependencies`. Paste the URL of the ExecuTorch repo into the search bar and select it. Make sure to change the branch name to the desired ExecuTorch version, e.g., “0.3.0”, or just use the “latest” branch name for the latest stable build.
8080

81+
Note: If you're running into any issues related to package dependencies, quit Xcode entirely, delete the whole executorch repo, clean the caches by running the command below in terminal and clone the repo again.
82+
83+
```
84+
rm -rf \
85+
~/Library/org.swift.swiftpm \
86+
~/Library/Caches/org.swift.swiftpm \
87+
~/Library/Caches/com.apple.dt.Xcode \
88+
~/Library/Developer/Xcode/DerivedData
89+
```
90+
91+
Link your binary with the ExecuTorch runtime and any backends or kernels used by the exported ML model. It is recommended to link the core runtime to the components that use ExecuTorch directly, and link kernels and backends against the main app target.
92+
93+
Note: To access logs, link against the Debug build of the ExecuTorch runtime, i.e., the executorch_debug framework. For optimal performance, always link against the Release version of the deliverables (those without the _debug suffix), which have all logging overhead removed.
94+
95+
For more details integrating and Running ExecuTorch on Apple Platforms, checkout this [link](https://pytorch.org/executorch/main/apple-runtime.html).
96+
8197
<p align="center">
8298
<img src="../screenshots/ios_demo_app_swift_pm.png" alt="iOS LLaMA App Swift PM" width="600">
8399
</p>

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,22 @@ The prebuilt ExecuTorch runtime, backend, and kernels are available as a Swift P
7878
### Xcode
7979
Open the project in Xcode.In Xcode, go to `File > Add Package Dependencies`. Paste the URL of the ExecuTorch repo into the search bar and select it. Make sure to change the branch name to the desired ExecuTorch version, e.g., “0.3.0”, or just use the “latest” branch name for the latest stable build.
8080

81+
Note: If you're running into any issues related to package dependencies, quit Xcode entirely, delete the whole executorch repo, clean the caches by running the command below in terminal and clone the repo again.
82+
83+
```
84+
rm -rf \
85+
~/Library/org.swift.swiftpm \
86+
~/Library/Caches/org.swift.swiftpm \
87+
~/Library/Caches/com.apple.dt.Xcode \
88+
~/Library/Developer/Xcode/DerivedData
89+
```
90+
91+
Link your binary with the ExecuTorch runtime and any backends or kernels used by the exported ML model. It is recommended to link the core runtime to the components that use ExecuTorch directly, and link kernels and backends against the main app target.
92+
93+
Note: To access logs, link against the Debug build of the ExecuTorch runtime, i.e., the executorch_debug framework. For optimal performance, always link against the Release version of the deliverables (those without the _debug suffix), which have all logging overhead removed.
94+
95+
For more details integrating and Running ExecuTorch on Apple Platforms, checkout this [link](https://pytorch.org/executorch/main/apple-runtime.html).
96+
8197
<p align="center">
8298
<img src="../screenshots/ios_demo_app_swift_pm.png" alt="iOS LLaMA App Swift PM" width="600">
8399
</p>

0 commit comments

Comments
 (0)