Skip to content

Clarify custom vocabulary model compatibility and approach selection#469

Merged
Alex-Wengg merged 1 commit intomainfrom
docs/clarify-custom-vocab-model-compatibility
Mar 30, 2026
Merged

Clarify custom vocabulary model compatibility and approach selection#469
Alex-Wengg merged 1 commit intomainfrom
docs/clarify-custom-vocab-model-compatibility

Conversation

@Alex-Wengg
Copy link
Copy Markdown
Member

@Alex-Wengg Alex-Wengg commented Mar 30, 2026

Summary

  • Adds Quick Start table showing which approach to use for each TDT model
  • Adds Model Compatibility section explaining TDT-CTC-110M (hybrid) vs Parakeet 0.6B (pure TDT)
  • Expands comparison table with explicit compatibility checkmarks for each model
  • Adds decision guide: "Which Approach Should I Use?"
  • Clarifies that TDT-CTC-110M has built-in 1MB CTC head, while 0.6B requires separate 97.5MB CTC encoder
  • Updates all diagrams to remove ambiguity about model requirements

Resolves confusion about "v1 vs v2" terminology by clearly stating these are approaches, not model versions. The actual model versions are TDT-CTC-110M and Parakeet TDT 0.6B v2/v3.

Motivation

The previous documentation was unclear about:

  • Which models work with which approaches
  • Why Approach 1 only works with TDT-CTC-110M
  • The difference between the 110M and 0.6B model architectures

This caused confusion when users saw "v1" and "v2" and thought they were model versions rather than implementation approaches.

Test plan

  • Documentation builds and renders correctly
  • Quick Start table provides immediate clarity
  • Decision guide clearly directs users to the right approach

🤖 Generated with Claude Code


Open with Devin

Update CustomVocabulary.md to clearly explain which models work with which approaches:
- Add Quick Start table showing TDT-CTC-110M uses Approach 1, Parakeet 0.6B uses Approach 2
- Add Model Compatibility section explaining hybrid vs pure TDT architectures
- Expand comparison table with explicit compatibility checkmarks
- Add "Which Approach Should I Use?" decision guide
- Clarify that TDT-CTC-110M has built-in CTC head (1MB), while 0.6B models require separate CTC encoder (97.5MB)
- Update all diagrams and descriptions to remove ambiguity about model requirements

Resolves confusion about "v1 vs v2" terminology - these are approaches, not model versions.
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@Alex-Wengg Alex-Wengg merged commit b4a9510 into main Mar 30, 2026
12 checks passed
@Alex-Wengg Alex-Wengg deleted the docs/clarify-custom-vocab-model-compatibility branch March 30, 2026 04:28
@github-actions
Copy link
Copy Markdown

PocketTTS Smoke Test ✅

Check Result
Build
Model download
Model load
Synthesis pipeline
Output WAV ✅ (213.8 KB)

Runtime: 0m36s

Note: PocketTTS uses CoreML MLState (macOS 15) KV cache + Mimi streaming state. CI VM lacks physical GPU — audio quality may differ from Apple Silicon.

@github-actions
Copy link
Copy Markdown

Parakeet EOU Benchmark Results ✅

Status: Benchmark passed
Chunk Size: 320ms
Files Tested: 100/100

Performance Metrics

Metric Value Description
WER (Avg) 7.03% Average Word Error Rate
WER (Med) 4.17% Median Word Error Rate
RTFx 8.49x Real-time factor (higher = faster)
Total Audio 470.6s Total audio duration processed
Total Time 58.1s Total processing time

Streaming Metrics

Metric Value Description
Avg Chunk Time 0.058s Average chunk processing time
Max Chunk Time 0.116s Maximum chunk processing time
EOU Detections 0 Total End-of-Utterance detections

Test runtime: 1m22s • 03/30/2026, 12:32 AM EST

RTFx = Real-Time Factor (higher is better) • Processing includes: Model inference, audio preprocessing, state management, and file I/O

@github-actions
Copy link
Copy Markdown

VAD Benchmark Results

Performance Comparison

Dataset Accuracy Precision Recall F1-Score RTFx Files
MUSAN 92.0% 86.2% 100.0% 92.6% 645.7x faster 50
VOiCES 92.0% 86.2% 100.0% 92.6% 510.7x faster 50

Dataset Details

  • MUSAN: Music, Speech, and Noise dataset - standard VAD evaluation
  • VOiCES: Voices Obscured in Complex Environmental Settings - tests robustness in real-world conditions

✅: Average F1-Score above 70%

@github-actions
Copy link
Copy Markdown

Sortformer High-Latency Benchmark Results

ES2004a Performance (30.4s latency config)

Metric Value Target Status
DER 33.4% <35%
Miss Rate 24.4% - -
False Alarm 0.2% - -
Speaker Error 8.8% - -
RTFx 14.5x >1.0x
Speakers 4/4 - -

Sortformer High-Latency • ES2004a • Runtime: 2m 22s • 2026-03-30T04:33:07.961Z

@github-actions
Copy link
Copy Markdown

Qwen3-ASR int8 Smoke Test ✅

Check Result
Build
Model download
Model load
Transcription pipeline
Decoder size 571 MB (vs 1.1 GB f32)

Performance Metrics

Metric CI Value Expected on Apple Silicon
Median RTFx 0.05x ~2.5x
Overall RTFx 0.05x ~2.5x

Runtime: 3m55s

Note: CI VM lacks physical GPU — CoreML MLState (macOS 15) KV cache produces degraded results on virtualized runners. On Apple Silicon: ~1.3% WER / 2.5x RTFx.

@github-actions
Copy link
Copy Markdown

Speaker Diarization Benchmark Results

Speaker Diarization Performance

Evaluating "who spoke when" detection accuracy

Metric Value Target Status Description
DER 15.1% <30% Diarization Error Rate (lower is better)
JER 24.9% <25% Jaccard Error Rate
RTFx 28.94x >1.0x Real-Time Factor (higher is faster)

Diarization Pipeline Timing Breakdown

Time spent in each stage of speaker diarization

Stage Time (s) % Description
Model Download 8.193 22.6 Fetching diarization models
Model Compile 3.511 9.7 CoreML compilation
Audio Load 0.030 0.1 Loading audio file
Segmentation 10.875 30.0 Detecting speech regions
Embedding 18.125 50.0 Extracting speaker voices
Clustering 7.250 20.0 Grouping same speakers
Total 36.263 100 Full pipeline

Speaker Diarization Research Comparison

Research baselines typically achieve 18-30% DER on standard datasets

Method DER Notes
FluidAudio 15.1% On-device CoreML
Research baseline 18-30% Standard dataset performance

Note: RTFx shown above is from GitHub Actions runner. On Apple Silicon with ANE:

  • M2 MacBook Air (2022): Runs at 150 RTFx real-time
  • Performance scales with Apple Neural Engine capabilities

🎯 Speaker Diarization Test • AMI Corpus ES2004a • 1049.0s meeting audio • 36.2s diarization time • Test runtime: 2m 6s • 03/30/2026, 12:41 AM EST

@github-actions
Copy link
Copy Markdown

Offline VBx Pipeline Results

Speaker Diarization Performance (VBx Batch Mode)

Optimal clustering with Hungarian algorithm for maximum accuracy

Metric Value Target Status Description
DER 14.5% <20% Diarization Error Rate (lower is better)
RTFx 4.99x >1.0x Real-Time Factor (higher is faster)

Offline VBx Pipeline Timing Breakdown

Time spent in each stage of batch diarization

Stage Time (s) % Description
Model Download 13.483 6.4 Fetching diarization models
Model Compile 5.779 2.8 CoreML compilation
Audio Load 0.096 0.0 Loading audio file
Segmentation 22.099 10.5 VAD + speech detection
Embedding 209.127 99.5 Speaker embedding extraction
Clustering (VBx) 0.803 0.4 Hungarian algorithm + VBx clustering
Total 210.102 100 Full VBx pipeline

Speaker Diarization Research Comparison

Offline VBx achieves competitive accuracy with batch processing

Method DER Mode Description
FluidAudio (Offline) 14.5% VBx Batch On-device CoreML with optimal clustering
FluidAudio (Streaming) 17.7% Chunk-based First-occurrence speaker mapping
Research baseline 18-30% Various Standard dataset performance

Pipeline Details:

  • Mode: Offline VBx with Hungarian algorithm for optimal speaker-to-cluster assignment
  • Segmentation: VAD-based voice activity detection
  • Embeddings: WeSpeaker-compatible speaker embeddings
  • Clustering: PowerSet with VBx refinement
  • Accuracy: Higher than streaming due to optimal post-hoc mapping

🎯 Offline VBx Test • AMI Corpus ES2004a • 1049.0s meeting audio • 232.0s processing • Test runtime: 3m 58s • 03/30/2026, 12:41 AM EST

@github-actions
Copy link
Copy Markdown

ASR Benchmark Results ✅

Status: All benchmarks passed

Parakeet v3 (multilingual)

Dataset WER Avg WER Med RTFx Status
test-clean 0.57% 0.00% 6.04x
test-other 1.35% 0.00% 3.73x

Parakeet v2 (English-optimized)

Dataset WER Avg WER Med RTFx Status
test-clean 0.80% 0.00% 5.88x
test-other 1.40% 0.00% 3.83x

Streaming (v3)

Metric Value Description
WER 0.00% Word Error Rate in streaming mode
RTFx 0.69x Streaming real-time factor
Avg Chunk Time 1.303s Average time to process each chunk
Max Chunk Time 1.371s Maximum chunk processing time
First Token 1.558s Latency to first transcription token
Total Chunks 31 Number of chunks processed

Streaming (v2)

Metric Value Description
WER 0.00% Word Error Rate in streaming mode
RTFx 0.69x Streaming real-time factor
Avg Chunk Time 1.308s Average time to process each chunk
Max Chunk Time 1.420s Maximum chunk processing time
First Token 1.307s Latency to first transcription token
Total Chunks 31 Number of chunks processed

Streaming tests use 5 files with 0.5s chunks to simulate real-time audio streaming

25 files per dataset • Test runtime: 5m24s • 03/30/2026, 12:41 AM EST

RTFx = Real-Time Factor (higher is better) • Calculated as: Total audio duration ÷ Total processing time
Processing time includes: Model inference on Apple Neural Engine, audio preprocessing, state resets between files, token-to-text conversion, and file I/O
Example: RTFx of 2.0x means 10 seconds of audio processed in 5 seconds (2x faster than real-time)

Expected RTFx Performance on Physical M1 Hardware:

• M1 Mac: ~28x (clean), ~25x (other)
• CI shows ~0.5-3x due to virtualization limitations

Testing methodology follows HuggingFace Open ASR Leaderboard

@github-actions
Copy link
Copy Markdown

Kokoro TTS Smoke Test ✅

Check Result
Build
Model download
Model load
Synthesis pipeline
Output WAV ✅ (634.8 KB)

Runtime: 0m44s

Note: Kokoro TTS uses CoreML flow matching + Vocos vocoder. CI VM lacks physical ANE — performance may differ from Apple Silicon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant