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

publish dolphin-cn-dialect-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,120 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ base_model: DataoceanAI1/dolphi-cn-dialect-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
12
+ ---
13
+
14
+ <div align="center">
15
+
16
+ # Dolphin CN-Dialect Small Β· OpenASR
17
+
18
+ **Chinese multi-dialect speech recognition -- a WeNet E-Branchformer (CTC + attention) tuned for Sichuan and 22 regional dialects**
19
+
20
+ [![License](https://img.shields.io/badge/license-Apache--2.0-2563eb.svg)](https://huggingface.co/DataoceanAI1/dolphi-cn-dialect-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-dolphi--cn--dialect--small-f59e0b.svg)](https://huggingface.co/DataoceanAI1/dolphi-cn-dialect-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
+ - πŸ€„ **22 Chinese dialects** β€” a WeNet E-Branchformer tuned for regional Mandarin, with a standout Sichuan (川话) strength across Wu, Cantonese, Minnan, Shanghainese and more
35
+ - 🎯 **Dialect-first accuracy** β€” a reported ~38% relative gain on dialect recognition and ~16% lower CER versus the base Dolphin, without giving up standard Mandarin
36
+ - 🧩 **Joint CTC + attention** β€” an E-Branchformer encoder with a Transformer decoder and CTC/attention rescoring that OpenASR runs bit-exact against its golden reference
37
+ - 🐬 **Chinese-focused, char-level** β€” a compact `small.cn` checkpoint over a character vocabulary, purpose-built for zh audio including heavy accents and code-mixed speech
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-cn-dialect-small:fp16
46
+
47
+ # 3. Transcribe
48
+ openasr transcribe audio.wav --model dolphin-cn-dialect-small
49
+ ```
50
+
51
+ All builds for this model:
52
+
53
+ ```bash
54
+ openasr pull dolphin-cn-dialect-small:fp16
55
+ openasr pull dolphin-cn-dialect-small:q8
56
+ openasr pull dolphin-cn-dialect-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-cn-dialect-small-fp16.oasr` | 860 MB | 2.37 GB | 0.32Γ— | 0.26Γ— | 0.0% |
64
+ | q8_0 | `dolphin-cn-dialect-small-q8_0.oasr` | 494 MB | 2.88 GB | 0.24Γ— | 0.12Γ— | 0.0% |
65
+ | q4_k | `dolphin-cn-dialect-small-q4_k.oasr` | 298 MB | 2.65 GB | 0.26Γ— | 0.11Γ— | 4.5% |
66
+
67
+ <sub>RTF = real-time factor on a 2.38s in-language Sichuan-dialect (川话) clip (**lower is faster**); RAM peak measured per pack
68
+ in an isolated subprocess. Ξ”CER compares each quantized build's Sichuan-clip transcript to this model's
69
+ fp16 Sichuan-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 CN-Dialect Small
74
+
75
+ Dolphin CN-Dialect Small is a **Chinese multi-dialect** speech-recognition model from
76
+ **DataoceanAI**, built on the **Dolphin / WeNet** recipe as an **E-Branchformer encoder +
77
+ Transformer decoder** trained with a **joint CTC + attention** objective (the `small.cn`
78
+ checkpoint over a character vocabulary). It specializes in regional Mandarin β€” a standout
79
+ **Sichuan (川话)** capability alongside 22 Chinese dialects such as Wu, Cantonese, Minnan and
80
+ Shanghainese β€” while keeping strong standard-Mandarin transcription (the card reports a large
81
+ relative gain on dialect recognition and a meaningful CER reduction over the base Dolphin).
82
+ This OpenASR repo repackages the weights as `.oasr` packs that run natively in the OpenASR
83
+ runtime β€” no Python at inference, all decoding local. OpenASR decodes it with CTC beam search
84
+ plus attention rescoring and verified the transcript bit-exact against a golden reference on a
85
+ Sichuan-dialect clip. It ships in **fp16** (maximum fidelity, recommended), **q8_0**, and **q4_k** builds.
86
+
87
+ ## βš™οΈ How these packs were made
88
+
89
+ Converted from [DataoceanAI1/dolphi-cn-dialect-small](https://huggingface.co/DataoceanAI1/dolphi-cn-dialect-small) with the OpenASR importer:
90
+
91
+ ```bash
92
+ openasr model-pack import dolphin <src> <out>.oasr \
93
+ --package-id dolphin-cn-dialect-small --quantization {fp16,q8-0,q4-k}
94
+ ```
95
+
96
+ The `.oasr` container is GGUF-backed; packs use zero-copy mmap weight binding and graph
97
+ buffer reuse to keep peak memory low.
98
+
99
+ ## βš–οΈ License
100
+
101
+ These packs **inherit the upstream model's license: Apache-2.0**
102
+ ([source](https://huggingface.co/DataoceanAI1/dolphi-cn-dialect-small/blob/main/README.md)). OpenASR packaging retains the upstream copyright and
103
+ NOTICE; the only modifications are format conversion and quantization.
104
+
105
+ ## πŸ™ Acknowledgements
106
+
107
+ This pack is a redistribution of **Dolphin CN-Dialect Small**, created and open-sourced by
108
+ **DataoceanAI** ([DataoceanAI1/dolphi-cn-dialect-small](https://huggingface.co/DataoceanAI1/dolphi-cn-dialect-small)).
109
+ All credit for the original architecture, training, and weights belongs to the authors; the
110
+ license is inherited from and identical to the upstream model (Apache-2.0). The model builds on
111
+ the **Dolphin** multilingual ASR project and the **WeNet** E-Branchformer / joint CTC-attention
112
+ recipe β€” thank you to the Dolphin and WeNet teams and to DataoceanAI for releasing their work
113
+ openly. OpenASR only performs format conversion, quantization, runtime verification, and
114
+ local-inference adaptation.
115
+
116
+ ## πŸ”— Links
117
+
118
+ - πŸ¦€ **OpenASR** β€” <https://github.com/QuintinShaw/openasr>
119
+ - 🌐 **Website** β€” <https://openasr.org>
120
+ - πŸ€— **Upstream model** β€” [DataoceanAI1/dolphi-cn-dialect-small](https://huggingface.co/DataoceanAI1/dolphi-cn-dialect-small)
dolphin-cn-dialect-small-fp16.oasr ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:008a812b0ded5420d6e9d864170ae63150155858a7f5a25c14db3b770894df0c
3
+ size 859973344
dolphin-cn-dialect-small-q4_k.oasr ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:a74581e11f19454c6d24cb4949be269e59f0bbdce9969cc8b60aa3a54c83c865
3
+ size 298130144
dolphin-cn-dialect-small-q8_0.oasr ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:55083d6b6167c375f3a0b6d685f11158fab4e0357f0dd22412295506b8846aa6
3
+ size 493553888