From 854c0518bc93a67b65ad874b64b936ac1de253b5 Mon Sep 17 00:00:00 2001 From: Daniel Bevenius Date: Wed, 2 Apr 2025 08:32:14 +0200 Subject: [PATCH] examples : clarify Core ML encoder model usage [no ci] (#2987) This commit clarifies the usage of the Core ML encoder model in the whisper.obj and whisper.swiftui examples. Refs: https://github.com/ggerganov/whisper.cpp/issues/2783 --- examples/whisper.objc/README.md | 4 +++- examples/whisper.swiftui/README.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/examples/whisper.objc/README.md b/examples/whisper.objc/README.md index 609b9603..7e790dbc 100644 --- a/examples/whisper.objc/README.md +++ b/examples/whisper.objc/README.md @@ -30,4 +30,6 @@ mkdir models/ggml-base.en-encoder.mlmodelc Follow the [`Core ML support` section of readme](../../README.md#core-ml-support) to convert the model. That is all the needs to be done to use the Core ML model in the app. The converted model is a -resource in the project and will be used if it is available. +resource in the project and will be used if it is available. Note that the Core ML model is only +used for the encoder, the decoder which is in the ggml model is still required so both need to +be available. diff --git a/examples/whisper.swiftui/README.md b/examples/whisper.swiftui/README.md index 88e1c9ec..5b0b2918 100644 --- a/examples/whisper.swiftui/README.md +++ b/examples/whisper.swiftui/README.md @@ -34,7 +34,9 @@ sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer **Note:** Pay attention to the folder path: `whisper.swiftui.demo/Resources/models` is the appropriate directory to place resources whilst `whisper.swiftui.demo/Models` is related to actual code. ### Core ML support -1. Follow all the steps in the `Usage` section, including adding the ggml model file. +1. Follow all the steps in the `Usage` section, including adding the ggml model file. +The ggml model file is required as the Core ML model is only used for the encoder. The +decoder which is in the ggml model is still required. 2. Follow the [`Core ML support` section of readme](../../README.md#core-ml-support) to convert the model. 3. Add the Core ML model (`models/ggml-base.en-encoder.mlmodelc/`) to `whisper.swiftui.demo/Resources/models` **via Xcode**.