praveenperera commited on
Commit
63f6f9c
·
verified ·
1 Parent(s): 5fbef64

Add native CUDA weights and update the model card

Browse files

Native safetensors for the scriptrs CUDA backend (Parakeet TDT v2 and v3, Silero VAD v5), a card covering every runtime, a LICENSE covering Parakeet and Silero files, and provenance for the native files.

LICENSE CHANGED
@@ -1,9 +1,21 @@
1
- SPDX-License-Identifier: CC-BY-4.0
2
 
 
3
  Copyright (c) NVIDIA Corporation.
4
 
5
- This Core ML bundle is a conversion of NVIDIA Parakeet TDT 0.6B v3
6
- and is licensed under Creative Commons Attribution 4.0 International.
7
- You must give appropriate credit to NVIDIA.
 
8
 
9
  https://creativecommons.org/licenses/by/4.0/legalcode
 
 
 
 
 
 
 
 
 
 
 
1
+ Parakeet files (parakeet-v2/, parakeet-v3/)
2
 
3
+ SPDX-License-Identifier: CC-BY-4.0
4
  Copyright (c) NVIDIA Corporation.
5
 
6
+ These files are conversions of NVIDIA Parakeet TDT 0.6B v2 and v3 to Core ML
7
+ and to a safetensors layout for scriptrs, and are licensed under Creative
8
+ Commons Attribution 4.0 International. You must give appropriate credit to
9
+ NVIDIA.
10
 
11
  https://creativecommons.org/licenses/by/4.0/legalcode
12
+
13
+ Silero VAD files (vad/)
14
+
15
+ SPDX-License-Identifier: MIT
16
+ Copyright (c) 2020-present Silero Team
17
+
18
+ These files are conversions of Silero VAD and are licensed under the MIT
19
+ License.
20
+
21
+ https://github.com/snakers4/silero-vad/blob/master/LICENSE
PROVENANCE-native.json ADDED
@@ -0,0 +1,40 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "schema_version": 1,
3
+ "artifact_id": "scriptrs-native-cuda",
4
+ "runtime": "scriptrs_cuda",
5
+ "format": "scriptrs-native",
6
+ "format_version": "2",
7
+ "exporter": "dev-tools/nemo/export_native.py",
8
+ "files": [
9
+ {
10
+ "path": "parakeet-v2/model.safetensors",
11
+ "size": 2471715672,
12
+ "sha256": "ad48c4903e9bec8ad0004959d85ab9a92ad520294f0298c7822e45dcfd0dec42",
13
+ "license": "CC-BY-4.0",
14
+ "source": "nvidia/parakeet-tdt-0.6b-v2",
15
+ "source_sha256": "d99e39955c9d3d0350d8fb7c75e40c64a2b2eaeb003883d7c941fd2e8747b28c",
16
+ "toolkit": "nemo-toolkit 3.0.0"
17
+ },
18
+ {
19
+ "path": "parakeet-v3/model.safetensors",
20
+ "size": 2508444512,
21
+ "sha256": "fc79fd91aca14a2b02ba591d066d4e3cd088ef7321f6966dfd0b9c85038fbd47",
22
+ "license": "CC-BY-4.0",
23
+ "source": "nvidia/parakeet-tdt-0.6b-v3",
24
+ "source_sha256": "3cbdc85877e668ca7b82d0d56770eb1fac76691f55d6b97545e8d61ca588d10d",
25
+ "toolkit": "nemo-toolkit 3.0.0"
26
+ },
27
+ {
28
+ "path": "vad/silero-vad-v5.safetensors",
29
+ "size": 1240188,
30
+ "sha256": "88f62b0eea97c55d6ccee086d1ca67b6f733c29ceee4263e30fe5425bdddc187",
31
+ "license": "MIT",
32
+ "source": "silero-vad 5.1.2 (16 kHz branch)",
33
+ "source_sha256": "85c48e1f0ecb604e5d2a268f3ccfb912d4f7e935acdc86af5a3fc5b0aea7b29a"
34
+ }
35
+ ],
36
+ "shared_with_coreml": [
37
+ "parakeet-v2/vocab.txt",
38
+ "parakeet-v3/parakeet_vocab.json"
39
+ ]
40
+ }
README.md CHANGED
@@ -1,26 +1,103 @@
1
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2
  tags:
3
- - coreml
4
- - automatic-speech-recognition
5
  - parakeet
6
- - macos
7
- license: apache-2.0
 
 
 
8
  ---
9
 
10
  # scriptrs models
11
 
12
- Runtime model bundle for `scriptrs`.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
13
 
14
- Current contents:
15
- - Parakeet TDT v2 CoreML split models
16
- - vocabulary file
17
- - Silero VAD CoreML model for the `long-form` feature
18
 
19
- Layout:
20
- - `parakeet-v2/encoder.mlmodelc`
21
- - `parakeet-v2/decoder.mlmodelc`
22
- - `parakeet-v2/joint-decision.mlmodelc`
23
- - `parakeet-v2/vocab.txt`
24
- - `vad/silero-vad.mlmodelc`
25
 
26
- This repo is intended for `scriptrs` model download via the `online` feature.
 
1
  ---
2
+ license: cc-by-4.0
3
+ library_name: scriptrs
4
+ pipeline_tag: automatic-speech-recognition
5
+ base_model:
6
+ - nvidia/parakeet-tdt-0.6b-v2
7
+ - nvidia/parakeet-tdt-0.6b-v3
8
+ base_model_relation: quantized
9
+ language:
10
+ - en
11
+ - es
12
+ - fr
13
+ - de
14
+ - bg
15
+ - hr
16
+ - cs
17
+ - da
18
+ - nl
19
+ - et
20
+ - fi
21
+ - el
22
+ - hu
23
+ - it
24
+ - lv
25
+ - lt
26
+ - mt
27
+ - pl
28
+ - pt
29
+ - ro
30
+ - sk
31
+ - sl
32
+ - sv
33
+ - ru
34
+ - uk
35
  tags:
 
 
36
  - parakeet
37
+ - automatic-speech-recognition
38
+ - coreml
39
+ - cuda
40
+ - safetensors
41
+ - rust
42
  ---
43
 
44
  # scriptrs models
45
 
46
+ Model files for [scriptrs](https://github.com/avencera/scriptrs), a Rust library for fast NVIDIA Parakeet TDT v2 and v3 speech-to-text on Core ML (macOS) and native CUDA (Linux). With the default `online` feature, scriptrs downloads these files on first use from a pinned revision of this repository.
47
+
48
+ These are format conversions of NVIDIA's models, not new or retrained models. The native CUDA weights are NVIDIA's FP32 weights with their original names; scriptrs converts selected layers to FP16 on the GPU at load time.
49
+
50
+ ## Speed
51
+
52
+ RTX 5090, Parakeet v3, LibriSpeech test-clean (5.4 h), one utterance at a time:
53
+
54
+ | | Speed (x real time) | WER |
55
+ |---|---|---|
56
+ | scriptrs CUDA (FP16 default) | 1416x | 1.93 % |
57
+ | NVIDIA NeMo (PyTorch) | 477x | 1.93 % |
58
+ | parakeet-rs 0.4.3 (ONNX Runtime) | 253x | 1.93 % |
59
+
60
+ On the 44 Earnings-21 calls (39 h), long-form runs at 3443x with 8.24 % pooled WER. More results are in the [scriptrs README](https://github.com/avencera/scriptrs#cuda).
61
+
62
+ ## Usage
63
+
64
+ ```toml
65
+ # macOS, Core ML
66
+ scriptrs = "0.2"
67
+
68
+ # Linux, NVIDIA GPU (not yet in a crates.io release)
69
+ scriptrs = { git = "https://github.com/avencera/scriptrs", features = ["cuda"] }
70
+ ```
71
+
72
+ ```rust
73
+ use scriptrs::{ModelBundle, ParakeetDeployment, TranscriptionPipeline};
74
+
75
+ // Core ML on macOS
76
+ let pipeline = TranscriptionPipeline::from_pretrained()?;
77
+
78
+ // native CUDA on Linux
79
+ let bundle = ModelBundle::from_pretrained_native(ParakeetDeployment::v3())?;
80
+ let pipeline = TranscriptionPipeline::from_bundle(bundle)?;
81
+
82
+ let result = pipeline.run(&audio)?; // mono 16 kHz f32 samples
83
+ ```
84
+
85
+ For offline setups, download this repository and set `SCRIPTRS_MODELS_DIR` to its local path.
86
+
87
+ ## Contents
88
+
89
+ | Path | Runtime | Source |
90
+ |---|---|---|
91
+ | `parakeet-v2/encoder.mlmodelc`, `decoder.mlmodelc`, `joint-decision.mlmodelc` | Core ML | [nvidia/parakeet-tdt-0.6b-v2](https://huggingface.co/nvidia/parakeet-tdt-0.6b-v2) |
92
+ | `parakeet-v3/encoder.mlmodelc`, `decoder.mlmodelc`, `joint-decision.mlmodelc` | Core ML | [nvidia/parakeet-tdt-0.6b-v3](https://huggingface.co/nvidia/parakeet-tdt-0.6b-v3), via [FluidInference/parakeet-tdt-0.6b-v3-coreml](https://huggingface.co/FluidInference/parakeet-tdt-0.6b-v3-coreml) |
93
+ | `parakeet-v2/model.safetensors` | CUDA | nvidia/parakeet-tdt-0.6b-v2, exported from the NeMo checkpoint |
94
+ | `parakeet-v3/model.safetensors` | CUDA | nvidia/parakeet-tdt-0.6b-v3, exported from the NeMo checkpoint |
95
+ | `parakeet-v2/vocab.txt`, `parakeet-v3/parakeet_vocab.json` | both | NVIDIA tokenizers |
96
+ | `vad/silero-vad.mlmodelc` | Core ML | [Silero VAD](https://github.com/snakers4/silero-vad) |
97
+ | `vad/silero-vad-v5.safetensors` | CUDA | Silero VAD 5.1.2, 16 kHz branch |
98
 
99
+ The native weight files record their source and its SHA-256 in the safetensors metadata. `PROVENANCE.json` and `PROVENANCE-native.json` list sources, revisions and checksums.
 
 
 
100
 
101
+ ## License
 
 
 
 
 
102
 
103
+ The Parakeet files are derived from NVIDIA Parakeet TDT 0.6B v2 and v3, licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). Credit: NVIDIA. Changes: converted to Core ML and to a safetensors layout for scriptrs. The Silero VAD files are derived from Silero VAD, licensed under the MIT License. See `LICENSE`.
parakeet-v2/model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:ad48c4903e9bec8ad0004959d85ab9a92ad520294f0298c7822e45dcfd0dec42
3
+ size 2471715672
parakeet-v3/model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:fc79fd91aca14a2b02ba591d066d4e3cd088ef7321f6966dfd0b9c85038fbd47
3
+ size 2508444512
vad/silero-vad-v5.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:88f62b0eea97c55d6ccee086d1ca67b6f733c29ceee4263e30fe5425bdddc187
3
+ size 1240188