Instructions to use OpenASR/dolphin-base with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- OpenASR
How to use OpenASR/dolphin-base with OpenASR:
# Install the openasr CLI: https://github.com/QuintinShaw/openasr/releases openasr pull dolphin-base openasr transcribe audio.wav --model dolphin-base
- Notebooks
- Google Colab
- Kaggle
Commit Β·
cedd9f6
verified Β·
0
Parent(s):
publish dolphin-base OpenASR packs
Browse files- .gitattributes +1 -0
- README.md +131 -0
- dolphin-base-fp16.oasr +3 -0
- dolphin-base-q4_k.oasr +3 -0
- dolphin-base-q8_0.oasr +3 -0
.gitattributes
ADDED
|
@@ -0,0 +1 @@
|
|
|
|
|
|
|
| 1 |
+
*.oasr filter=lfs diff=lfs merge=lfs -text
|
README.md
ADDED
|
@@ -0,0 +1,131 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: apache-2.0
|
| 3 |
+
base_model: DataoceanAI/dolphin-base
|
| 4 |
+
pipeline_tag: automatic-speech-recognition
|
| 5 |
+
library_name: openasr
|
| 6 |
+
tags:
|
| 7 |
+
- automatic-speech-recognition
|
| 8 |
+
- speech-to-text
|
| 9 |
+
- openasr
|
| 10 |
+
- oasr
|
| 11 |
+
- dolphin-base
|
| 12 |
+
---
|
| 13 |
+
|
| 14 |
+
<div align="center">
|
| 15 |
+
|
| 16 |
+
# Dolphin Base Β· OpenASR
|
| 17 |
+
|
| 18 |
+
**Multilingual speech recognition across 40 languages, base tier -- a compact 140M WeNet/ESPnet E-Branchformer (CTC + attention)**
|
| 19 |
+
|
| 20 |
+
[](https://huggingface.co/DataoceanAI/dolphin-base/blob/main/README.md)
|
| 21 |
+
[](https://github.com/QuintinShaw/openasr)
|
| 22 |
+
[](https://openasr.org)
|
| 23 |
+
[](https://huggingface.co/DataoceanAI/dolphin-base)
|
| 24 |
+
|
| 25 |
+
Native speech-to-text in the **[OpenASR](https://github.com/QuintinShaw/openasr)** runtime β
|
| 26 |
+
engineered for peak performance on CPU & GPU, **no Python at inference time**.
|
| 27 |
+
|
| 28 |
+
</div>
|
| 29 |
+
|
| 30 |
+
---
|
| 31 |
+
|
| 32 |
+
## β¨ Highlights
|
| 33 |
+
|
| 34 |
+
- π **40 languages, base tier** β the same multilingual E-Branchformer coverage as Dolphin Small (South Asian, Southeast Asian, Central Asian/Turkic, Chinese/Cantonese), at a fraction of the size
|
| 35 |
+
- πͺΆ **140M parameters** β roughly a third the width of the `small` checkpoint (512 vs 768 d_model, fewer layers), for tighter RAM and faster CPU decode when the small tier is overkill
|
| 36 |
+
- π§© **Joint CTC + attention** β the same E-Branchformer encoder + Transformer decoder recipe with CTC/attention rescoring, verified against a shape-derived runtime contract shared with the rest of the Dolphin family
|
| 37 |
+
- π¬ **SentencePiece BPE vocab** β a shared subword vocabulary across all 40 languages (distinct from the cn-dialect family's fixed character vocab)
|
| 38 |
+
- π¦ **Native in OpenASR** β `.oasr` packs run with no Python at inference, engineered for peak performance on CPU & GPU
|
| 39 |
+
|
| 40 |
+
## π Quickstart
|
| 41 |
+
|
| 42 |
+
```bash
|
| 43 |
+
# 1. Install the OpenASR CLI Β· https://openasr.org
|
| 44 |
+
# 2. Pull a build (pick a quant β see the table below)
|
| 45 |
+
openasr pull dolphin-base:fp16
|
| 46 |
+
|
| 47 |
+
# 3. Transcribe
|
| 48 |
+
openasr transcribe audio.wav --model dolphin-base
|
| 49 |
+
```
|
| 50 |
+
|
| 51 |
+
All builds for this model:
|
| 52 |
+
|
| 53 |
+
```bash
|
| 54 |
+
openasr pull dolphin-base:fp16
|
| 55 |
+
openasr pull dolphin-base:q8
|
| 56 |
+
openasr pull dolphin-base:q4
|
| 57 |
+
```
|
| 58 |
+
|
| 59 |
+
## π¦ Available builds
|
| 60 |
+
|
| 61 |
+
| Quant | File (`.oasr`) | Size | RAM peak | RTF Β· M1 CPU | RTF Β· M1 GPU | ΞCER vs fp16 |
|
| 62 |
+
|:------|:---------------|-----:|---------:|-------------:|-------------:|-----------------:|
|
| 63 |
+
| fp16 | `dolphin-base-fp16.oasr` | 287 MB | 1.92 GB | 0.15Γ | 0.14Γ | 0.0% |
|
| 64 |
+
| q8_0 | `dolphin-base-q8_0.oasr` | 158 MB | 1.76 GB | 0.15Γ | 0.16Γ | 0.0% |
|
| 65 |
+
| q4_k | `dolphin-base-q4_k.oasr` | 90 MB | 1.70 GB | 0.13Γ | 0.13Γ | 8.8% |
|
| 66 |
+
|
| 67 |
+
<sub>RTF = real-time factor on the shared 11s JFK clip (out-of-distribution, drift signal only) plus an in-language Mandarin sanity clip (**lower is faster**); RAM peak measured per pack
|
| 68 |
+
in an isolated subprocess. ΞCER compares each quantized build's JFK + zh sanity clip transcript to this model's
|
| 69 |
+
fp16 JFK + zh sanity clip transcript, so it measures quantization drift rather than absolute recognition accuracy.
|
| 70 |
+
**fp16** is the recommended default β near-reference quality at a fraction of the
|
| 71 |
+
footprint.</sub>
|
| 72 |
+
|
| 73 |
+
## π§ About Dolphin Base
|
| 74 |
+
|
| 75 |
+
Dolphin Base is the **140M "base" tier** of DataoceanAI's **multilingual** Dolphin speech-
|
| 76 |
+
recognition line, built on the same **Dolphin / ESPnet** recipe as the larger **Dolphin Small**:
|
| 77 |
+
an **E-Branchformer encoder + Transformer decoder** trained with a **joint CTC + attention**
|
| 78 |
+
objective over a shared SentencePiece BPE vocabulary spanning the card's advertised 40 languages
|
| 79 |
+
(South Asian, Southeast Asian, Central Asian/Turkic, and Chinese including Cantonese as `yue`),
|
| 80 |
+
at roughly a third of the small tier's encoder/decoder width -- a smaller RAM/CPU footprint for
|
| 81 |
+
deployments where the small tier's accuracy headroom is not needed. Like `dolphin-small`, this
|
| 82 |
+
checkpoint collapses this product's own Chinese-dialect granularity into a single `zh` (the
|
| 83 |
+
dedicated `dolphin-cn-dialect-small`/`-base` packs cover per-dialect prompting). This OpenASR
|
| 84 |
+
repo repackages the weights as `.oasr` packs that run natively in the OpenASR runtime -- no
|
| 85 |
+
Python at inference, all decoding local. It ships in **fp16** (maximum fidelity, recommended),
|
| 86 |
+
**q8_0**, and **q4_k** builds.
|
| 87 |
+
|
| 88 |
+
**Note:** this model does not emit punctuation. Its upstream training corpus is transcribed
|
| 89 |
+
without punctuation marks, so the decoder never predicts a punctuation token -- there is no
|
| 90 |
+
setting to enable it. Transcripts are plain, unpunctuated text by design.
|
| 91 |
+
|
| 92 |
+
**Verification status:** this pack is staged in a private repo, not yet publicly listed. Local
|
| 93 |
+
verification so far covers Mandarin (`zh`) sanity-checked against the upstream architecture and
|
| 94 |
+
bit-stable at fp16/q8_0, with a small (~9% CER) drift at q4_k versus fp16 on the sanity clip;
|
| 95 |
+
Japanese (`ja`), one of the 40 advertised languages, has not yet had a native-speaker listening
|
| 96 |
+
review and must get one before this model is made public.
|
| 97 |
+
|
| 98 |
+
## βοΈ How these packs were made
|
| 99 |
+
|
| 100 |
+
Converted from [DataoceanAI/dolphin-base](https://huggingface.co/DataoceanAI/dolphin-base) with the OpenASR importer:
|
| 101 |
+
|
| 102 |
+
```bash
|
| 103 |
+
openasr model-pack import dolphin <src> <out>.oasr \
|
| 104 |
+
--package-id dolphin-base --quantization {fp16,q8-0,q4-k}
|
| 105 |
+
```
|
| 106 |
+
|
| 107 |
+
The `.oasr` container is GGUF-backed; packs use zero-copy mmap weight binding and graph
|
| 108 |
+
buffer reuse to keep peak memory low.
|
| 109 |
+
|
| 110 |
+
## βοΈ License
|
| 111 |
+
|
| 112 |
+
These packs **inherit the upstream model's license: Apache-2.0**
|
| 113 |
+
([source](https://huggingface.co/DataoceanAI/dolphin-base/blob/main/README.md)). OpenASR packaging retains the upstream copyright and
|
| 114 |
+
NOTICE; the only modifications are format conversion and quantization.
|
| 115 |
+
|
| 116 |
+
## π Acknowledgements
|
| 117 |
+
|
| 118 |
+
This pack is a redistribution of **Dolphin Base**, created and open-sourced by **DataoceanAI**
|
| 119 |
+
([DataoceanAI/dolphin-base](https://huggingface.co/DataoceanAI/dolphin-base)). All credit for the
|
| 120 |
+
original architecture, training, and weights belongs to the authors; the license is inherited
|
| 121 |
+
from and identical to the upstream model (Apache-2.0). The model builds on the **Dolphin**
|
| 122 |
+
multilingual ASR project and the **ESPnet** E-Branchformer / joint CTC-attention recipe -- thank
|
| 123 |
+
you to the Dolphin and ESPnet teams and to DataoceanAI for releasing their work openly. OpenASR
|
| 124 |
+
only performs format conversion, quantization, runtime verification, and local-inference
|
| 125 |
+
adaptation.
|
| 126 |
+
|
| 127 |
+
## π Links
|
| 128 |
+
|
| 129 |
+
- π¦ **OpenASR** β <https://github.com/QuintinShaw/openasr>
|
| 130 |
+
- π **Website** β <https://openasr.org>
|
| 131 |
+
- π€ **Upstream model** β [DataoceanAI/dolphin-base](https://huggingface.co/DataoceanAI/dolphin-base)
|
dolphin-base-fp16.oasr
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:f8d83121160f08c5d166d0251403ec5d6e4719cccd8a18956e8f675a7d031ec3
|
| 3 |
+
size 286733696
|
dolphin-base-q4_k.oasr
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:c9882cc1568e742e60bd82c377f0f6c25b2799f21a058554cd8fbc107b0943cb
|
| 3 |
+
size 89504832
|
dolphin-base-q8_0.oasr
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:79ca61ddfcba1d83aec875fa5f7d482b8a7e92939f80345e152553a4f453add7
|
| 3 |
+
size 158106176
|