OpenASR commited on
Commit
85a23dd
Β·
verified Β·
0 Parent(s):

publish dolphin-small OpenASR packs

Browse files
.gitattributes ADDED
@@ -0,0 +1 @@
 
 
1
+ *.oasr filter=lfs diff=lfs merge=lfs -text
README.md ADDED
@@ -0,0 +1,130 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ base_model: DataoceanAI/dolphin-small
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-small
12
+ ---
13
+
14
+ <div align="center">
15
+
16
+ # Dolphin Small Β· OpenASR
17
+
18
+ **Multilingual speech recognition across 40 languages -- a WeNet/ESPnet E-Branchformer (CTC + attention) covering South/Southeast/Central Asian and Chinese-dialect speech**
19
+
20
+ [![License](https://img.shields.io/badge/license-Apache--2.0-2563eb.svg)](https://huggingface.co/DataoceanAI/dolphin-small/blob/main/README.md)
21
+ [![Format](https://img.shields.io/badge/format-.oasr-7c3aed.svg)](https://github.com/QuintinShaw/openasr)
22
+ [![Runtime](https://img.shields.io/badge/runtime-OpenASR-111827.svg)](https://openasr.org)
23
+ [![Base model](https://img.shields.io/badge/base-dolphin--small-f59e0b.svg)](https://huggingface.co/DataoceanAI/dolphin-small)
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, one checkpoint** β€” a WeNet/ESPnet E-Branchformer spanning South Asian (Hindi, Bengali, Urdu...), Southeast Asian (Vietnamese, Thai, Indonesian...), Central Asian/Turkic (Kazakh, Uzbek, Azerbaijani...), and Chinese/Cantonese speech, with per-utterance `<lang><region>` prompting
35
+ - 🧩 **Joint CTC + attention** β€” an E-Branchformer encoder with a Transformer decoder and CTC/attention rescoring, verified against a shape-derived runtime contract shared with the rest of the Dolphin family
36
+ - 🐬 **SentencePiece BPE vocab** β€” a shared subword vocabulary across all 40 languages (distinct from the cn-dialect family's fixed character vocab), suited to code-mixed and cross-lingual speech
37
+ - πŸͺΆ **372M parameters, `small` tier** β€” the larger of the two multilingual Dolphin sizes (paired with the more compact `dolphin-base`)
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-small:fp16
46
+
47
+ # 3. Transcribe
48
+ openasr transcribe audio.wav --model dolphin-small
49
+ ```
50
+
51
+ All builds for this model:
52
+
53
+ ```bash
54
+ openasr pull dolphin-small:fp16
55
+ openasr pull dolphin-small:q8
56
+ openasr pull dolphin-small: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-small-fp16.oasr` | 754 MB | 3.86 GB | 0.35Γ— | 0.59Γ— | 0.0% |
64
+ | q8_0 | `dolphin-small-q8_0.oasr` | 412 MB | 2.68 GB | 0.37Γ— | 0.80Γ— | 0.0% |
65
+ | q4_k | `dolphin-small-q4_k.oasr` | 229 MB | 3.56 GB | 0.43Γ— | 0.33Γ— | 0.0% |
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 Small
74
+
75
+ Dolphin Small is the **372M "small" tier** of DataoceanAI's **multilingual** Dolphin speech-
76
+ recognition line, built on the **Dolphin / ESPnet** recipe as an **E-Branchformer encoder +
77
+ Transformer decoder** trained with a **joint CTC + attention** objective over a shared
78
+ SentencePiece BPE vocabulary. Unlike the dedicated `dolphin-cn-dialect-*` checkpoints (fixed
79
+ `<zh>` language token, Chinese-only char vocab), this multilingual checkpoint varies **both**
80
+ the language and region prompt slots across the card's advertised 40 languages -- South Asian,
81
+ Southeast Asian, Central Asian/Turkic, and Chinese (including Cantonese, listed separately as
82
+ `yue`) -- while collapsing this product's own Chinese-dialect granularity into a single `zh`
83
+ (the dedicated `dolphin-cn-dialect-small`/`-base` packs cover per-dialect prompting; this
84
+ checkpoint does not). This OpenASR repo repackages the weights as `.oasr` packs that run natively
85
+ in the OpenASR runtime -- no Python at inference, all decoding local. It ships in **fp16**
86
+ (maximum fidelity, recommended), **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 across fp16/q8_0/q4_k quants; Japanese (`ja`), one of the 40 advertised languages, has
95
+ not yet had a native-speaker listening review and must get one before this model is made public.
96
+
97
+ ## βš™οΈ How these packs were made
98
+
99
+ Converted from [DataoceanAI/dolphin-small](https://huggingface.co/DataoceanAI/dolphin-small) with the OpenASR importer:
100
+
101
+ ```bash
102
+ openasr model-pack import dolphin <src> <out>.oasr \
103
+ --package-id dolphin-small --quantization {fp16,q8-0,q4-k}
104
+ ```
105
+
106
+ The `.oasr` container is GGUF-backed; packs use zero-copy mmap weight binding and graph
107
+ buffer reuse to keep peak memory low.
108
+
109
+ ## βš–οΈ License
110
+
111
+ These packs **inherit the upstream model's license: Apache-2.0**
112
+ ([source](https://huggingface.co/DataoceanAI/dolphin-small/blob/main/README.md)). OpenASR packaging retains the upstream copyright and
113
+ NOTICE; the only modifications are format conversion and quantization.
114
+
115
+ ## πŸ™ Acknowledgements
116
+
117
+ This pack is a redistribution of **Dolphin Small**, created and open-sourced by **DataoceanAI**
118
+ ([DataoceanAI/dolphin-small](https://huggingface.co/DataoceanAI/dolphin-small)). All credit for
119
+ the original architecture, training, and weights belongs to the authors; the license is inherited
120
+ from and identical to the upstream model (Apache-2.0). The model builds on the **Dolphin**
121
+ multilingual ASR project and the **ESPnet** E-Branchformer / joint CTC-attention recipe -- thank
122
+ you to the Dolphin and ESPnet teams and to DataoceanAI for releasing their work openly. OpenASR
123
+ only performs format conversion, quantization, runtime verification, and local-inference
124
+ adaptation.
125
+
126
+ ## πŸ”— Links
127
+
128
+ - πŸ¦€ **OpenASR** β€” <https://github.com/QuintinShaw/openasr>
129
+ - 🌐 **Website** β€” <https://openasr.org>
130
+ - πŸ€— **Upstream model** β€” [DataoceanAI/dolphin-small](https://huggingface.co/DataoceanAI/dolphin-small)
dolphin-small-fp16.oasr ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:8e6dac3908f96871c3b887eb13880dbf516b35946aa7ae4e0a1f142ba8a2941e
3
+ size 754136512
dolphin-small-q4_k.oasr ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:1ba5902f5101bc2c444ae8a4c4fd2f7d19fe60aab0d4c6bd6a9d59b9c4f0d4b3
3
+ size 229085152
dolphin-small-q8_0.oasr ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:95554064292e0e63461b07839a254bd232030809bcb1b64b1dc34aee26767eec
3
+ size 411711712