atesahmet0 commited on
Commit
1f228c1
·
verified ·
1 Parent(s): d3df3b2

Shorten model card and simplify usage

Browse files
Files changed (1) hide show
  1. README.md +10 -26
README.md CHANGED
@@ -14,17 +14,12 @@ tags:
14
  - apple-silicon
15
  ---
16
 
17
- # Phonon-2 for MLX Audio
18
 
19
- Preconverted MLX weights for [Fermion Research's Phonon-2](https://huggingface.co/FermionResearch/Phonon-2), an English speech recognition model derived from [NVIDIA Parakeet TDT 0.6B v3](https://huggingface.co/nvidia/parakeet-tdt-0.6b-v3).
20
-
21
- The five-value encoder is represented by two native MLX 2-bit planes with the original fp16 row palettes. Remaining tables use bf16, matching Fermion's packed MLX runtime. This is a custom five-value representation, rather than a standard uniformly quantized 2-bit model. The Safetensors file is approximately 350 MB (334 MiB).
22
-
23
- ## Compatibility
24
-
25
- Requires an mlx-audio build containing the revised Phonon-2 integration prepared for [PR #1030](https://github.com/Blaizzy/mlx-audio/pull/1030). The validated revision is currently local and has not been pushed or released. Installing an older mlx-audio release alone will not add this model implementation. No remote Python code is included in this repository.
26
-
27
- Once that implementation is installed, load these weights directly; no local conversion or Fermion runtime is needed:
28
 
29
  ```python
30
  from mlx_audio.stt import load
@@ -32,22 +27,11 @@ from mlx_audio.stt import load
32
  model = load("mlx-community/Phonon-2")
33
  result = model.generate("audio.wav", chunk_duration=30, overlap_duration=2)
34
  print(result.text)
35
-
36
- for sentence in result.sentences:
37
- for token in sentence.tokens:
38
- print(token.start, token.end, token.text)
39
  ```
40
 
41
- Paths are resampled by mlx-audio. Array inputs must be mono 16 kHz waveforms. The model supplies token pieces and sentence timestamps; pieces may need joining into words. Short nonempty inputs are padded to 320 samples. `stream=True` emits overlapping chunk results from a recording; it does not provide live-input streaming. English transcription only; translation, hotword biasing, and diarization are not implemented.
42
-
43
- ## Conversion and validation
44
-
45
- Converted using NumPy/MLX from official source revision `7e153e4054c0a10db6d47d6fff5c062d4c77c154`. Source archive SHA-256: `98125795b6dda72f5c6eee9ba33d19815df65dcb18b50a357bf9f73c9935309e`. The archive and extracted files were verified before conversion. Packed codes and row palettes are preserved, with no additional encoder weight quantization.
46
-
47
- Validated on Apple Silicon with MLX 0.32.4 against fermion-research 0.2.11 in packed mode (`FERMION_P2_FAST=tdt16`). Six clips totaling 178 seconds exactly matched text, timed tokens, and overlapping chunked/streaming results. Distinct-input, duplicate-input, and different-valid-length batched-mel cases also matched the official runtime. Batch composition affected a token timestamp relative to individual processing in both runtimes; equivalent batched execution matched exactly. These limited checks establish parity on the tested inputs, not an accuracy or performance improvement. Other MLX versions and hardware were not revalidated for this revision.
48
-
49
- ## Attribution and licenses
50
-
51
- Phonon-2: Fermion Research. Base Parakeet architecture and original model: NVIDIA Corporation. Weights are licensed under [CC-BY-4.0](LICENSE-WEIGHTS-CC-BY-4.0.txt). This conversion changes storage layout and uses bf16 dense tables as described above. Retain attribution and license information when redistributing.
52
 
53
- The upstream [Apache-2.0 code license](LICENSE-CODE-Apache-2.0.txt) is retained for provenance; this repository distributes weights and configuration, not the Fermion runtime. See the upstream repositories and the included NOTICE for attribution.
 
 
 
14
  - apple-silicon
15
  ---
16
 
17
+ # Phonon-2 for MLX
18
 
19
+ English speech recognition with [Fermion Research's Phonon-2](https://huggingface.co/FermionResearch/Phonon-2),
20
+ derived from [NVIDIA Parakeet TDT 0.6B v3](https://huggingface.co/nvidia/parakeet-tdt-0.6b-v3).
21
+ Preconverted five-value weights; approximately 350 MB. No converter or Fermion runtime needed.
22
+ Requires mlx-audio with Phonon-2 support.
 
 
 
 
 
23
 
24
  ```python
25
  from mlx_audio.stt import load
 
27
  model = load("mlx-community/Phonon-2")
28
  result = model.generate("audio.wav", chunk_duration=30, overlap_duration=2)
29
  print(result.text)
 
 
 
 
30
  ```
31
 
32
+ Supports token timestamps and overlapping chunk output, not live-input streaming.
33
+ Validated against the official packed runtime on six clips using MLX 0.32.4.
 
 
 
 
 
 
 
 
 
34
 
35
+ Weights: [CC-BY-4.0](LICENSE-WEIGHTS-CC-BY-4.0.txt). Copyright Fermion Research and NVIDIA.
36
+ Encoder codes are repacked into two MLX 2-bit planes; row palettes remain fp16 and dense tables use bf16.
37
+ See [NOTICE](NOTICE) for attribution.