Skip to content

feat(package): TTS and Diarizer opt-out traits (#990) - #1001

Open
Alex-Wengg wants to merge 1 commit into
mainfrom
feat/990-tts-diarizer-traits
Open

Alex-Wengg wants to merge 1 commit into
mainfrom
feat/990-tts-diarizer-traits

Conversation

@Alex-Wengg

Copy link
Copy Markdown
Member

Closes #990.

ASR-only consumers compiled the TTS and diarization subsystems and shipped the ~1 MB LuxTTS G2P bundle that no code path could reach. Package@swift-6.2.swift adds TTS and Diarizer traits, default-on alongside NemoTextProcessing.

  • Every file under TTS/ and Diarizer/ is wrapped in #if TTS / #if Diarizer. Each file gains two lines and keeps its indentation.
  • The G2P lexicon moves to its own LuxTtsG2pResources target. SwiftPM can't condition resources inside a target, so the trait conditions the dependency edge instead.
  • DiarizerError is unguarded (ANEMemoryOptimizer throws it). A few ModelNames members that use TTS or diarizer types are guarded.
  • Package.swift (tools < 6.2) and the podspec define both flags unconditionally, so those builds are unchanged.
  • CI adds a job that builds the library target with no traits, TTS only, and Diarizer only, and asserts the resource bundle is absent. The no-NeMo job now passes --traits TTS,Diarizer, because the CLI and tests need both.

Behavior change: traits: [] used to drop only the NeMo engine. Apps that also use diarization now need traits: ["Diarizer"]. Without it they get a compile error, never a silent change. README and PostProcessing.md cover this.

Minimal macOS consumer (release build, strip -x):

traits binary bundle
default 14.54 MB 1.0 MB
["NemoTextProcessing"] 3.80 MB none
[] 3.13 MB none

The README example says from: "0.17.7". Adjust it if the release version differs.

🤖 Generated with Claude Code

ASR-only consumers compiled the TTS and diarization subsystems and shipped
the ~1 MB LuxTTS G2P resource bundle even though nothing could reach them.
Package@swift-6.2.swift now declares `TTS` and `Diarizer` traits, default-on
alongside `NemoTextProcessing`, so `traits: []` builds ASR + VAD only.

- Every file under Sources/FluidAudio/TTS and Sources/FluidAudio/Diarizer is
  wrapped in `#if TTS` / `#if Diarizer` (the formatter does not indent
  conditional blocks, so each file gains two lines).
- The G2P lexicon moves into its own `LuxTtsG2pResources` target. SwiftPM
  cannot condition resources inside a target, so the trait conditions the
  dependency edge instead and the bundle drops out.
- `DiarizerError` gets its own unguarded file because
  Shared/ANEMemoryOptimizer throws it. ModelNames guards its members that
  use Sortformer, PocketTTS, or Chatterbox types. Inflect frame buckets now
  live in ModelNames, and InflectConstants reads them from there.
- Package.swift (tools < 6.2) and the podspec define both flags
  unconditionally, so those builds compile everything as before.

Behavior change: `traits: []` used to drop only the NeMo engine. Apps that
also use diarization now need `traits: ["Diarizer"]`. Leaving it out gives a
compile error, never a silent behavior change.

Measured on a minimal macOS consumer (release build, strip -x): the default
traits give 14.54 MB plus a 1.0 MB bundle, `["NemoTextProcessing"]` gives
3.80 MB, and `[]` gives 3.13 MB with no bundle. Every trait subset builds the
library target; the CLI and tests still need TTS and Diarizer, so CI's
no-Nemo job now passes `--traits TTS,Diarizer`.
@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown

PocketTTS Smoke Test ✅

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

Runtime: 0m25s

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

@github-actions

github-actions Bot commented Oct 8, 2026

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 10.4% <20% ✅ Diarization Error Rate (lower is better)
RTFx 8.65x >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 18.912 15.6 Fetching diarization models
Model Compile 8.105 6.7 CoreML compilation
Audio Load 0.058 0.0 Loading audio file
Segmentation 31.433 25.9 VAD + speech detection
Embedding 121.071 99.8 Speaker embedding extraction
Clustering (VBx) 0.130 0.1 Hungarian algorithm + VBx clustering
Total 121.369 100 Full VBx pipeline

Speaker Diarization Research Comparison

Offline VBx achieves competitive accuracy with batch processing

Method DER Mode Description
FluidAudio (Offline) 10.4% 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 • 152.6s processing • Test runtime: 2m 38s • 10/07/2026, 10:25 PM EST

@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown

Sortformer High-Latency Benchmark Results

ES2004a Performance (30.4s latency config)

Metric Value Target Status
DER 30.3% <35% ✅
Miss Rate 28.2% - -
False Alarm 0.9% - -
Speaker Error 1.2% - -
RTFx 13.3x >1.0x ✅
Speakers 4/4 - -

Sortformer High-Latency • ES2004a • Runtime: 4m 6s • 2026-10-08T02:29:26.179Z

@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown

Supertonic3 Smoke Test ✅

Check Result
Build ✅
Model download (incl. VectorEstimatorVariants/ int4 buckets) ✅
Model load ✅
Synthesis pipeline (--ve-variant int4) ✅
Output WAV ✅ (364.7 KB)

Runtime: 0m32s

Note: CI VMs lack a physical Neural Engine; the ANE-bucketed VectorEstimator falls back to CPU here. This validates download + variant resolution + synthesis, not ANE residency/perf.

@github-actions

github-actions Bot commented Oct 8, 2026

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 29.06x >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 11.507 31.9 Fetching diarization models
Model Compile 4.932 13.7 CoreML compilation
Audio Load 0.032 0.1 Loading audio file
Segmentation 10.830 30.0 Detecting speech regions
Embedding 18.050 50.0 Extracting speaker voices
Clustering 7.220 20.0 Grouping same speakers
Total 36.111 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.1s diarization time • Test runtime: 2m 50s • 10/07/2026, 11:18 PM EST

@github-actions

github-actions Bot commented Oct 8, 2026

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% 4.28x ✅
test-other 1.19% 0.00% 2.85x ✅

Parakeet v2 (English-optimized)

Dataset WER Avg WER Med RTFx Status
test-clean 0.80% 0.00% 3.83x ✅
test-other 1.00% 0.00% 2.39x ✅

Streaming (v3)

Metric Value Description
WER 0.00% Word Error Rate in streaming mode
RTFx 0.44x Streaming real-time factor
Avg Chunk Time 2.099s Average time to process each chunk
Max Chunk Time 2.885s Maximum chunk processing time
First Token 2.629s 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.45x Streaming real-time factor
Avg Chunk Time 2.028s Average time to process each chunk
Max Chunk Time 3.004s Maximum chunk processing time
First Token 1.971s 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: 9m46s • 10/07/2026, 11:24 PM 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

github-actions Bot commented Oct 8, 2026

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.54x Real-time factor (higher = faster)
Total Audio 470.6s Total audio duration processed
Total Time 57.2s Total processing time

Streaming Metrics

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

Test runtime: 1m32s • 10/07/2026, 11:25 PM EST

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

@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown

VAD Benchmark Results

Performance Comparison

Dataset Accuracy Precision Recall F1-Score RTFx Files
MUSAN 94.0% 89.3% 100.0% 94.3% 444.7x faster 50
VOiCES 94.0% 89.3% 100.0% 94.3% 427.2x 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%

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

Labels

None yet

Projects

None yet

1 participant