-
Notifications
You must be signed in to change notification settings - Fork 243
Expand file tree
/
Copy pathAsrModelsTests.swift
More file actions
413 lines (321 loc) · 15.3 KB
/
AsrModelsTests.swift
File metadata and controls
413 lines (321 loc) · 15.3 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
@preconcurrency import CoreML
import Foundation
import XCTest
@testable import FluidAudio
final class AsrModelsTests: XCTestCase {
// MARK: - Model Names Tests
func testModelNames() {
XCTAssertEqual(ModelNames.ASR.preprocessorFile, "Preprocessor.mlmodelc")
XCTAssertEqual(ModelNames.ASR.encoderFile, "Encoder.mlmodelc")
XCTAssertEqual(ModelNames.ASR.decoderFile, "Decoder.mlmodelc")
XCTAssertEqual(ModelNames.ASR.jointFile, "JointDecision.mlmodelc")
XCTAssertEqual(ModelNames.ASR.vocabulary(for: .parakeet), "parakeet_vocab.json")
XCTAssertEqual(ModelNames.ASR.vocabulary(for: .parakeetV2), "parakeet_vocab.json")
}
// MARK: - Configuration Tests
func testDefaultConfiguration() {
let config = AsrModels.defaultConfiguration()
XCTAssertTrue(config.allowLowPrecisionAccumulationOnGPU)
// Should always use CPU+ANE for optimal performance
XCTAssertEqual(config.computeUnits, .cpuAndNeuralEngine)
}
// MARK: - Directory Tests
func testDefaultCacheDirectory() {
let cacheDir = AsrModels.defaultCacheDirectory()
// Verify path components
XCTAssertTrue(cacheDir.path.contains("FluidAudio"))
XCTAssertTrue(cacheDir.path.contains("Models"))
XCTAssertTrue(cacheDir.path.contains(Repo.parakeet.folderName))
// Verify it's an absolute path
XCTAssertTrue(cacheDir.isFileURL)
XCTAssertTrue(cacheDir.path.starts(with: "/"))
}
// MARK: - Model Existence Tests
func testModelsExistWithMissingFiles() {
let tempDir = FileManager.default.temporaryDirectory
.appendingPathComponent("AsrModelsTests-\(UUID().uuidString)")
// Test with non-existent directory - should return false
let result = AsrModels.modelsExist(at: tempDir)
// We're just testing the method doesn't crash with non-existent paths
XCTAssertNotNil(result) // Method returns a boolean
}
func testModelsExistLogic() {
// Test that the method handles various scenarios without crashing
let tempDir = FileManager.default.temporaryDirectory
.appendingPathComponent("AsrModelsTests-\(UUID().uuidString)")
// Test 1: Non-existent directory
_ = AsrModels.modelsExist(at: tempDir)
// Test 2: The method should check for model files in the expected structure
// We're testing the logic, not the actual file system operations
let modelNames: [String] = [
ModelNames.ASR.preprocessorFile,
ModelNames.ASR.encoderFile,
ModelNames.ASR.decoderFile,
ModelNames.ASR.jointFile,
ModelNames.ASR.vocabulary(for: .parakeet),
]
// Verify all expected model names are defined
XCTAssertEqual(modelNames.count, 5)
XCTAssertTrue(modelNames.allSatisfy { !$0.isEmpty })
}
// MARK: - Error Tests
func testAsrModelsErrorDescriptions() {
let modelNotFound = AsrModelsError.modelNotFound(
"test.mlmodel", URL(fileURLWithPath: "/test/path"))
XCTAssertEqual(
modelNotFound.errorDescription, "ASR model 'test.mlmodel' not found at: /test/path")
let downloadFailed = AsrModelsError.downloadFailed("Network error")
XCTAssertEqual(
downloadFailed.errorDescription, "Failed to download ASR models: Network error")
let loadingFailed = AsrModelsError.loadingFailed("Invalid format")
XCTAssertEqual(loadingFailed.errorDescription, "Failed to load ASR models: Invalid format")
let compilationFailed = AsrModelsError.modelCompilationFailed("Compilation error")
XCTAssertEqual(
compilationFailed.errorDescription,
"Failed to compile ASR models: Compilation error. Try deleting the models and re-downloading."
)
}
// MARK: - Model Initialization Tests
func testAsrModelsInitialization() throws {
// Create mock models
let mockConfig = MLModelConfiguration()
mockConfig.computeUnits = .cpuOnly
// Note: We can't create actual MLModel instances in tests without valid model files
// This test verifies the AsrModels struct initialization logic
// Test that AsrModels struct can be created with proper types
let modelNames = [
ModelNames.ASR.preprocessorFile,
ModelNames.ASR.encoderFile,
ModelNames.ASR.decoderFile,
ModelNames.ASR.jointFile,
]
XCTAssertEqual(modelNames.count, 4)
XCTAssertTrue(modelNames.allSatisfy { $0.hasSuffix(".mlmodelc") })
}
// MARK: - Download Path Tests
func testDownloadPathStructure() async throws {
let customDir = FileManager.default.temporaryDirectory
.appendingPathComponent("AsrModelsTests-Download-\(UUID().uuidString)")
defer { try? FileManager.default.removeItem(at: customDir) }
// Test that download would target correct directory structure
let expectedRepoPath = customDir.deletingLastPathComponent()
.appendingPathComponent(Repo.parakeet.folderName)
// Verify path components
XCTAssertTrue(expectedRepoPath.path.contains(Repo.parakeet.folderName))
}
// MARK: - Model Loading Configuration Tests
func testCustomConfigurationPropagation() {
// Test that custom configuration would be used correctly
let customConfig = MLModelConfiguration()
customConfig.modelDisplayName = "Test ASR Model"
customConfig.computeUnits = .cpuAndNeuralEngine
customConfig.allowLowPrecisionAccumulationOnGPU = false
// Verify configuration properties
XCTAssertEqual(customConfig.modelDisplayName, "Test ASR Model")
XCTAssertEqual(customConfig.computeUnits, .cpuAndNeuralEngine)
XCTAssertFalse(customConfig.allowLowPrecisionAccumulationOnGPU)
}
// MARK: - Force Download Tests
func testForceDownloadLogic() async throws {
let tempDir = FileManager.default.temporaryDirectory
.appendingPathComponent("AsrModelsTests-Force-\(UUID().uuidString)")
defer { try? FileManager.default.removeItem(at: tempDir) }
// Create existing directory
try FileManager.default.createDirectory(at: tempDir, withIntermediateDirectories: true)
// Add a test file
let testFile = tempDir.appendingPathComponent("test.txt")
try "test content".write(to: testFile, atomically: true, encoding: .utf8)
XCTAssertTrue(FileManager.default.fileExists(atPath: testFile.path))
// In actual download with force=true, directory would be removed
// Here we just verify the file exists before theoretical removal
XCTAssertTrue(FileManager.default.fileExists(atPath: tempDir.path))
}
// MARK: - Helper Method Tests
func testRepoPathCalculation() {
let modelsDir = URL(fileURLWithPath: "/test/Models/parakeet-tdt-0.6b-v3-coreml")
let repoPath = modelsDir.deletingLastPathComponent()
.appendingPathComponent(Repo.parakeet.folderName)
XCTAssertTrue(repoPath.path.hasSuffix(Repo.parakeet.folderName))
XCTAssertEqual(repoPath.lastPathComponent, Repo.parakeet.folderName)
}
// MARK: - Integration Test Helpers
func testModelFileValidation() {
// Test model file extension validation
let validModelFiles = [
"model.mlmodelc",
"Model.mlmodelc",
"test_model.mlmodelc",
]
for file in validModelFiles {
XCTAssertTrue(file.hasSuffix(".mlmodelc"), "\(file) should have .mlmodelc extension")
}
// Test vocabulary file
let vocabFile = "parakeet_vocab.json"
XCTAssertTrue(vocabFile.hasSuffix(".json"))
XCTAssertTrue(vocabFile.contains("vocab"))
}
// MARK: - Neural Engine Optimization Tests
func testOptimizedConfiguration() {
// In CI environment, all compute units are overridden to .cpuOnly
let isCI = ProcessInfo.processInfo.environment["CI"] != nil
// Test encoder configuration
let melConfig = AsrModels.optimizedConfiguration(for: .encoder)
if isCI {
XCTAssertEqual(melConfig.computeUnits, .cpuOnly)
} else {
XCTAssertEqual(melConfig.computeUnits, .cpuAndNeuralEngine)
}
XCTAssertTrue(melConfig.allowLowPrecisionAccumulationOnGPU)
// Test decoder configuration
let decoderConfig = AsrModels.optimizedConfiguration(for: .decoder)
if isCI {
XCTAssertEqual(decoderConfig.computeUnits, .cpuOnly)
} else {
XCTAssertEqual(decoderConfig.computeUnits, .cpuAndNeuralEngine)
}
// Test joint configuration
let jointConfig = AsrModels.optimizedConfiguration(for: .joint)
if isCI {
XCTAssertEqual(jointConfig.computeUnits, .cpuOnly)
} else {
XCTAssertEqual(jointConfig.computeUnits, .cpuAndNeuralEngine)
}
// Test with FP16 disabled
let fp32Config = AsrModels.optimizedConfiguration(for: .encoder, enableFP16: false)
XCTAssertFalse(fp32Config.allowLowPrecisionAccumulationOnGPU)
}
func testOptimizedConfigurationCIEnvironment() {
// Simulate CI environment
let originalCI = ProcessInfo.processInfo.environment["CI"]
setenv("CI", "true", 1)
defer {
if let originalCI = originalCI {
setenv("CI", originalCI, 1)
} else {
unsetenv("CI")
}
}
let config = AsrModels.optimizedConfiguration(for: .encoder)
XCTAssertEqual(config.computeUnits, .cpuOnly)
}
func testOptimizedPredictionOptions() {
let options = AsrModels.optimizedPredictionOptions()
XCTAssertNotNil(options)
// Output backings should be configured
XCTAssertNotNil(options.outputBackings)
}
// Removed testLoadWithANEOptimization - causes crashes when trying to load models
// MARK: - User Configuration Tests
func testUserConfigurationIsRespected() {
// Test that when a user provides a configuration, it's respected
let userConfig = MLModelConfiguration()
userConfig.computeUnits = .cpuOnly
userConfig.modelDisplayName = "User Custom Model"
// Verify the configuration properties
XCTAssertEqual(userConfig.computeUnits, .cpuOnly)
XCTAssertEqual(userConfig.modelDisplayName, "User Custom Model")
// The actual load test would require model files, so we test the configuration logic
// The fix ensures that when configuration is not nil, it uses the user's compute units
}
func testPlatformAwareDefaultConfiguration() {
let config = AsrModels.defaultConfiguration()
// Should always use CPU+ANE for optimal performance
XCTAssertEqual(config.computeUnits, .cpuAndNeuralEngine)
}
func testOptimalComputeUnitsRespectsPlatform() {
// Test each model type
let modelTypes: [ANEOptimizer.ModelType] = [
.encoder,
.decoder,
.joint,
]
for modelType in modelTypes {
let computeUnits = ANEOptimizer.optimalComputeUnits(for: modelType)
// All models should use CPU+ANE for optimal performance
XCTAssertEqual(
computeUnits, .cpuAndNeuralEngine,
"Model type \(modelType) should use CPU+ANE")
}
}
// MARK: - TDT-CTC-110M Model Version Tests
func testTdtCtc110mHasFusedEncoder() {
// tdtCtc110m has fused preprocessor+encoder
XCTAssertTrue(AsrModelVersion.tdtCtc110m.hasFusedEncoder)
// v2 and v3 have separate encoder
XCTAssertFalse(AsrModelVersion.v2.hasFusedEncoder)
XCTAssertFalse(AsrModelVersion.v3.hasFusedEncoder)
}
func testTdtCtc110mEncoderHiddenSize() {
// tdtCtc110m uses 512-dim encoder output
XCTAssertEqual(AsrModelVersion.tdtCtc110m.encoderHiddenSize, 512)
// v2 and v3 use 1024-dim encoder output
XCTAssertEqual(AsrModelVersion.v2.encoderHiddenSize, 1024)
XCTAssertEqual(AsrModelVersion.v3.encoderHiddenSize, 1024)
}
func testTdtCtc110mBlankId() {
// tdtCtc110m uses blank ID 1024 (same as v2)
XCTAssertEqual(AsrModelVersion.tdtCtc110m.blankId, 1024)
XCTAssertEqual(AsrModelVersion.v2.blankId, 1024)
// v3 uses blank ID 8192
XCTAssertEqual(AsrModelVersion.v3.blankId, 8192)
}
func testTdtCtc110mDecoderLayers() {
// tdtCtc110m uses 1 decoder LSTM layer
XCTAssertEqual(AsrModelVersion.tdtCtc110m.decoderLayers, 1)
// v2 and v3 use 2 decoder LSTM layers
XCTAssertEqual(AsrModelVersion.v2.decoderLayers, 2)
XCTAssertEqual(AsrModelVersion.v3.decoderLayers, 2)
}
func testTdtCtc110mRepo() {
// Verify correct HuggingFace repo
XCTAssertEqual(AsrModelVersion.tdtCtc110m.repo, .parakeetTdtCtc110m)
XCTAssertEqual(AsrModelVersion.v2.repo, .parakeetV2)
XCTAssertEqual(AsrModelVersion.v3.repo, .parakeet)
}
func testTdtCtc110mUsesSplitFrontend() {
// Create a mock AsrModels instance for tdtCtc110m
// Note: We can't create actual MLModel instances without model files
// So we test the version property directly
// tdtCtc110m has fused frontend (no split)
XCTAssertFalse(AsrModelVersion.tdtCtc110m.hasFusedEncoder == false)
// Test the inverse logic used in usesSplitFrontend
let tdtCtc110mUsesSplit = !AsrModelVersion.tdtCtc110m.hasFusedEncoder
XCTAssertFalse(tdtCtc110mUsesSplit, "tdtCtc110m should not use split frontend")
// v2 and v3 use split frontend
let v2UsesSplit = !AsrModelVersion.v2.hasFusedEncoder
let v3UsesSplit = !AsrModelVersion.v3.hasFusedEncoder
XCTAssertTrue(v2UsesSplit, "v2 should use split frontend")
XCTAssertTrue(v3UsesSplit, "v3 should use split frontend")
}
func testTdtCtc110mDefaultCacheDirectory() {
let cacheDir = AsrModels.defaultCacheDirectory(for: .tdtCtc110m)
// Verify path contains correct repo folder name
XCTAssertTrue(cacheDir.path.contains(Repo.parakeetTdtCtc110m.folderName))
XCTAssertTrue(cacheDir.path.contains("FluidAudio"))
XCTAssertTrue(cacheDir.path.contains("Models"))
// Verify it's an absolute path
XCTAssertTrue(cacheDir.isFileURL)
XCTAssertTrue(cacheDir.path.starts(with: "/"))
}
func testTdtCtc110mVocabularyFilename() {
// tdtCtc110m uses parakeet_vocab.json (array format)
let vocabFile = ModelNames.ASR.vocabularyFileArray
XCTAssertEqual(vocabFile, "parakeet_vocab.json")
// Verify it has .json extension
XCTAssertTrue(vocabFile.hasSuffix(".json"))
XCTAssertTrue(vocabFile.contains("vocab"))
}
func testAllModelVersionsHaveRequiredProperties() {
let versions: [AsrModelVersion] = [.v2, .v3, .tdtCtc110m]
for version in versions {
// All versions should have valid repo
XCTAssertNotNil(version.repo)
// All versions should have positive encoder hidden size
XCTAssertGreaterThan(version.encoderHiddenSize, 0)
// All versions should have positive blank ID
XCTAssertGreaterThan(version.blankId, 0)
// All versions should have at least 1 decoder layer
XCTAssertGreaterThan(version.decoderLayers, 0)
}
}
}