-
-
Notifications
You must be signed in to change notification settings - Fork 50
Expand file tree
/
Copy pathModelManager.swift
More file actions
623 lines (531 loc) · 23.8 KB
/
Copy pathModelManager.swift
File metadata and controls
623 lines (531 loc) · 23.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
//
// ModelManager.swift
// Pindrop
//
// Created on 2026-01-25.
//
import Foundation
import WhisperKit
import FluidAudio
@MainActor
@Observable
class ModelManager {
nonisolated static let englishRecommendedModelNames = [
"openai_whisper-base.en",
"openai_whisper-small.en",
"openai_whisper-medium",
"openai_whisper-large-v3_turbo",
"parakeet-tdt-0.6b-v2"
]
nonisolated static let multilingualRecommendedModelNames = [
"openai_whisper-base",
"openai_whisper-small",
"openai_whisper-medium",
"openai_whisper-large-v3_turbo",
"parakeet-tdt-0.6b-v3"
]
nonisolated static let recommendedModelNames = englishRecommendedModelNames
nonisolated static let recommendedModelNameSet: Set<String> = Set(englishRecommendedModelNames)
enum ModelProvider: String, CaseIterable, Sendable {
case whisperKit = "WhisperKit"
case parakeet = "Parakeet"
case openAI = "OpenAI"
case elevenLabs = "ElevenLabs"
case groq = "Groq"
var isLocal: Bool {
TranscriptionPolicy.providerSupportsLocalModelLoading(self)
}
var iconName: String {
switch self {
case .whisperKit: return "waveform"
case .parakeet: return "bird"
case .openAI: return "sparkles"
case .elevenLabs: return "waveform.circle"
case .groq: return "bolt"
}
}
}
enum ModelLanguage: String, Sendable {
case english = "English-only"
case multilingual = "Multilingual"
}
enum LanguageSupport: Sendable {
case englishOnly
case fullMultilingual
case parakeetV3European
enum BadgeTone: Sendable {
case normal
case caution
}
struct BadgePresentation: Sendable {
let iconName: String
let text: String
let tone: BadgeTone
}
func supports(_ language: AppLanguage) -> Bool {
TranscriptionPolicy.modelSupportsLanguage(self, language: language)
}
var badgeText: String {
switch self {
case .englishOnly:
return "English-only"
case .fullMultilingual:
return "Multilingual"
case .parakeetV3European:
return "European multilingual"
}
}
var badgeIconName: String {
switch self {
case .englishOnly:
return "textformat"
case .fullMultilingual, .parakeetV3European:
return "globe"
}
}
func badgePresentation(for language: AppLanguage) -> BadgePresentation {
BadgePresentation(
iconName: badgeIconName,
text: badgeText,
tone: supports(language) ? .normal : .caution
)
}
}
enum ModelAvailability: Equatable, Sendable {
case available
case comingSoon
case requiresSetup
}
struct WhisperModel: Identifiable, Equatable, Sendable {
let id: String
let name: String
let displayName: String
let sizeInMB: Int
let description: String
let speedRating: Double
let accuracyRating: Double
let language: ModelLanguage
let languageSupport: LanguageSupport
let provider: ModelProvider
let availability: ModelAvailability
init(
name: String,
displayName: String,
sizeInMB: Int,
description: String = "",
speedRating: Double = 5.0,
accuracyRating: Double = 5.0,
language: ModelLanguage = .multilingual,
languageSupport: LanguageSupport? = nil,
provider: ModelProvider = .whisperKit,
availability: ModelAvailability = .available
) {
self.id = name
self.name = name
self.displayName = displayName
self.sizeInMB = sizeInMB
self.description = description
self.speedRating = speedRating
self.accuracyRating = accuracyRating
self.language = language
self.languageSupport = languageSupport ?? (language == .english ? .englishOnly : .fullMultilingual)
self.provider = provider
self.availability = availability
}
var formattedSize: String {
if sizeInMB >= 1000 {
return String(format: "%.1f GB", Double(sizeInMB) / 1000.0)
} else {
return "\(sizeInMB) MB"
}
}
func supports(language: AppLanguage) -> Bool {
languageSupport.supports(language)
}
func languageBadgePresentation(for language: AppLanguage) -> LanguageSupport.BadgePresentation {
languageSupport.badgePresentation(for: language)
}
}
enum ModelError: Error, LocalizedError {
case modelNotFound(String)
case downloadFailed(String)
case deleteFailed(String)
case downloadNotImplemented(String)
var errorDescription: String? {
switch self {
case .modelNotFound(let name):
return "Model '\(name)' not found"
case .downloadFailed(let message):
return "Download failed: \(message)"
case .deleteFailed(let message):
return "Delete failed: \(message)"
case .downloadNotImplemented(let provider):
return "Download for \(provider) models is not yet implemented"
}
}
}
let availableModels: [WhisperModel] = TranscriptionModelCatalog.availableModels
func recommendedModels(for language: AppLanguage) -> [WhisperModel] {
TranscriptionModelCatalog.recommendedModels(
availableModels: availableModels,
for: language
)
}
var recommendedModels: [WhisperModel] {
recommendedModels(for: .english)
}
private(set) var downloadProgress: Double = 0.0
private(set) var isDownloading: Bool = false
private(set) var currentDownloadModel: String?
private(set) var downloadedModelNames: Set<String> = []
private(set) var featureDownloadProgress: Double = 0.0
private(set) var isDownloadingFeature: Bool = false
private(set) var currentDownloadingFeature: FeatureModelType?
private(set) var downloadedFeatureModels: Set<FeatureModelType> = []
private let fileManager = FileManager.default
#if canImport(PindropSharedTranscription)
@ObservationIgnored
private lazy var localRuntimeBridge = KMPTranscriptionRuntimeBridge(
modelManager: self,
engineFactory: TranscriptionService.defaultEngineFactory(provider:)
)
#endif
/// Last decile (0...10) logged for WhisperKit file download progress to avoid log spam.
private var whisperKitDownloadLastLoggedDecile: Int = -1
private var modelsBaseURL: URL {
fileManager.urls(for: .applicationSupportDirectory, in: .userDomainMask).first!
.appendingPathComponent("Pindrop", isDirectory: true)
}
private var whisperKitModelsURL: URL {
modelsBaseURL
.appendingPathComponent("models", isDirectory: true)
.appendingPathComponent("argmaxinc", isDirectory: true)
.appendingPathComponent("whisperkit-coreml", isDirectory: true)
}
private var parakeetModelsURL: URL {
modelsBaseURL.appendingPathComponent("FluidInference", isDirectory: true)
.appendingPathComponent("parakeet-coreml", isDirectory: true)
}
private var fluidAudioModelsURL: URL {
fileManager.urls(for: .applicationSupportDirectory, in: .userDomainMask).first!
.appendingPathComponent("FluidAudio", isDirectory: true)
.appendingPathComponent("Models", isDirectory: true)
}
private func localModelPath(for model: WhisperModel) -> URL? {
switch model.provider {
case .whisperKit:
return whisperKitModelsURL.appendingPathComponent(model.name, isDirectory: true)
case .parakeet:
let folderName = model.name.hasSuffix("-coreml") ? model.name : "\(model.name)-coreml"
return parakeetModelsURL.appendingPathComponent(folderName, isDirectory: true)
case .openAI, .elevenLabs, .groq:
return nil
}
}
private static var isPreview: Bool {
ProcessInfo.processInfo.environment["XCODE_RUNNING_FOR_PREVIEWS"] == "1"
}
init() {
guard !Self.isPreview else { return }
}
func refreshDownloadedModels() async {
#if canImport(PindropSharedTranscription)
let downloaded = await localRuntimeBridge.refreshInstalledModelNames()
if downloaded != downloadedModelNames {
Log.model.debug("Found \(downloaded.count) downloaded models via KMP runtime: \(downloaded)")
}
downloadedModelNames = downloaded
#else
await refreshDownloadedModelsFromDisk()
#endif
}
private func refreshDownloadedModelsFromDisk() async {
var downloaded: Set<String> = []
let whisperKitPath = whisperKitModelsURL
if fileManager.fileExists(atPath: whisperKitPath.path) {
do {
let contents = try fileManager.contentsOfDirectory(atPath: whisperKitPath.path)
for folder in contents {
if folder.hasPrefix(".") { continue }
let folderPath = whisperKitPath.appendingPathComponent(folder).path
var isDirectory: ObjCBool = false
if fileManager.fileExists(atPath: folderPath, isDirectory: &isDirectory), isDirectory.boolValue {
downloaded.insert(folder)
}
}
} catch {
Log.model.error("Failed to list WhisperKit models: \(error)")
}
}
if fileManager.fileExists(atPath: parakeetModelsURL.path) {
do {
let contents = try fileManager.contentsOfDirectory(atPath: parakeetModelsURL.path)
for folder in contents {
if folder.hasPrefix(".") { continue }
let folderPath = parakeetModelsURL.appendingPathComponent(folder).path
var isDirectory: ObjCBool = false
if fileManager.fileExists(atPath: folderPath, isDirectory: &isDirectory), isDirectory.boolValue {
// Strip "-coreml" suffix (7 chars) to match model IDs
let normalizedName = folder.hasSuffix("-coreml")
? String(folder.dropLast(7))
: folder
downloaded.insert(normalizedName)
}
}
} catch {
Log.model.error("Failed to list Parakeet models: \(error)")
}
}
if downloaded != downloadedModelNames {
Log.model.debug("Found \(downloaded.count) downloaded models: \(downloaded)")
}
downloadedModelNames = downloaded
}
func getDownloadedModels() async -> [WhisperModel] {
await refreshDownloadedModels()
return availableModels.filter { downloadedModelNames.contains($0.name) }
}
func isModelDownloaded(_ modelName: String) -> Bool {
downloadedModelNames.contains(modelName)
}
func downloadModel(named modelName: String, onProgress: ((Double) -> Void)? = nil) async throws {
guard let model = availableModels.first(where: { $0.name == modelName }) else {
throw ModelError.modelNotFound(modelName)
}
guard !isDownloading else {
Log.boot.error("downloadModel rejected: another download in progress current=\(currentDownloadModel ?? "nil")")
throw ModelError.downloadFailed("Another download is in progress")
}
Log.boot.info("ModelManager.downloadModel begin name=\(modelName) provider=\(model.provider.rawValue)")
let downloadWallClock = CFAbsoluteTimeGetCurrent()
isDownloading = true
currentDownloadModel = modelName
downloadProgress = 0.0
defer {
isDownloading = false
currentDownloadModel = nil
}
#if canImport(PindropSharedTranscription)
if model.provider.isLocal {
try await localRuntimeBridge.installModel(named: modelName, onProgress: onProgress)
} else {
throw ModelError.downloadNotImplemented(model.provider.rawValue)
}
#else
try await installModelArtifacts(named: modelName, onProgress: onProgress)
#endif
Log.boot.info("ModelManager.downloadModel finished OK name=\(modelName) wallClock=\(String(format: "%.2fs", CFAbsoluteTimeGetCurrent() - downloadWallClock))")
}
func installModelArtifacts(named modelName: String, onProgress: ((Double) -> Void)? = nil) async throws {
guard let model = availableModels.first(where: { $0.name == modelName }) else {
throw ModelError.modelNotFound(modelName)
}
if model.provider == .parakeet {
try await downloadParakeetModel(named: modelName, onProgress: onProgress)
} else if model.provider == .whisperKit {
try await downloadWhisperKitModel(named: modelName, onProgress: onProgress)
} else {
throw ModelError.downloadNotImplemented(model.provider.rawValue)
}
}
private func downloadWhisperKitModel(named modelName: String, onProgress: ((Double) -> Void)? = nil) async throws {
whisperKitDownloadLastLoggedDecile = -1
let pipelineStart = CFAbsoluteTimeGetCurrent()
do {
Log.model.info("Downloading WhisperKit model: \(modelName) to \(self.modelsBaseURL.path)")
Log.boot.info(
"WhisperKit pipeline begin variant=\(modelName) storageLeaf=Pindrop/models/argmaxinc/whisperkit-coreml (under Application Support) uiProgressNote=0-80pct is file download 85-100pct is prewarm"
)
let mkdirStart = CFAbsoluteTimeGetCurrent()
try fileManager.createDirectory(at: self.modelsBaseURL, withIntermediateDirectories: true)
Log.boot.info("WhisperKit storage directories ensured elapsed=\(String(format: "%.3fs", CFAbsoluteTimeGetCurrent() - mkdirStart))")
let fileDownloadStart = CFAbsoluteTimeGetCurrent()
Log.boot.info("WhisperKit.download starting")
_ = try await WhisperKit.download(
variant: modelName,
downloadBase: self.modelsBaseURL,
progressCallback: { [weak self] progress in
Task { @MainActor in
guard let self else { return }
let fraction = progress.fractionCompleted
let decile = min(10, Int(fraction * 10.0001))
if decile > self.whisperKitDownloadLastLoggedDecile || fraction >= 1.0 {
self.whisperKitDownloadLastLoggedDecile = max(self.whisperKitDownloadLastLoggedDecile, decile)
Log.boot.info("WhisperKit.download progress fraction=\(String(format: "%.3f", fraction)) uiMapped=\(String(format: "%.3f", fraction * 0.8))")
}
self.downloadProgress = fraction * 0.8
onProgress?(self.downloadProgress)
}
}
)
Log.boot.info("WhisperKit.download finished elapsed=\(String(format: "%.2fs", CFAbsoluteTimeGetCurrent() - fileDownloadStart))")
Log.model.info("Download complete, prewarming model...")
downloadProgress = 0.85
onProgress?(0.85)
Log.boot.info("Entering prewarm phase (WhisperKitConfig prewarm=true load=false) — UI shows ~85% \"Preparing Model\"")
let prewarmStart = CFAbsoluteTimeGetCurrent()
let config = WhisperKitConfig(
model: modelName,
downloadBase: self.modelsBaseURL,
verbose: false,
logLevel: .none,
prewarm: true,
load: false
)
_ = try await WhisperKit(config)
Log.boot.info("WhisperKit prewarm (init) completed elapsed=\(String(format: "%.2fs", CFAbsoluteTimeGetCurrent() - prewarmStart))")
Log.model.info("Model prewarmed successfully")
downloadProgress = 1.0
onProgress?(1.0)
await refreshDownloadedModels()
Log.boot.info("WhisperKit pipeline success totalElapsed=\(String(format: "%.2fs", CFAbsoluteTimeGetCurrent() - pipelineStart)) downloadedModelsCount=\(downloadedModelNames.count)")
} catch {
downloadProgress = 0.0
let nsError = error as NSError
Log.boot.error(
"WhisperKit pipeline failed after \(String(format: "%.2fs", CFAbsoluteTimeGetCurrent() - pipelineStart)) domain=\(nsError.domain) code=\(nsError.code) description=\(error.localizedDescription)"
)
throw ModelError.downloadFailed(error.localizedDescription)
}
}
private func downloadParakeetModel(named modelName: String, onProgress: ((Double) -> Void)? = nil) async throws {
let pipelineStart = CFAbsoluteTimeGetCurrent()
Log.model.info("Parakeet model download requested: \(modelName)")
Log.model.info("Parakeet models path: \(self.parakeetModelsURL.path)")
Log.boot.info("Parakeet pipeline begin name=\(modelName)")
let version: AsrModelVersion
if modelName.contains("v3") {
version = .v3
} else if modelName.contains("v2") {
version = .v2
} else {
throw ModelError.downloadFailed("Unknown Parakeet model version: \(modelName)")
}
do {
try fileManager.createDirectory(at: parakeetModelsURL, withIntermediateDirectories: true)
Log.boot.info("Parakeet storage directory ready")
} catch {
Log.boot.error("Parakeet mkdir failed: \(error.localizedDescription)")
throw ModelError.downloadFailed("Failed to create Parakeet models directory: \(error.localizedDescription)")
}
downloadProgress = 0.1
onProgress?(0.1)
Log.model.info("Starting Parakeet model download (version: \(version == .v3 ? "v3" : "v2"))")
Log.boot.info("Parakeet AsrModels.downloadAndLoad starting version=\(version == .v3 ? "v3" : "v2")")
do {
let targetDir = parakeetModelsURL.appendingPathComponent(
version == .v3 ? "parakeet-tdt-0.6b-v3-coreml" : "parakeet-tdt-0.6b-v2-coreml",
isDirectory: true
)
downloadProgress = 0.3
onProgress?(0.3)
let fetchStart = CFAbsoluteTimeGetCurrent()
_ = try await AsrModels.downloadAndLoad(to: targetDir, version: version)
Log.boot.info("Parakeet AsrModels.downloadAndLoad finished elapsed=\(String(format: "%.2fs", CFAbsoluteTimeGetCurrent() - fetchStart))")
Log.model.info("Parakeet model download complete")
downloadProgress = 0.9
onProgress?(0.9)
downloadProgress = 1.0
onProgress?(1.0)
await refreshDownloadedModels()
Log.boot.info("Parakeet pipeline success totalElapsed=\(String(format: "%.2fs", CFAbsoluteTimeGetCurrent() - pipelineStart))")
} catch {
downloadProgress = 0.0
let nsError = error as NSError
Log.boot.error("Parakeet pipeline failed domain=\(nsError.domain) code=\(nsError.code) description=\(error.localizedDescription)")
Log.model.error("Parakeet model download failed: \(error.localizedDescription)")
throw ModelError.downloadFailed(error.localizedDescription)
}
}
func deleteModel(named modelName: String) async throws {
#if canImport(PindropSharedTranscription)
try await localRuntimeBridge.deleteModel(named: modelName)
await refreshDownloadedModels()
return
#else
try await deleteModelArtifacts(named: modelName)
await refreshDownloadedModels()
#endif
}
func deleteModelArtifacts(named modelName: String) async throws {
guard let model = availableModels.first(where: { $0.name == modelName }) else {
throw ModelError.modelNotFound(modelName)
}
guard let modelPath = localModelPath(for: model) else {
throw ModelError.deleteFailed("Model \(modelName) is not stored locally")
}
guard fileManager.fileExists(atPath: modelPath.path) else {
throw ModelError.modelNotFound(modelName)
}
do {
try fileManager.removeItem(at: modelPath)
} catch {
throw ModelError.deleteFailed(error.localizedDescription)
}
}
// MARK: - Feature Models
func isFeatureModelDownloaded(_ type: FeatureModelType) -> Bool {
downloadedFeatureModels.contains(type)
}
func refreshDownloadedFeatureModels() async {
var downloaded: Set<FeatureModelType> = []
for type in FeatureModelType.allCases {
let repoFolder = fluidAudioModelsURL.appendingPathComponent(type.repoFolderName)
var isDirectory: ObjCBool = false
if fileManager.fileExists(atPath: repoFolder.path, isDirectory: &isDirectory),
isDirectory.boolValue {
downloaded.insert(type)
}
}
if downloaded != downloadedFeatureModels {
Log.model.debug("Found \(downloaded.count) downloaded feature models: \(downloaded)")
}
downloadedFeatureModels = downloaded
}
func downloadFeatureModel(
_ type: FeatureModelType,
onProgress: ((Double) -> Void)? = nil
) async throws {
guard !isDownloadingFeature else {
throw ModelError.downloadFailed("Another feature download is in progress")
}
isDownloadingFeature = true
currentDownloadingFeature = type
featureDownloadProgress = 0.0
defer {
isDownloadingFeature = false
currentDownloadingFeature = nil
}
Log.model.info("Downloading feature model: \(type.displayName)")
do {
switch type {
case .vad:
featureDownloadProgress = 0.1
onProgress?(0.1)
let _ = try await VadManager(config: .default)
case .diarization:
featureDownloadProgress = 0.1
onProgress?(0.1)
let _ = try await DiarizerModels.download()
case .streaming:
featureDownloadProgress = 0.1
onProgress?(0.1)
featureDownloadProgress = 0.3
onProgress?(0.3)
try await DownloadUtils.downloadRepo(
.parakeetEou160,
to: fluidAudioModelsURL
)
}
featureDownloadProgress = 1.0
onProgress?(1.0)
Log.model.info("Feature model download complete: \(type.displayName)")
await refreshDownloadedFeatureModels()
} catch {
featureDownloadProgress = 0.0
Log.model.error("Feature model download failed: \(error.localizedDescription)")
throw ModelError.downloadFailed(error.localizedDescription)
}
}
}
extension ModelManager: ModelCatalogProviding {}