-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcatalog.py
More file actions
1990 lines (1923 loc) · 67.4 KB
/
Copy pathcatalog.py
File metadata and controls
1990 lines (1923 loc) · 67.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from __future__ import annotations
import json
from dataclasses import dataclass, replace
from pathlib import Path
from types import MappingProxyType
from typing import Any
from app.system import SystemInfo
# Integrity pins live beside the catalog rather than inline in the model table
# because they are machine-generated (scripts/harvest-model-pins.py) while the
# table is hand-written. Keeping them apart means regenerating pins produces a
# diff of nothing but digests, which is what makes them reviewable.
PINS_PATH = Path(__file__).parent / "model_pins.json"
ENGINE_WHISPER_CPP = "whisper.cpp"
ENGINE_WHISPERKIT = "whisperkit"
ENGINE_FASTER_WHISPER = "faster-whisper"
ENGINE_MOONSHINE = "moonshine"
ENGINE_SHERPA_ONNX = "sherpa-onnx"
ENGINE_MLX_AUDIO = "mlx-audio"
WHISPER_CPP_REPO = "ggerganov/whisper.cpp"
WHISPERKIT_REPO = "argmaxinc/whisperkit-coreml"
MB = 1_000_000
GB = 1_000_000_000
HIGH_MEMORY_RAM_GB = 12
VERY_HIGH_MEMORY_RAM_GB = 16
DEFAULT_RECOMMENDATION_RAM_GB = 8.0
ENGLISH_LANGUAGE_CODE = "en"
ARABIC_LANGUAGE_CODE = "ar"
BULGARIAN_LANGUAGE_CODE = "bg"
CZECH_LANGUAGE_CODE = "cs"
DANISH_LANGUAGE_CODE = "da"
GERMAN_LANGUAGE_CODE = "de"
GREEK_LANGUAGE_CODE = "el"
SPANISH_LANGUAGE_CODE = "es"
ESTONIAN_LANGUAGE_CODE = "et"
FINNISH_LANGUAGE_CODE = "fi"
FRENCH_LANGUAGE_CODE = "fr"
CROATIAN_LANGUAGE_CODE = "hr"
HUNGARIAN_LANGUAGE_CODE = "hu"
ITALIAN_LANGUAGE_CODE = "it"
JAPANESE_LANGUAGE_CODE = "ja"
KOREAN_LANGUAGE_CODE = "ko"
LITHUANIAN_LANGUAGE_CODE = "lt"
LATVIAN_LANGUAGE_CODE = "lv"
MALTESE_LANGUAGE_CODE = "mt"
DUTCH_LANGUAGE_CODE = "nl"
POLISH_LANGUAGE_CODE = "pl"
PORTUGUESE_LANGUAGE_CODE = "pt"
ROMANIAN_LANGUAGE_CODE = "ro"
RUSSIAN_LANGUAGE_CODE = "ru"
SLOVAK_LANGUAGE_CODE = "sk"
SLOVENIAN_LANGUAGE_CODE = "sl"
SWEDISH_LANGUAGE_CODE = "sv"
UKRAINIAN_LANGUAGE_CODE = "uk"
VIETNAMESE_LANGUAGE_CODE = "vi"
CHINESE_LANGUAGE_CODE = "zh"
HINDI_LANGUAGE_CODE = "hi"
HINGLISH_ROMAN_LANGUAGE_CODE = "hinglish_roman"
TAGALOG_LANGUAGE_CODE = "tl"
MIT_LICENSE = "MIT"
ENGLISH_ONLY = "English only"
SHERPA_MODEL_FILE = "model.int8.onnx"
TOKENS_FILE = "tokens.txt"
ENCODER_INT8_FILE = "encoder.int8.onnx"
DECODER_INT8_FILE = "decoder.int8.onnx"
CC_BY_LICENSE = "CC BY 4.0"
APACHE_LICENSE = "Apache 2.0"
MULTILINGUAL = "Multilingual"
BASE_MODEL_VARIANT = "Base"
MOONSHINE_BASE_SIZE_MB = "141"
FAST_BATCH_QUALITY = "Fast · batch"
TINY_MODEL_SIZE_MB = "75"
FASTEST_QUALITY = "Fastest"
BASE_MODEL_SIZE_MB = "145"
FAST_QUALITY = "Fast"
BALANCED_QUALITY = "Balanced"
MOST_ACCURATE_QUALITY = "Most accurate"
MOONSHINE_REVISION_V015 = "moonshine-voice-0.1.5"
MOONSHINE_015_REVISION = MOONSHINE_REVISION_V015 # noqa: WPS114
MOONSHINE_STREAMING_SMALL_VARIANT = "Small Streaming"
MOONSHINE_STREAMING_TINY_VARIANT = "Tiny Streaming"
MOONSHINE_STREAMING_BALANCED_QUALITY = "Balanced · cached streaming"
MOONSHINE_STREAMING_FASTEST_QUALITY = "Fastest · cached streaming"
MOONSHINE_RETIREMENT_REASON = (
"Moonshine deprecated this Community batch model after publishing an MIT streaming replacement."
)
MOONSHINE_RETIREMENT_PLURAL_REASON = (
"Moonshine deprecated this Community batch model after publishing MIT streaming replacements."
)
NEMOTRON_SIZE_BYTES = 682_215_471
BENGALI_ZIPFORMER_SIZE_BYTES = 94_119_939
MOONSHINE_EN_MEDIUM_STREAMING_SIZE_BYTES = 269_141_623
MOONSHINE_EN_SMALL_STREAMING_SIZE_BYTES = 142_300_974
MOONSHINE_EN_TINY_STREAMING_SIZE_BYTES = 45_233_659
MOONSHINE_EN_BASE_SIZE_BYTES = 141_001_190
MOONSHINE_EN_TINY_SIZE_BYTES = 43_943_830
MOONSHINE_AR_TINY_STREAMING_SIZE_BYTES = 32_349_411
MOONSHINE_DE_SMALL_STREAMING_SIZE_BYTES = 121_800_823
MOONSHINE_DE_TINY_STREAMING_SIZE_BYTES = 32_317_004
MOONSHINE_ES_SMALL_STREAMING_SIZE_BYTES = 121_800_392
MOONSHINE_ES_TINY_STREAMING_SIZE_BYTES = 32_316_573
MOONSHINE_JA_SMALL_STREAMING_SIZE_BYTES = 121_803_780
MOONSHINE_JA_TINY_STREAMING_SIZE_BYTES = 32_319_961
MOONSHINE_ZH_TINY_STREAMING_SIZE_BYTES = 32_290_152
MOONSHINE_TL_TINY_STREAMING_SIZE_BYTES = 32_309_481
MOONSHINE_VI_TINY_STREAMING_SIZE_BYTES = 32_309_008
MOONSHINE_KO_SIZE_BYTES = 71_815_486
MOONSHINE_UK_SIZE_BYTES = 141_001_214
DISTIL_LARGE_V3_SIZE_BYTES = 1_515_408_824
FASTER_WHISPER_LARGE_V3_TURBO_SIZE_BYTES = 1_621_669_956
FASTER_WHISPER_LARGE_V3_SIZE_BYTES = 3_090_839_273
FASTER_WHISPER_MEDIUM_SIZE_BYTES = 1_530_575_217
FASTER_WHISPER_MEDIUM_EN_SIZE_BYTES = 1_530_460_562
ACCURATE_QUALITY = "Accurate"
# Turbo is not the most accurate Whisper — the Open ASR Leaderboard puts it at
# 6.36 average WER against full Large v3's 5.78 — so it must not claim to be in
# a picker that also offers Large v3 and the Q5 build of those same weights.
TURBO_QUALITY = "Large-model accuracy · fast decoder"
WHISPERKIT_COMPRESSED_LARGE_ID = "whisperkit:openai_whisper-large-v3-v20240930_626MB"
DISTIL_LARGE_V35_SIZE_BYTES = 1_516_487_390
WHISPER_TURBO_REPLACEMENT_ID = "whisper.cpp:ggml-large-v3-turbo.bin"
WHISPER_TURBO_RETIREMENT_REASON = (
"Whisper Large v3 Turbo replaces this tier: the same encoder with four decoder layers "
"instead of 32, so it is smaller and several times faster. It is not more accurate — the "
"Open ASR Leaderboard puts Turbo about 0.6 WER points behind full Large v3 on English "
"and up to 2 behind on German — but Medium trails both, so nothing here is given up."
)
HINGLISH_MODEL_SIZE_BYTES = 574_041_195
# Qwen3-ASR's upstream card lists 30 languages plus Chinese dialects. The
# dialects are represented by the model's Mandarin/`yue` capability rather
# than exposed as separate gateway language selectors.
_QWEN3_LANGUAGE_CODES: tuple[str, ...] = (
ENGLISH_LANGUAGE_CODE,
CHINESE_LANGUAGE_CODE,
"yue",
JAPANESE_LANGUAGE_CODE,
KOREAN_LANGUAGE_CODE,
SPANISH_LANGUAGE_CODE,
FRENCH_LANGUAGE_CODE,
GERMAN_LANGUAGE_CODE,
RUSSIAN_LANGUAGE_CODE,
ARABIC_LANGUAGE_CODE,
ITALIAN_LANGUAGE_CODE,
PORTUGUESE_LANGUAGE_CODE,
"id",
"th",
VIETNAMESE_LANGUAGE_CODE,
"tr",
HINDI_LANGUAGE_CODE,
"ms",
"nl",
"sv",
"da",
"fi",
"pl",
"cs",
"fil",
"fa",
"el",
"hu",
"mk",
"ro",
)
@dataclass(frozen=True, slots=True)
class CatalogModel:
"""A downloadable speech-to-text model."""
id: str
engine: str
key: str
label: str
size_bytes: int
languages: str
quality: str
minimum_ram_gb: float
download_url: str | None = None
huggingface_repo: str | None = None
huggingface_folder: str | None = None
family: str = "Whisper"
description: str = "Local speech recognition model."
source: str = ENGINE_WHISPER_CPP
marker_file: str | None = None
language_code: str | None = None
model_arch: int | None = None
supports_streaming: bool = False
license_name: str = "See model source"
commercial_use: bool = True
archive_url: str | None = None
archive_root: str | None = None
required_files: tuple[str, ...] = ()
revision: str | None = None
sha256: str | None = None
file_digests: tuple[tuple[str, str], ...] = ()
model_type: str | None = None
language_codes: tuple[str, ...] = ()
# Some fine-tunes expose an application-level output contract whose wire
# value is not a token understood by the decoder (for example, Roman
# Hinglish is requested as `hinglish_roman` but Whisper expects `hi`).
decoder_language_code: str | None = None
apple_silicon_only: bool = False
detects_language_automatically: bool = False
retired: bool = False
replacement_id: str | None = None
retirement_reason: str | None = None
PinsMap = dict[str, dict[str, Any]]
class _PinManager:
@classmethod
def load_pins(cls, path: Path = PINS_PATH) -> PinsMap:
try:
payload = json.loads(path.read_text(encoding="utf-8"))
except (OSError, json.JSONDecodeError):
return {}
models = payload.get("models") if isinstance(payload, dict) else None
return models if isinstance(models, dict) else {}
@classmethod
def pin_download_url(cls, url: str | None, revision: str | None) -> str | None:
if not url or not revision:
return url
marker = "/resolve/main/"
if "huggingface.co/" not in url or marker not in url:
return url
return url.replace(marker, f"/resolve/{revision}/", 1)
@classmethod
def apply_pins(
cls, catalog: tuple[CatalogModel, ...], pins: PinsMap | None = None
) -> tuple[CatalogModel, ...]:
records = cls.load_pins() if pins is None else pins
if not records:
return catalog
pinned_models = [cls._pin_model(model, records.get(model.id)) for model in catalog]
return tuple(pinned_models)
@classmethod
def _parse_file_digests(
cls, digests: Any, default: tuple[tuple[str, str], ...]
) -> tuple[tuple[str, str], ...]:
if not isinstance(digests, dict) or not digests:
return default
pairs = []
for key, digest in digests.items():
pairs.append((str(key), str(digest)))
return tuple(sorted(pairs))
@classmethod
def _pin_model(cls, model: CatalogModel, record: Any) -> CatalogModel:
if not isinstance(record, dict):
return model
rev = record.get("revision") or model.revision
digests = cls._parse_file_digests(record.get("file_digests"), model.file_digests)
return replace(
model,
revision=rev,
sha256=record.get("sha256") or model.sha256,
download_url=cls.pin_download_url(model.download_url, rev),
file_digests=digests,
)
class _WhisperModelBuilders:
@classmethod
def retirement(cls, kwargs: dict[str, Any]) -> dict[str, Any]:
"""The retirement triple, so each Whisper builder spells it once."""
return {
"retired": bool(kwargs.get("retired", False)),
"replacement_id": kwargs.get("replacement_id"),
"retirement_reason": kwargs.get("retirement_reason"),
}
@classmethod
def whisper_language_codes(cls, languages: str) -> tuple[str, ...]:
return (ENGLISH_LANGUAGE_CODE,) if languages == ENGLISH_ONLY else WHISPER_LANGUAGES
@classmethod
def whisper_cpp(
cls,
key: str,
label: str,
*args: Any,
**kwargs: Any,
) -> CatalogModel:
return CatalogModel(
id=f"{ENGINE_WHISPER_CPP}:{key}",
engine=ENGINE_WHISPER_CPP,
key=key,
label=label,
size_bytes=int(args[0]),
languages=cls._languages(args),
quality=str(args[2]),
minimum_ram_gb=float(args[3]),
download_url=kwargs.get("download_url")
or (f"https://huggingface.co/{WHISPER_CPP_REPO}/resolve/main/{key}"),
family=str(kwargs.get("family", "Whisper")),
description=str(
kwargs.get(
"description",
"OpenAI Whisper converted for the standalone whisper.cpp engine.",
)
),
source=str(kwargs.get("source", ENGINE_WHISPER_CPP)),
language_codes=tuple(
kwargs.get("language_codes") or cls.whisper_language_codes(cls._languages(args))
),
decoder_language_code=kwargs.get("decoder_language_code"),
license_name=str(kwargs.get("license_name", "See model source")), # noqa: WPS226
**cls.retirement(kwargs),
)
@classmethod
def whisperkit(
cls,
folder: str,
label: str,
*args: Any,
**kwargs: Any,
) -> CatalogModel:
return CatalogModel(
id=f"{ENGINE_WHISPERKIT}:{folder}",
engine=ENGINE_WHISPERKIT,
key=folder,
label=label,
size_bytes=int(args[0]),
languages=cls._languages(args),
quality=str(args[2]),
minimum_ram_gb=float(args[3]),
huggingface_repo=WHISPERKIT_REPO,
huggingface_folder=folder,
family="Whisper",
description="Core ML Whisper model optimized for Apple silicon.",
source="WhisperKit",
language_codes=cls.whisper_language_codes(cls._languages(args)),
**cls.retirement(kwargs),
)
@classmethod
def faster_whisper(
cls,
key: str,
label: str,
*args: Any,
**kwargs: Any,
) -> CatalogModel:
return CatalogModel(
id=f"{ENGINE_FASTER_WHISPER}:{key}",
engine=ENGINE_FASTER_WHISPER,
key=key,
label=label,
size_bytes=int(args[0]),
languages=cls._languages(args),
quality=str(args[2]),
minimum_ram_gb=float(args[3]),
huggingface_repo=str(kwargs.get("repository") or cls._faster_whisper_repo(key)),
huggingface_folder="",
family="Whisper / CTranslate2",
description=(
"Persistent CTranslate2 model with CPU INT8 inference; "
"works well on desktop and server CPUs."
),
source="faster-whisper",
marker_file="model.bin",
language_codes=cls.whisper_language_codes(cls._languages(args)),
license_name=str(kwargs.get("license_name", "See model source")),
commercial_use=bool(kwargs.get("commercial_use", True)),
**cls.retirement(kwargs),
)
@classmethod
def mlx_audio(
cls,
key: str,
label: str,
*args: Any,
**kwargs: Any,
) -> CatalogModel:
return CatalogModel(
id=f"{ENGINE_MLX_AUDIO}:{key}",
engine=ENGINE_MLX_AUDIO,
key=key,
label=label,
size_bytes=int(args[0]),
languages=cls._languages(args),
quality=str(args[2]),
minimum_ram_gb=float(args[3]),
huggingface_repo=str(kwargs["repository"]),
huggingface_folder="",
family=str(kwargs["family"]),
description=str(kwargs["description"]),
source="MLX Audio",
marker_file="model.safetensors",
language_codes=tuple(kwargs.get("language_codes", ())),
apple_silicon_only=True,
license_name=str(kwargs["license_name"]),
)
@classmethod
def _languages(cls, args: tuple[Any, ...]) -> str:
return str(args[1])
@classmethod
def _faster_whisper_repo(cls, key: str) -> str:
"""Systran publishes the CTranslate2 conversions this engine loads.
Entries whose conversion lives elsewhere (Whisper Large v3 Turbo has no
Systran build) pass `repository=` instead of matching this convention.
"""
if key.startswith("distil-"):
return f"Systran/faster-distil-whisper-{key.removeprefix('distil-')}"
return f"Systran/faster-whisper-{key}"
class _SpecializedModelBuilders:
@classmethod
def megabytes(cls, size_text: str) -> int:
return int(size_text) * MB
@classmethod
def gigabytes(cls, size_text: str) -> int:
return int(size_text) * GB
@classmethod
def moonshine(
cls,
key: str,
language: str,
*args: Any,
**kwargs: Any,
) -> CatalogModel:
return CatalogModel(
id=f"{ENGINE_MOONSHINE}:{key}",
engine=ENGINE_MOONSHINE,
key=key,
label=str(args[2]),
size_bytes=int(args[3]),
languages=f"{_MOONSHINE_LANGUAGE_NAMES[language]} only",
quality=str(args[4]),
minimum_ram_gb=float(kwargs.get("minimum_ram_gb", 2)),
family="Moonshine",
description=cls._moonshine_description(
str(args[0]), bool(kwargs.get("supports_streaming", False))
),
source="Moonshine Voice",
marker_file=".vocagateway-model.json",
language_code=language,
language_codes=(language,),
model_arch=int(args[1]),
supports_streaming=bool(kwargs.get("supports_streaming", False)),
license_name=str(
kwargs.get(
"license_name",
MIT_LICENSE
if language == ENGLISH_LANGUAGE_CODE
else "Moonshine Community License",
)
),
commercial_use=bool(kwargs.get("commercial_use", language == ENGLISH_LANGUAGE_CODE)),
required_files=tuple(kwargs.get("required_files", ())),
revision=kwargs.get("revision"),
retired=bool(kwargs.get("retired", False)),
replacement_id=kwargs.get("replacement_id"),
retirement_reason=kwargs.get("retirement_reason"),
)
@classmethod
def sherpa_onnx(
cls,
key: str,
label: str,
*args: Any,
**kwargs: Any,
) -> CatalogModel:
cls._validate_sherpa_source(
key,
kwargs.get("archive_url"),
kwargs.get("archive_root"),
kwargs.get("huggingface_repo"),
)
return CatalogModel(
id=f"{ENGINE_SHERPA_ONNX}:{key}",
engine=ENGINE_SHERPA_ONNX,
key=key,
label=label,
size_bytes=int(args[0]),
languages=cls._languages(args),
quality=str(args[2]),
minimum_ram_gb=float(args[3]),
archive_url=kwargs.get("archive_url"),
archive_root=kwargs.get("archive_root"),
huggingface_repo=kwargs.get("huggingface_repo"),
required_files=tuple(kwargs["required_files"]),
family=str(kwargs["family"]),
description=str(kwargs["description"]),
source="sherpa-onnx",
marker_file=".vocagateway-model.json",
model_type=str(kwargs["model_type"]),
language_codes=tuple(kwargs["language_codes"]),
license_name=str(kwargs["license_name"]),
supports_streaming=bool(kwargs.get("supports_streaming", False)),
detects_language_automatically=bool(
kwargs.get("detects_language_automatically", False)
),
)
@classmethod
def _languages(cls, args: tuple[Any, ...]) -> str:
return str(args[1])
@classmethod
def _moonshine_description(cls, arch: str, streaming: bool) -> str:
inf = (
" Uses cached incremental inference while you speak."
if streaming
else " Uses the fast batch pipeline after recording."
)
return f"{arch} model optimized for private local dictation.{inf}"
@classmethod
def _validate_sherpa_source(
cls, key: str, archive_url: Any, archive_root: Any, huggingface_repo: Any
) -> None:
if archive_url is not None:
if archive_root is None:
raise ValueError(f"{key}: archive_url requires archive_root.")
elif huggingface_repo is None:
raise ValueError(f"{key}: provide either archive_url/archive_root or huggingface_repo.")
_whisper_cpp = _WhisperModelBuilders.whisper_cpp
_whisperkit = _WhisperModelBuilders.whisperkit
_faster_whisper = _WhisperModelBuilders.faster_whisper
_mlx_audio = _WhisperModelBuilders.mlx_audio
_whisper_language_codes = _WhisperModelBuilders.whisper_language_codes
_megabytes = _SpecializedModelBuilders.megabytes
_gigabytes = _SpecializedModelBuilders.gigabytes
_moonshine = _SpecializedModelBuilders.moonshine
_sherpa_onnx = _SpecializedModelBuilders.sherpa_onnx
WHISPER_LANGUAGES: tuple[str, ...] = tuple(
str.split(
"af am ar as az ba be bg bn bo br bs ca cs cy da de el en es et eu fa fi fo fr gl gu ha "
"haw he hi hr ht hu hy id is it ja jw ka kk km kn ko la lb ln lo lt lv mg mi mk ml mn mr "
"ms mt my ne nl nn no oc pa pl ps pt ro ru sa sd si sk sl sn so sq sr su sv sw ta te tg th "
"tk tl tr tt uk ur uz vi yi yo yue zh"
)
)
# Display names for every code any catalog entry declares, so a model card can list
# "Hindi, Bengali, Tamil" instead of "hi, bn, ta". A missing code falls back to the
# code itself rather than hiding the language.
LANGUAGE_NAMES: MappingProxyType[str, str] = MappingProxyType(
{
"af": "Afrikaans",
"am": "Amharic",
ARABIC_LANGUAGE_CODE: "Arabic",
"as": "Assamese",
"az": "Azerbaijani",
"ba": "Bashkir",
"be": "Belarusian",
BULGARIAN_LANGUAGE_CODE: "Bulgarian",
"bn": "Bengali",
"bo": "Tibetan",
"br": "Breton",
"bs": "Bosnian",
"ca": "Catalan",
CZECH_LANGUAGE_CODE: "Czech",
"ct": "Yue Chinese",
"cy": "Welsh",
DANISH_LANGUAGE_CODE: "Danish",
GERMAN_LANGUAGE_CODE: "German",
GREEK_LANGUAGE_CODE: "Greek",
ENGLISH_LANGUAGE_CODE: "English",
SPANISH_LANGUAGE_CODE: "Spanish",
ESTONIAN_LANGUAGE_CODE: "Estonian",
"eu": "Basque",
"fa": "Persian",
FINNISH_LANGUAGE_CODE: "Finnish",
"fil": "Filipino",
"fo": "Faroese",
FRENCH_LANGUAGE_CODE: "French",
"gl": "Galician",
"gu": "Gujarati",
"ha": "Hausa",
"haw": "Hawaiian",
"he": "Hebrew",
HINDI_LANGUAGE_CODE: "Hindi",
HINGLISH_ROMAN_LANGUAGE_CODE: "Hinglish — Roman",
CROATIAN_LANGUAGE_CODE: "Croatian",
"ht": "Haitian Creole",
HUNGARIAN_LANGUAGE_CODE: "Hungarian",
"hy": "Armenian",
"id": "Indonesian",
"is": "Icelandic",
ITALIAN_LANGUAGE_CODE: "Italian",
JAPANESE_LANGUAGE_CODE: "Japanese",
"jv": "Javanese",
"jw": "Javanese",
"ka": "Georgian",
"kab": "Kabyle",
"kk": "Kazakh",
"km": "Khmer",
"kn": "Kannada",
KOREAN_LANGUAGE_CODE: "Korean",
"ks": "Kashmiri",
"ky": "Kyrgyz",
"la": "Latin",
"lb": "Luxembourgish",
"ln": "Lingala",
"lo": "Lao",
LITHUANIAN_LANGUAGE_CODE: "Lithuanian",
LATVIAN_LANGUAGE_CODE: "Latvian",
"mg": "Malagasy",
"mi": "Maori",
"mk": "Macedonian",
"ml": "Malayalam",
"mn": "Mongolian",
"mr": "Marathi",
"ms": "Malay",
MALTESE_LANGUAGE_CODE: "Maltese",
"my": "Burmese",
"ne": "Nepali",
DUTCH_LANGUAGE_CODE: "Dutch",
"nn": "Norwegian Nynorsk",
"no": "Norwegian",
"oc": "Occitan",
"or": "Odia",
"pa": "Punjabi",
POLISH_LANGUAGE_CODE: "Polish",
"ps": "Pashto",
PORTUGUESE_LANGUAGE_CODE: "Portuguese",
ROMANIAN_LANGUAGE_CODE: "Romanian",
RUSSIAN_LANGUAGE_CODE: "Russian",
"sa": "Sanskrit",
"sd": "Sindhi",
"si": "Sinhala",
SLOVAK_LANGUAGE_CODE: "Slovak",
SLOVENIAN_LANGUAGE_CODE: "Slovenian",
"sn": "Shona",
"so": "Somali",
"sq": "Albanian",
"sr": "Serbian",
"su": "Sundanese",
SWEDISH_LANGUAGE_CODE: "Swedish",
"sw": "Swahili",
"ta": "Tamil",
"te": "Telugu",
"tg": "Tajik",
"th": "Thai",
"tk": "Turkmen",
TAGALOG_LANGUAGE_CODE: "Tagalog",
"tr": "Turkish",
"tt": "Tatar",
"ug": "Uyghur",
UKRAINIAN_LANGUAGE_CODE: "Ukrainian",
"ur": "Urdu",
"uz": "Uzbek",
VIETNAMESE_LANGUAGE_CODE: "Vietnamese",
"yi": "Yiddish",
"yo": "Yoruba",
"yue": "Cantonese",
CHINESE_LANGUAGE_CODE: "Mandarin Chinese",
}
)
_ENGINE_SOURCE_URLS = MappingProxyType(
{
ENGINE_WHISPER_CPP: "https://github.com/ggml-org/whisper.cpp",
ENGINE_WHISPERKIT: "https://github.com/argmaxinc/WhisperKit",
ENGINE_FASTER_WHISPER: "https://github.com/SYSTRAN/faster-whisper",
ENGINE_MOONSHINE: "https://github.com/moonshine-ai/moonshine",
ENGINE_SHERPA_ONNX: "https://github.com/k2-fsa/sherpa-onnx",
ENGINE_MLX_AUDIO: "https://github.com/Blaizzy/mlx-audio",
}
)
_SOURCE_LABEL_URLS = MappingProxyType(
{
ENGINE_WHISPER_CPP: "https://github.com/ggml-org/whisper.cpp",
"faster-whisper": "https://github.com/SYSTRAN/faster-whisper",
"WhisperKit": "https://github.com/argmaxinc/WhisperKit",
"Moonshine Voice": "https://github.com/moonshine-ai/moonshine",
"sherpa-onnx": "https://github.com/k2-fsa/sherpa-onnx",
"MLX Audio": "https://github.com/Blaizzy/mlx-audio",
"Handy-compatible": "https://handy.computer",
"Breeze ASR": "https://huggingface.co/MediaTek-Research/Breeze-ASR-25",
}
)
class _CatalogUrls:
@classmethod
def source_url(cls, model: CatalogModel) -> str | None:
hf_url = cls._huggingface_url(model)
if hf_url:
return hf_url
release = cls._github_release_page(model.archive_url)
if release:
return release
named_source = _SOURCE_LABEL_URLS.get(model.source) or _ENGINE_SOURCE_URLS.get(model.engine)
if named_source:
return named_source
return model.download_url or model.archive_url
@classmethod
def language_names(cls, codes: tuple[str, ...]) -> list[str]:
return [LANGUAGE_NAMES.get(code, code) for code in codes]
@classmethod
def _huggingface_url(cls, model: CatalogModel) -> str | None:
if model.huggingface_repo:
return f"https://huggingface.co/{model.huggingface_repo}"
if model.download_url and "huggingface.co/" in model.download_url:
head, has_resolve, _ = model.download_url.partition("/resolve/")
return head if has_resolve else model.download_url
return None
@classmethod
def _github_release_page(cls, archive_url: str | None) -> str | None:
if not archive_url or "/releases/download/" not in archive_url:
return None
head, _, rest = archive_url.partition("/releases/download/")
if not head.startswith("https://github.com/") or not rest:
return None
tag = rest.split("/", maxsplit=1)[0]
return f"{head}/releases/tag/{tag}" if tag else None
load_pins = _PinManager.load_pins
pin_download_url = _PinManager.pin_download_url
apply_pins = _PinManager.apply_pins
catalog_source_url = _CatalogUrls.source_url
language_names = _CatalogUrls.language_names
# Dolphin's own language codes, from DataoceanAI/Dolphin `languages.md`. Two are not
# ISO 639-1: `ct` is Yue Chinese (`yue` elsewhere in this catalog) and `fil` is Filipino.
_DOLPHIN_LANGUAGE_CODES: tuple[str, ...] = (
CHINESE_LANGUAGE_CODE,
JAPANESE_LANGUAGE_CODE,
"th",
RUSSIAN_LANGUAGE_CODE,
KOREAN_LANGUAGE_CODE,
"id",
VIETNAMESE_LANGUAGE_CODE,
"ct",
HINDI_LANGUAGE_CODE,
"ur",
"ms",
"uz",
ARABIC_LANGUAGE_CODE,
"fa",
"bn",
"ta",
"te",
"ug",
"gu",
"my",
TAGALOG_LANGUAGE_CODE,
"kk",
"or",
"ne",
"mn",
"km",
"jv",
"lo",
"si",
"fil",
"ps",
"pa",
"kab",
"ba",
"ks",
"tg",
"su",
"mr",
"ky",
"az",
)
_MOONSHINE_LANGUAGE_NAMES = MappingProxyType(
{
ARABIC_LANGUAGE_CODE: "Arabic",
GERMAN_LANGUAGE_CODE: "German",
ENGLISH_LANGUAGE_CODE: "English",
SPANISH_LANGUAGE_CODE: "Spanish",
JAPANESE_LANGUAGE_CODE: "Japanese",
KOREAN_LANGUAGE_CODE: "Korean",
TAGALOG_LANGUAGE_CODE: "Tagalog",
UKRAINIAN_LANGUAGE_CODE: "Ukrainian",
VIETNAMESE_LANGUAGE_CODE: "Vietnamese",
CHINESE_LANGUAGE_CODE: "Mandarin Chinese",
}
)
_MOONSHINE_STREAMING_FILES: tuple[str, ...] = (
"adapter.ort",
"cross_kv.ort",
"decoder_kv.ort",
"encoder.ort",
"frontend.model.ort",
"frontend.weights.ort",
"streaming_config.json",
"tokenizer.bin",
)
_MOONSHINE_BATCH_FILES: tuple[str, ...] = (
"decoder_model_merged.ort",
"encoder_model.ort",
"tokenizer.bin",
)
_BASE_CATALOG: tuple[CatalogModel, ...] = (
_sherpa_onnx(
"sensevoice-small-int8",
"SenseVoice Small INT8",
_megabytes("240"),
"Mandarin, Cantonese, English, Japanese, Korean",
"Fastest multilingual · punctuation",
2,
archive_url=(
"https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/"
"sherpa-onnx-sense-voice-zh-en-ja-ko-yue-int8-2024-07-17.tar.bz2"
),
archive_root="sherpa-onnx-sense-voice-zh-en-ja-ko-yue-int8-2024-07-17",
required_files=(SHERPA_MODEL_FILE, TOKENS_FILE),
model_type="sense_voice",
language_codes=(
CHINESE_LANGUAGE_CODE,
"yue",
ENGLISH_LANGUAGE_CODE,
JAPANESE_LANGUAGE_CODE,
KOREAN_LANGUAGE_CODE,
),
family="SenseVoice",
description=(
"Compact non-autoregressive INT8 model for fast CPU dictation on Linux and macOS."
),
license_name="FunASR Model License",
# Loaded with language="auto"; this build exposes no per-stream override.
detects_language_automatically=True,
),
_sherpa_onnx(
"parakeet-tdt-0.6b-v3-int8",
"Parakeet TDT 0.6B v3 INT8",
_megabytes("672"),
"25 European languages",
"Accurate multilingual · punctuation",
4,
archive_url=(
"https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/"
"sherpa-onnx-nemo-parakeet-tdt-0.6b-v3-int8.tar.bz2"
),
archive_root="sherpa-onnx-nemo-parakeet-tdt-0.6b-v3-int8",
required_files=(
ENCODER_INT8_FILE,
DECODER_INT8_FILE,
"joiner.int8.onnx",
TOKENS_FILE,
),
model_type="nemo_transducer",
language_codes=(
BULGARIAN_LANGUAGE_CODE,
CROATIAN_LANGUAGE_CODE,
CZECH_LANGUAGE_CODE,
DANISH_LANGUAGE_CODE,
DUTCH_LANGUAGE_CODE,
ENGLISH_LANGUAGE_CODE,
ESTONIAN_LANGUAGE_CODE,
FINNISH_LANGUAGE_CODE,
FRENCH_LANGUAGE_CODE,
GERMAN_LANGUAGE_CODE,
GREEK_LANGUAGE_CODE,
HUNGARIAN_LANGUAGE_CODE,
ITALIAN_LANGUAGE_CODE,
LATVIAN_LANGUAGE_CODE,
LITHUANIAN_LANGUAGE_CODE,
MALTESE_LANGUAGE_CODE,
POLISH_LANGUAGE_CODE,
PORTUGUESE_LANGUAGE_CODE,
ROMANIAN_LANGUAGE_CODE,
SLOVAK_LANGUAGE_CODE,
SLOVENIAN_LANGUAGE_CODE,
SPANISH_LANGUAGE_CODE,
SWEDISH_LANGUAGE_CODE,
RUSSIAN_LANGUAGE_CODE,
UKRAINIAN_LANGUAGE_CODE,
),
family="Parakeet TDT",
description=(
"NVIDIA's multilingual Parakeet converted to INT8 ONNX for fast macOS and Linux CPU "
"inference."
),
license_name=CC_BY_LICENSE,
),
_sherpa_onnx(
"parakeet-tdt-0.6b-v2-int8",
"Parakeet TDT 0.6B v2 INT8",
_megabytes("661"),
ENGLISH_ONLY,
"Most accurate English · punctuation",
4,
huggingface_repo="csukuangfj/sherpa-onnx-nemo-parakeet-tdt-0.6b-v2-int8",
required_files=(
ENCODER_INT8_FILE,
DECODER_INT8_FILE,
"joiner.int8.onnx",
TOKENS_FILE,
),
model_type="nemo_transducer",
language_codes=(ENGLISH_LANGUAGE_CODE,),
family="Parakeet TDT",
description=(
"The English-only Parakeet. v3 trades some English accuracy for 25-language coverage, "
"so this earlier release still transcribes English more accurately at the same speed."
),
license_name=CC_BY_LICENSE,
),
_sherpa_onnx(
"gigaam-v3-ctc-russian-int8",
"GigaAM v3 CTC Russian INT8",
_megabytes("225"),
"Russian only",
"Fastest Russian ASR",
2,
huggingface_repo="csukuangfj/sherpa-onnx-nemo-ctc-giga-am-v3-russian-2025-12-16",
required_files=(SHERPA_MODEL_FILE, TOKENS_FILE),
model_type="nemo_ctc",
language_codes=(RUSSIAN_LANGUAGE_CODE,),
family="GigaAM",
description=(
"Sber's GigaAM CTC converted to INT8 ONNX for fast Russian-only CPU transcription."
),
license_name=MIT_LICENSE,
),
_sherpa_onnx(
"gigaam-v3-rnnt-russian-int8",
"GigaAM v3 RNNT Russian",
_megabytes("230"),
"Russian only",
"Most accurate Russian ASR",
2,
huggingface_repo="csukuangfj/sherpa-onnx-nemo-transducer-giga-am-v3-russian-2025-12-16",
required_files=(ENCODER_INT8_FILE, "decoder.onnx", "joiner.onnx", TOKENS_FILE),
model_type="nemo_transducer",
language_codes=(RUSSIAN_LANGUAGE_CODE,),
family="GigaAM",
description=(
"Sber's GigaAM RNNT converted to ONNX for the most accurate Russian-only CPU "
"transcription; only its encoder is INT8-quantized, so it is larger and slower "
"than the CTC variant."
),
license_name=MIT_LICENSE,
),
_sherpa_onnx(
"canary-180m-flash-en-int8",
"Canary 180M Flash English INT8",
_megabytes("210"),
"English only in this build",
"Compact multilingual model, English transcription",
2,
huggingface_repo="csukuangfj/sherpa-onnx-nemo-canary-180m-flash-en-es-de-fr-int8",
required_files=(ENCODER_INT8_FILE, DECODER_INT8_FILE, TOKENS_FILE),
model_type="nemo_canary",
language_codes=(ENGLISH_LANGUAGE_CODE,),
family="Canary",
description=(
"NVIDIA's Canary 180M Flash converted to INT8 ONNX. The underlying model also "
"covers German, French, and Spanish, but its source/target language is fixed when "
"the recognizer loads rather than per request, so vocaphone loads it English-only "
"for now."
),
license_name=CC_BY_LICENSE,
),
_sherpa_onnx(
"streaming-zipformer-en-20m-int8",
"Streaming Zipformer English 20M INT8",
_megabytes("44"),
ENGLISH_ONLY,
"Fastest live streaming",
1,
huggingface_repo="csukuangfj/sherpa-onnx-streaming-zipformer-en-20M-2023-02-17",
required_files=(
"encoder-epoch-99-avg-1.int8.onnx",
"decoder-epoch-99-avg-1.int8.onnx",
"joiner-epoch-99-avg-1.int8.onnx",
TOKENS_FILE,