Upload 15 files
Browse files- .gitattributes +13 -0
- LICENSE +21 -0
- README.md +119 -0
- whisper-base-q4_0.gguf +3 -0
- whisper-base-q4_1.gguf +3 -0
- whisper-base-q8_0.gguf +3 -0
- whisper.cpp/whisper-base-q2_k.gguf +3 -0
- whisper.cpp/whisper-base-q3_k.gguf +3 -0
- whisper.cpp/whisper-base-q4_0.gguf +3 -0
- whisper.cpp/whisper-base-q4_1.gguf +3 -0
- whisper.cpp/whisper-base-q4_k.gguf +3 -0
- whisper.cpp/whisper-base-q5_0.gguf +3 -0
- whisper.cpp/whisper-base-q5_1.gguf +3 -0
- whisper.cpp/whisper-base-q5_k.gguf +3 -0
- whisper.cpp/whisper-base-q6_k.gguf +3 -0
- whisper.cpp/whisper-base-q8_0.gguf +3 -0
.gitattributes
CHANGED
|
@@ -33,3 +33,16 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
|
|
| 33 |
*.zip filter=lfs diff=lfs merge=lfs -text
|
| 34 |
*.zst filter=lfs diff=lfs merge=lfs -text
|
| 35 |
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 33 |
*.zip filter=lfs diff=lfs merge=lfs -text
|
| 34 |
*.zst filter=lfs diff=lfs merge=lfs -text
|
| 35 |
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
| 36 |
+
whisper-base-q4_0.gguf filter=lfs diff=lfs merge=lfs -text
|
| 37 |
+
whisper-base-q4_1.gguf filter=lfs diff=lfs merge=lfs -text
|
| 38 |
+
whisper-base-q8_0.gguf filter=lfs diff=lfs merge=lfs -text
|
| 39 |
+
whisper.cpp/whisper-base-q2_k.gguf filter=lfs diff=lfs merge=lfs -text
|
| 40 |
+
whisper.cpp/whisper-base-q3_k.gguf filter=lfs diff=lfs merge=lfs -text
|
| 41 |
+
whisper.cpp/whisper-base-q4_0.gguf filter=lfs diff=lfs merge=lfs -text
|
| 42 |
+
whisper.cpp/whisper-base-q4_1.gguf filter=lfs diff=lfs merge=lfs -text
|
| 43 |
+
whisper.cpp/whisper-base-q4_k.gguf filter=lfs diff=lfs merge=lfs -text
|
| 44 |
+
whisper.cpp/whisper-base-q5_0.gguf filter=lfs diff=lfs merge=lfs -text
|
| 45 |
+
whisper.cpp/whisper-base-q5_1.gguf filter=lfs diff=lfs merge=lfs -text
|
| 46 |
+
whisper.cpp/whisper-base-q5_k.gguf filter=lfs diff=lfs merge=lfs -text
|
| 47 |
+
whisper.cpp/whisper-base-q6_k.gguf filter=lfs diff=lfs merge=lfs -text
|
| 48 |
+
whisper.cpp/whisper-base-q8_0.gguf filter=lfs diff=lfs merge=lfs -text
|
LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
MIT License
|
| 2 |
+
|
| 3 |
+
Copyright (c) 2022 OpenAI
|
| 4 |
+
|
| 5 |
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
| 6 |
+
of this software and associated documentation files (the "Software"), to deal
|
| 7 |
+
in the Software without restriction, including without limitation the rights
|
| 8 |
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
| 9 |
+
copies of the Software, and to permit persons to whom the Software is
|
| 10 |
+
furnished to do so, subject to the following conditions:
|
| 11 |
+
|
| 12 |
+
The above copyright notice and this permission notice shall be included in all
|
| 13 |
+
copies or substantial portions of the Software.
|
| 14 |
+
|
| 15 |
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| 16 |
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
| 17 |
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
| 18 |
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
| 19 |
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
| 20 |
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
| 21 |
+
SOFTWARE.
|
README.md
ADDED
|
@@ -0,0 +1,119 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: mit
|
| 3 |
+
language:
|
| 4 |
+
- multilingual
|
| 5 |
+
- en
|
| 6 |
+
- ru
|
| 7 |
+
tags:
|
| 8 |
+
- whisper
|
| 9 |
+
- gguf
|
| 10 |
+
- quantized
|
| 11 |
+
- speech-recognition
|
| 12 |
+
- rust
|
| 13 |
+
base_model:
|
| 14 |
+
- openai/whisper-base
|
| 15 |
+
---
|
| 16 |
+
|
| 17 |
+
# WHISPER-BASE - GGUF Quantized Models
|
| 18 |
+
|
| 19 |
+
Quantized versions of [openai/whisper-base](https://huggingface.co/openai/whisper-base) in GGUF format.
|
| 20 |
+
|
| 21 |
+
## Directory Structure
|
| 22 |
+
|
| 23 |
+
```
|
| 24 |
+
base/
|
| 25 |
+
├── whisper-base-q*.gguf # Candle-compatible GGUF models (root)
|
| 26 |
+
├── config.json # Model configuration for Candle
|
| 27 |
+
├── tokenizer.json # Tokenizer for Candle
|
| 28 |
+
└── whisper.cpp/ # whisper.cpp-compatible models
|
| 29 |
+
└── whisper-base-q*.gguf
|
| 30 |
+
|
| 31 |
+
```
|
| 32 |
+
|
| 33 |
+
### Format Compatibility
|
| 34 |
+
|
| 35 |
+
- **Root directory** (`whisper-base-*.gguf`): Use with **Candle** (Rust ML framework)
|
| 36 |
+
- Tensor names include `model.` prefix (e.g., `model.encoder.conv1.weight`)
|
| 37 |
+
- Compatible with Neurolang application
|
| 38 |
+
- Requires `config-base.json` and `tokenizer-base.json`
|
| 39 |
+
|
| 40 |
+
- **whisper.cpp/** directory: Use with **whisper.cpp** (C++ implementation)
|
| 41 |
+
- Tensor names without `model.` prefix (e.g., `encoder.conv1.weight`)
|
| 42 |
+
- Compatible with whisper.cpp CLI tools
|
| 43 |
+
- Both directories contain `.gguf` files, not `.bin` files
|
| 44 |
+
|
| 45 |
+
## Available Formats
|
| 46 |
+
|
| 47 |
+
| Format | Quality | Use Case |
|
| 48 |
+
|--------| ---------|----------|
|
| 49 |
+
| q2_k | Smallest | Extreme compression |
|
| 50 |
+
| q3_k | Small | Mobile devices |
|
| 51 |
+
| q4_0 | Good | Legacy compatibility |
|
| 52 |
+
| q4_k | Good | **Recommended for production** |
|
| 53 |
+
| q4_1 | Good+ | Legacy with bias |
|
| 54 |
+
| q5_0 | Very Good | Legacy compatibility |
|
| 55 |
+
| q5_k | Very Good | High quality |
|
| 56 |
+
| q5_1 | Very Good+ | Legacy with bias |
|
| 57 |
+
| q6_k | Excellent | Near-lossless |
|
| 58 |
+
| q8_0 | Excellent | Minimal loss, benchmarking |
|
| 59 |
+
|
| 60 |
+
## Usage
|
| 61 |
+
|
| 62 |
+
### With Candle (Rust)
|
| 63 |
+
|
| 64 |
+
> For this model, you need to modify the example code in candle. To try whisper in candle faster and easier, it's better to use the tiny model → https://huggingface.co/oxide-lab/whisper-tiny-GGUF
|
| 65 |
+
|
| 66 |
+
**Command line example:**
|
| 67 |
+
```bash
|
| 68 |
+
# Run Candle Whisper with local quantized model
|
| 69 |
+
cargo run --example whisper --release -- \
|
| 70 |
+
--features symphonia \
|
| 71 |
+
--quantized \
|
| 72 |
+
--model base \
|
| 73 |
+
--model-id oxide-lab/whisper-base-GGUF \
|
| 74 |
+
```
|
| 75 |
+
|
| 76 |
+
### With whisper.cpp (C++)
|
| 77 |
+
|
| 78 |
+
```bash
|
| 79 |
+
# Use models from whisper.cpp/ subdirectory
|
| 80 |
+
./whisper.cpp/build/bin/whisper-cli \
|
| 81 |
+
--model models/openai/base/whisper.cpp/whisper-base-q4_k.gguf \
|
| 82 |
+
--file audio.wav
|
| 83 |
+
```
|
| 84 |
+
|
| 85 |
+
### Recommended Format
|
| 86 |
+
|
| 87 |
+
For most use cases, we recommend **q4_k** format as it provides the best balance of:
|
| 88 |
+
- Size reduction (~65% smaller)
|
| 89 |
+
- Quality (minimal degradation)
|
| 90 |
+
- Speed (faster inference than higher quantizations)
|
| 91 |
+
|
| 92 |
+
## Quantization Details
|
| 93 |
+
|
| 94 |
+
- **Source Model**: [openai/whisper-base](https://huggingface.co/openai/whisper-base)
|
| 95 |
+
- **Quantization Methods**:
|
| 96 |
+
- **Candle GGUF** (root directory): Python-based quantization via `convert_whisper_to_gguf.py`
|
| 97 |
+
- Adds `model.` prefix to tensor names for Candle compatibility
|
| 98 |
+
- **whisper.cpp GGML** (whisper.cpp/ subdirectory): whisper-quantize tool
|
| 99 |
+
- Uses original tensor names without prefix
|
| 100 |
+
- **Format**: GGUF (GGML Universal Format) for both directories
|
| 101 |
+
- **Total Formats**: 10 quantization levels (q2_k through q8_0)
|
| 102 |
+
|
| 103 |
+
## License
|
| 104 |
+
|
| 105 |
+
Same as the original Whisper model (MIT License).
|
| 106 |
+
|
| 107 |
+
## Citation
|
| 108 |
+
|
| 109 |
+
```bibtex
|
| 110 |
+
@misc{radford2022whisper,
|
| 111 |
+
doi = {10.48550/ARXIV.2212.04356},
|
| 112 |
+
url = {https://arxiv.org/abs/2212.04356},
|
| 113 |
+
author = {Radford, Alec and Kim, Jong Wook and Xu, Tao and Brockman, Greg and McLeavey, Christine and Sutskever, Ilya},
|
| 114 |
+
title = {Robust Speech Recognition via Large-Scale Weak Supervision},
|
| 115 |
+
publisher = {arXiv},
|
| 116 |
+
year = {2022},
|
| 117 |
+
copyright = {arXiv.org perpetual, non-exclusive license}
|
| 118 |
+
}
|
| 119 |
+
```
|
whisper-base-q4_0.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:22809041141b46886636a0fc7797c4c0115b511813d587c9d5173648807498d3
|
| 3 |
+
size 42225024
|
whisper-base-q4_1.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:31bdfaeab20436cd45ba0dfb85c6b0d2c1fe200ecf8d6c048d74cfa45dfa4982
|
| 3 |
+
size 46705312
|
whisper-base-q8_0.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:7073e51db7ab02b38cc4fceeac39adc2d7a19beb98badf66aa708f4f0ac71aa9
|
| 3 |
+
size 78067328
|
whisper.cpp/whisper-base-q2_k.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:b4b31be3e5502ba7448e9eeac62060350b78e00030b601e2bd2092fdf90b3f25
|
| 3 |
+
size 29925346
|
whisper.cpp/whisper-base-q3_k.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:1574ac666e7f91c3eb9d41f9817ec22863db00cf9a9edfe8769aef8adbb925fb
|
| 3 |
+
size 37095158
|
whisper.cpp/whisper-base-q4_0.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:e5ff00771a552622fede4e1414f774807977e954c979e726663f1e1f0c09dea3
|
| 3 |
+
size 46471066
|
whisper.cpp/whisper-base-q4_1.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:6beda1cd50bb57fb715047ad30db9a15bae104ca48a25075c57b6f23a49573fe
|
| 3 |
+
size 50883258
|
whisper.cpp/whisper-base-q4_k.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:1cc4b7f3abe855fd0ad772dc1f76728837a8cfe704f8026e79af73a997e7e7d2
|
| 3 |
+
size 46471066
|
whisper.cpp/whisper-base-q5_0.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:7221da9b3d43a7367ae87cda6cdde2728ea70f086bf93939537bba7d9996729a
|
| 3 |
+
size 55295450
|
whisper.cpp/whisper-base-q5_1.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:36a6bf6281261fec331fcc65235e0f466d855ea4dae1bbbfb28ed4c0cf72d8c0
|
| 3 |
+
size 59707642
|
whisper.cpp/whisper-base-q5_k.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:98319420145d1890e89814fd670de1986ed7e97f3fc847f9c820ae4df932ba12
|
| 3 |
+
size 55295450
|
whisper.cpp/whisper-base-q6_k.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:aee213144524dd1d6595b828063528b3ce5415422e3a7be069827860a2585dd8
|
| 3 |
+
size 64671358
|
whisper.cpp/whisper-base-q8_0.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:cced49a244b3f776f42cfb4c41920037a4bc00058f41ef9579dee7f327d746de
|
| 3 |
+
size 81768602
|