Fix CIs (#128)

Co-authored-by: root <[email protected]>
Co-authored-by: Alex Hayton <[email protected]>

.github/workflows/build.yml

@@ -4,10 +4,31 @@ on:
  push:
  branches:
  - main
- paths: ['.github/workflows/**', '**/CMakeLists.txt', '**/Makefile', '**/*.h', '**/*.hpp', '**/*.c', '**/*.cpp', '**/*.cu']
+ - encodec-submodule-fix-ci
+ paths:
+ [
+ ".github/workflows/**",
+ "**/CMakeLists.txt",
+ "**/Makefile",
+ "**/*.h",
+ "**/*.hpp",
+ "**/*.c",
+ "**/*.cpp",
+ "**/*.cu",
+ ]
  pull_request:
  types: [opened, synchronize, reopened]
- paths: ['**/CMakeLists.txt', '**/Makefile', '**/*.h', '**/*.hpp', '**/*.c', '**/*.cpp', '**/*.cu', ".github/workflows/**"]
+ paths:
+ [
+ "**/CMakeLists.txt",
+ "**/Makefile",
+ "**/*.h",
+ "**/*.hpp",
+ "**/*.c",
+ "**/*.cpp",
+ "**/*.cu",
+ ".github/workflows/**",
+ ]
 
 env:
  BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
@@ -24,7 +45,7 @@ jobs:
  id: checkout
  uses: actions/checkout@v4
  with:
- submodules: true
+ submodules: recursive
 
  - name: Dependencies
  id: depends
@@ -49,7 +70,7 @@ jobs:
  id: checkout
  uses: actions/checkout@v4
  with:
- submodules: true
+ submodules: recursive
 
  - name: Dependencies
  id: depends

.gitmodules

@@ -1,7 +1,3 @@
-[submodule "ggml"]
- path = ggml
- url = https://github.com/ggerganov/ggml.git
-
 [submodule "encodec.cpp"]
  path = encodec.cpp
  url = https://github.com/PABannier/encodec.cpp.git

README.md

@@ -158,15 +158,16 @@ Here are the steps for the bark model.
 ```bash
 git clone --recursive https://github.com/PABannier/bark.cpp.git
 cd bark.cpp
+git submodule update --init --recursive
 ```
 
 ### Build
 
 In order to build bark.cpp you must use `CMake`:
 
 ```bash
-mkdir build
-cd build
+mkdir bark/build
+cd bark/build
 cmake ..
 cmake --build . --config Release
 ```
@@ -175,20 +176,19 @@ cmake --build . --config Release
 
 ```bash
 # install Python dependencies
-python3 -m pip install -r requirements.txt
+python3 -m pip install -r bark/requirements.txt
 
 # obtain the original bark and encodec weights and place them in ./models
-python3 download_weights.py --download-dir ./models
+python3 bark/download_weights.py --download-dir ./models
 
 # convert the model to ggml format
-python3 convert.py \
+python3 bark/convert.py \
  --dir-model ./models \
- --codec-path ./models \
  --vocab-path ./ggml_weights/ \
  --out-dir ./ggml_weights/
 
 # run the inference
-./main -m ./ggml_weights/ -p "this is an audio"
+./bark/build/examples/main/main -m ./ggml_weights/ -p "this is an audio"
 ```
 
 ### (Optional) Quantize weights
@@ -199,9 +199,11 @@ Note that to preserve audio quality, we do not quantize the codec model. The bul
 computation is in the forward pass of the GPT models.
 
 ```bash
-./quantize ./ggml_weights/ggml_weights_text.bin ./ggml_weights_q4/ggml_weights_text.bin q4_0
-./quantize ./ggml_weights/ggml_weights_coarse.bin ./ggml_weights_q4/ggml_weights_coarse.bin q4_0
-./quantize ./ggml_weights/ggml_weights_fine.bin ./ggml_weights_q4/ggml_weights_fine.bin q4_0
+mkdir ggml_weights_q4
+cp ggml_weights/*vocab* ggml_weights_q4
+./bark/build/examples/quantize/quantize ./ggml_weights/ggml_weights_text.bin ./ggml_weights_q4/ggml_weights_text.bin q4_0
+./bark/build/examples/quantize/quantize ./ggml_weights/ggml_weights_coarse.bin ./ggml_weights_q4/ggml_weights_coarse.bin q4_0
+./bark/build/examples/quantize/quantize ./ggml_weights/ggml_weights_fine.bin ./ggml_weights_q4/ggml_weights_fine.bin q4_0
 ```
 
 ### Seminal papers and background on models