diff options
Diffstat (limited to 'llama.cpp/examples/llama.swiftui/README.md')
| -rw-r--r-- | llama.cpp/examples/llama.swiftui/README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/llama.cpp/examples/llama.swiftui/README.md b/llama.cpp/examples/llama.swiftui/README.md new file mode 100644 index 0000000..bd7ce37 --- /dev/null +++ b/llama.cpp/examples/llama.swiftui/README.md @@ -0,0 +1,27 @@ +# llama.cpp/examples/llama.swiftui + +Local inference of llama.cpp on an iPhone. This is a sample app that can be used as a starting +point for more advanced projects. + +For usage instructions and performance stats, check the following discussion: https://github.com/ggml-org/llama.cpp/discussions/4508 + + +### Building +First llama.cpp need to be built and a XCFramework needs to be created. This can be done by running +the following script from the llama.cpp project root: +```console +$ ./build-xcframework.sh +``` +Open `llama.swiftui.xcodeproj` project in Xcode and you should be able to build and run the app on +a simulator or a real device. + +To use the framework with a different project, the XCFramework can be added to the project by +adding `build-apple/llama.xcframework` by dragging and dropping it into the project navigator, or +by manually selecting the framework in the "Frameworks, Libraries, and Embedded Content" section +of the project settings. + + + +Video demonstration: + +https://github.com/bachittle/llama.cpp/assets/39804642/e290827a-4edb-4093-9642-2a5e399ec545 |