Skip to content

Commit 6f3c510

Browse files
committed
Add install option examples
1 parent 538cc0c commit 6f3c510

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

bindings/ruby/README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,21 @@ or,
2424

2525
$ gem install whispercpp -- --enable-ggml-cuda
2626

27-
See whisper.cpp's [README](https://github.com/ggml-org/whisper.cpp/blob/master/README.md) for available options. You need convert options present the README to Ruby-style options.
27+
See whisper.cpp's [README](https://github.com/ggml-org/whisper.cpp/blob/master/README.md) for available options. You need convert options present the README to Ruby-style options, for example:
28+
29+
Boolean options:
30+
31+
* `-DGGML_BLAS=1` -> `--enable-ggml-blas`
32+
* `-DWHISER_COREML=OFF` -> `--disable-whisper-coreml`
33+
34+
Argument options:
35+
36+
* `--ggml-cuda-compression-mode=string`
37+
38+
Combination:
39+
40+
* `-DGGML_CUDA=1 -DCMAKE_CUDA_ARCHITECTURES="86"` -> `--enable-ggml-cuda --cmake_cuda-architextures="86"`
41+
2842
For boolean options like `GGML_CUDA`, the README says `-DGGML_CUDA=1`. You need strip `-D`, prepend `--enable-` for `1` or `ON` (`--disable-` for `0` or `OFF`) and make it kebab-case: `--enable-ggml-cuda`.
2943
For options which require arguments like `CMAKE_CUDA_ARCHITECTURES`, the README says `-DCMAKE_CUDA_ARCHITECTURES="86"`. You need strip `-D`, prepend `--`, make it kebab-case, append `=` and append argument: `--cmake-cuda-architectures="86"`.
3044

0 commit comments

Comments
 (0)