Jimmi42 commited on
Commit
e4efdb3
·
verified ·
1 Parent(s): dff1d43

Improve README with usage and benchmarks (still files-only)

Browse files
Files changed (1) hide show
  1. README.md +24 -9
README.md CHANGED
@@ -1,7 +1,8 @@
 
1
 
2
- # Parakeet‑TDT v3 MLX Weights (files‑only)
3
-
4
- Files‑only hosting for MLX weights and config. No Inference Widget, no runnable code in this repo.
5
 
6
  ## Contents
7
  - `parakeet-tdt-v3-mlx/config.json`
@@ -12,7 +13,7 @@ Files‑only hosting for MLX weights and config. No Inference Widget, no runnabl
12
 
13
  ## How to use
14
 
15
- ### Option A: Download with huggingface_hub
16
  ```python
17
  from huggingface_hub import snapshot_download
18
  from parakeetv3_mlx.utils import from_pretrained
@@ -26,14 +27,28 @@ print("".join(t.text for t in res.tokens))
26
  ```
27
 
28
  ### Option B: Download manually
29
- - Click “Files and versions” and download the 5 files under `parakeet-tdt-v3-mlx/` to a local folder
30
- - Then:
31
  ```python
32
  from parakeetv3_mlx.utils import from_pretrained
33
  model = from_pretrained("/path/to/parakeet-tdt-v3-mlx")
34
  ```
35
 
36
  ### Notes
37
- - Requires the `parakeetv3_mlx` Python package (bundled in your project) and MLX.
38
- - Audio should be mono 16 kHz WAV; `librosa` will resample if needed.
39
- - For long audio, enable local attention and chunking in your code.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Parakeet‑TDT 0.6B v3 (MLX) — Model Files
2
 
3
+ This repository hosts the MLX model files (config + weights + tokenizer) for Parakeet‑TDT v3.
4
+ It is intentionally files‑only (no widget, no runnable code). Use these files with your own
5
+ codebase or with the `parakeetv3_mlx` package in your project.
6
 
7
  ## Contents
8
  - `parakeet-tdt-v3-mlx/config.json`
 
13
 
14
  ## How to use
15
 
16
+ ### Option A: Download programmatically
17
  ```python
18
  from huggingface_hub import snapshot_download
19
  from parakeetv3_mlx.utils import from_pretrained
 
27
  ```
28
 
29
  ### Option B: Download manually
30
+ 1) In “Files and versions”, download the files under `parakeet-tdt-v3-mlx/` into a local folder.
31
+ 2) Load with:
32
  ```python
33
  from parakeetv3_mlx.utils import from_pretrained
34
  model = from_pretrained("/path/to/parakeet-tdt-v3-mlx")
35
  ```
36
 
37
  ### Notes
38
+ - Requires the `parakeetv3_mlx` Python package (your app or local project) and Apple’s MLX.
39
+ - Audio: mono 16 kHz WAV recommended (librosa can resample automatically).
40
+ - Long audio: enable local attention + chunking in your code for best memory/perf trade‑off.
41
+
42
+ ## Benchmarks (Apple Silicon)
43
+ - Settings: chunk=120s, overlap=15s, local attention (256,256), bf16
44
+ - Device: M4 Pro
45
+
46
+ | Audio (1h) | Wall time | RTF |
47
+ |------------|-----------|-----|
48
+ | English | 43.6 s | 82.6× |
49
+ | German | 59.6 s | 60.4× |
50
+
51
+ On M4 Max, throughput is typically ~2× higher under the same settings.
52
+
53
+ ## About the author
54
+ Profile: https://huggingface.co/Jimmi42