whisper : add submodule for ggml

.github/workflows/bindings-go.yml

@@ -17,6 +17,8 @@ jobs:
         with:
           go-version: '^1.23'
       - uses: actions/checkout@v4
+        with:
+          submodules: true
       - run: |
           cd bindings/go
           make test

.github/workflows/bindings-ruby.yml

@@ -62,4 +62,6 @@ jobs:
         with:
           ruby-version: '3.1'
       - uses: actions/checkout@v4
+        with:
+          submodules: true
       - run: rake test

.github/workflows/build.yml

@@ -47,6 +47,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          submodules: true
 
       - name: Determine tag name
         id: tag
@@ -91,6 +92,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -119,6 +122,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -147,6 +152,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -175,6 +182,8 @@ jobs:
       - name: Clone
         id: checkout
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: ccache
         uses: hendrikmuhs/[email protected]
@@ -206,6 +215,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Build
         uses: cross-platform-actions/[email protected]
@@ -232,6 +243,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -262,6 +275,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -292,6 +307,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -325,6 +342,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -355,6 +374,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -391,6 +412,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: add oneAPI to apt
         shell: bash
@@ -415,6 +438,8 @@ jobs:
       - name: Clone
         id: checkout
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Build
         id: cmake_build
@@ -443,6 +468,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: add oneAPI to apt
         shell: bash
@@ -467,6 +494,8 @@ jobs:
       - name: Clone
         id: checkout
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Build
         id: cmake_build
@@ -492,6 +521,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Setup ${{ matrix.sys }}
         uses: msys2/setup-msys2@v2
@@ -546,6 +577,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Add msbuild to PATH
         uses: microsoft/setup-msbuild@v2
@@ -607,6 +640,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Export GitHub Actions cache environment variables
         uses: actions/github-script@v7
@@ -678,6 +713,8 @@ jobs:
     steps:
       - name: Clone repository
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Install Ninja
         id: install_ninja
@@ -866,6 +903,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Setup emsdk
         uses: mymindstorm/setup-emsdk@v14
@@ -889,6 +928,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Configure
         run: |
@@ -950,6 +991,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           path: whisper
+          submodules: true
 
       - name: Install Java
         uses: actions/setup-java@v4
@@ -977,6 +1019,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: set up JDK 11
         uses: actions/setup-java@v4
@@ -1002,6 +1046,8 @@ jobs:
 #    runs-on: windows-latest
 #    steps:
 #      - uses: actions/checkout@v4
+#        with:
+#          submodules: true
 #
 #      - name: Install Java
 #        uses: actions/setup-java@v4
@@ -1048,6 +1094,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Test quantize
         run: |
@@ -1071,6 +1119,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          submodules: true
 
       - name: ccache
         uses: hendrikmuhs/[email protected]
@@ -1130,6 +1179,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Set environment variables
         id: set_vars

.github/workflows/docker.yml

@@ -25,6 +25,8 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v3
+        with:
+          submodules: true
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3

.github/workflows/examples-wasm.yml

@@ -23,6 +23,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Setup Pages
         uses: actions/configure-pages@v4

.github/workflows/examples.yml

@@ -18,6 +18,8 @@ jobs:
     steps:
       - name: Clone
         uses: actions/checkout@v1
+        with:
+          submodules: true
 
       - name: Dependencies
         run: |

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "ggml"]
+	path = ggml
+	url = https://github.com/ggml-org/ggml

Makefile

@@ -56,3 +56,8 @@ tiny.en tiny base.en base small.en small medium.en medium large-v1 large-v2 larg
 		./build/bin/whisper-cli -m models/[email protected] -f $$f ; \
 		echo "" ; \
 	done
+
+.PHONY: update-ggml
+update-ggml:
+	echo "Updating ggml submodule..."
+	git submodule update --remote ggml

README.md

@@ -58,7 +58,7 @@ https://github.com/ggerganov/whisper.cpp/assets/1991296/c82e8f86-60dc-49f2-b048-
 First clone the repository:
 
 ```bash
-git clone https://github.com/ggerganov/whisper.cpp.git
+git clone --recurse-submodules https://github.com/ggerganov/whisper.cpp.git
 ```
 
 Navigate into the directory:

bindings/go/README.md

@@ -51,7 +51,7 @@ func main() {
 In order to build, you need to have the Go compiler installed. You can get it from [here](https://golang.org/dl/). Run the tests with:
 
 ```bash
-git clone https://github.com/ggerganov/whisper.cpp.git
+git clone --recurse-submodules https://github.com/ggerganov/whisper.cpp.git
 cd whisper.cpp/bindings/go
 make test
 ```

bindings/java/README.md

@@ -52,7 +52,7 @@ public class Example {
 In order to build, you need to have the JDK 8 or higher installed. Run the tests with:
 
 ```bash
-git clone https://github.com/ggerganov/whisper.cpp.git
+git clone --recurse-submodules https://github.com/ggerganov/whisper.cpp.git
 cd whisper.cpp/bindings/java
 
 ./gradlew build

bindings/javascript/README.md

@@ -19,7 +19,7 @@ For sample usage check [tests/test-whisper.js](/tests/test-whisper.js)
 source /path/to/emsdk/emsdk_env.sh
 
 # clone repo
-git clone https://github.com/ggerganov/whisper.cpp
+git clone https://github.com/ggerganov/whisper.cpp.git
 cd whisper.cpp
 
 # grab base.en model

bindings/ruby/README.md

@@ -228,7 +228,7 @@ The second argument `samples` may be an array, an object with `length` and `each
 Development
 -----------
 
-    % git clone https://github.com/ggerganov/whisper.cpp.git
+    % git clone --recurse-submodules https://github.com/ggerganov/whisper.cpp.git
     % cd whisper.cpp/bindings/ruby
     % rake test
 

bindings/ruby/extsources.rb

@@ -1,6 +1,6 @@
 require "yaml"
 
-sources = `git ls-files -z ../..`.split("\x0")
+sources = `git ls-files -z ../.. --recurse-submodules`.split("\x0")
 paths = YAML.load_file("../../.github/workflows/bindings-ruby.yml")[true]["push"]["paths"]
 paths.delete "bindings/ruby/**"
 EXTSOURCES = (Dir.glob(paths, base: "../..").collect {|path| "../../#{path}"} << "../../LICENSE") & sources

examples/bench.wasm/README.md

@@ -10,7 +10,7 @@ Terminal version: [examples/bench](/examples/bench)
 
 ```bash
 # build using Emscripten (v3.1.2)
-git clone https://github.com/ggerganov/whisper.cpp
+git clone --recurse-submodules https://github.com/ggerganov/whisper.cpp.git
 cd whisper.cpp
 mkdir build-em && cd build-em
 emcmake cmake ..

examples/command.wasm/README.md

@@ -11,7 +11,7 @@ Terminal version: [examples/command](/examples/command)
 
 ```bash
 # build using Emscripten (v3.1.2)
-git clone https://github.com/ggerganov/whisper.cpp
+git clone --recurse-submodules https://github.com/ggerganov/whisper.cpp.git
 cd whisper.cpp
 mkdir build-em && cd build-em
 emcmake cmake ..

examples/stream.wasm/README.md

@@ -8,7 +8,7 @@ Online demo: https://whisper.ggerganov.com/stream/
 
 ```bash
 # build using Emscripten (v3.1.2)
-git clone https://github.com/ggerganov/whisper.cpp
+git clone --recurse-submodules https://github.com/ggerganov/whisper.cpp.git
 cd whisper.cpp
 mkdir build-em && cd build-em
 emcmake cmake ..

examples/whisper.nvim/README.md

@@ -18,7 +18,7 @@ https://user-images.githubusercontent.com/1991296/198382564-784e9663-2037-4d04-9
 - Clone this repo and build the `stream` tool:
 
   ```
-  git clone https://github.com/ggerganov/whisper.cpp
+  git clone --recurse-submodules https://github.com/ggerganov/whisper.cpp.git
   cd whisper.cpp
   make stream
   ```

examples/whisper.wasm/README.md

@@ -30,7 +30,7 @@ Link: https://ggerganov.github.io/whisper.cpp/
 
 ```bash (v3.1.2)
 # build using Emscripten
-git clone https://github.com/ggerganov/whisper.cpp
+git clone --recurse-submodules https://github.com/ggerganov/whisper.cpp.git
 cd whisper.cpp
 mkdir build-em && cd build-em
 emcmake cmake ..