mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-10 22:45:59 +05:45
manjanac
9597ffe51b
* Restores ML Pods after M77. * Fix Package.swift * Re-add catalyst to GHA workflow. * Add tests for list models. * Failable emptying of model directory in tests. * Remove path from local model info and user defaults. * Clean up user defaults on delete + add interpreter to test app. * Replace .absoluteString with .path. This makes model.path work directly with TFLite interpreter. * Fix paths in tests. * Unit test for successful get model. * Rename modelPath to modelURL. * Use defaults.integer instead of casting to Int. * Remove force casting. * Mostly minor fixes that came out of the bugbash (#7462) * Use appropriate errors for network offline and api disabled. * Error + test for resourceExhausted. * Surface backend error message in logs whenever available. * Add disclaimer to empty directories for testing only. * Add Firelog events for model info retrieval. * Add documentation + other minor fixes. (#7465) * Add docs + clean up ModelDownloader.swift. * Add docs + clean up ModelDownloadTask.swift. * Add docs + clean up FileDownloader.swift. * Add docs + clean up LocalModelInfo.swift. Handle TODO for userdefaults init failure. * Add docs + clean up RemoteModelInfo.swift, DownloaderUserDefaults.swift. * Add docs + clean up ModelInfoRetriever.swift. * Add docs + clean up ModelDownloadConditions.swift. * Add docs + clean up DeviceLogger.swift. * Add docs + clean up TelemetryLogger.swift. * Add docs + clean up ModelFileManager.swift. * Remove resolved TODOs + other minor fixes. * Update model download conditions init. * Fix comment formatting. * Minor newline formatting. * Minor comment formatting. * Add docs for ModelDownloadConditions. * Basic fix for user defaults race condition. * Minor updates to tests. * Minor updates to tests. * Final fixes (#7471) * Refactor error parsing in model info response. * Add Firelog for delete event + minor fixes. * Temporary - test to check telemetry for delete event. * Disable backup of model files; handle inability to locate model storage dir. * Minor fixes. * Add tflite path extension to model file.
86 lines
3.1 KiB
Swift
86 lines
3.1 KiB
Swift
// Copyright 2021 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
import Foundation
|
|
|
|
/// Model info object with details about downloaded and locally available model.
|
|
class LocalModelInfo {
|
|
/// Model name.
|
|
let name: String
|
|
|
|
/// Hash of the model, as returned by server.
|
|
let modelHash: String
|
|
|
|
/// Size of the model, as returned by server.
|
|
let size: Int
|
|
|
|
init(name: String, modelHash: String, size: Int) {
|
|
self.name = name
|
|
self.modelHash = modelHash
|
|
self.size = size
|
|
}
|
|
|
|
/// Convenience init to create local model info from remotely downloaded model info.
|
|
convenience init(from remoteModelInfo: RemoteModelInfo) {
|
|
self.init(
|
|
name: remoteModelInfo.name,
|
|
modelHash: remoteModelInfo.modelHash,
|
|
size: remoteModelInfo.size
|
|
)
|
|
}
|
|
|
|
/// Convenience init to create local model info from stored info in user defaults.
|
|
convenience init?(fromDefaults defaults: UserDefaults, name: String, appName: String) {
|
|
let defaultsPrefix = LocalModelInfo.getUserDefaultsKeyPrefix(appName: appName, modelName: name)
|
|
guard let modelHash = defaults.string(forKey: "\(defaultsPrefix).model-hash") else {
|
|
return nil
|
|
}
|
|
let size = defaults.integer(forKey: "\(defaultsPrefix).model-size")
|
|
self.init(name: name, modelHash: modelHash, size: size)
|
|
}
|
|
}
|
|
|
|
/// Extension to write local model info to user defaults.
|
|
extension LocalModelInfo: DownloaderUserDefaultsWriteable {
|
|
// Get user defaults key prefix.
|
|
private static func getUserDefaultsKeyPrefix(appName: String, modelName: String) -> String {
|
|
let bundleID = Bundle.main.bundleIdentifier ?? ""
|
|
return "\(bundleID).\(appName).\(modelName)"
|
|
}
|
|
|
|
/// Write local model info to user defaults.
|
|
func writeToDefaults(_ defaults: UserDefaults, appName: String) {
|
|
let defaultsPrefix = LocalModelInfo.getUserDefaultsKeyPrefix(appName: appName, modelName: name)
|
|
defaults.setValue(modelHash, forKey: "\(defaultsPrefix).model-hash")
|
|
defaults.setValue(size, forKey: "\(defaultsPrefix).model-size")
|
|
}
|
|
|
|
func removeFromDefaults(_ defaults: UserDefaults, appName: String) {
|
|
let defaultsPrefix = LocalModelInfo.getUserDefaultsKeyPrefix(appName: appName, modelName: name)
|
|
defaults.removeObject(forKey: "\(defaultsPrefix).model-hash")
|
|
defaults.removeObject(forKey: "\(defaultsPrefix).model-size")
|
|
}
|
|
}
|
|
|
|
/// Named user defaults for FirebaseML.
|
|
extension UserDefaults {
|
|
static var firebaseMLDefaults: UserDefaults {
|
|
let suiteName = "com.google.firebase.ml"
|
|
guard let defaults = UserDefaults(suiteName: suiteName) else {
|
|
return UserDefaults.standard
|
|
}
|
|
return defaults
|
|
}
|
|
}
|