ย้ายข้อมูลจาก API รูปแบบที่กำหนดเองเดิม

ไลบรารี Firebase/MLModelInterpreter เวอร์ชัน 0.20.0 เปิดตัววิธี getLatestModelFilePath() ใหม่ ซึ่งจะรับตําแหน่งในอุปกรณ์ของรูปแบบที่กําหนดเอง คุณสามารถใช้เมธอดนี้เพื่อสร้างอินสแตนซ์ของออบเจ็กต์ TensorFlow LiteInterpreter โดยตรง ซึ่งจะใช้แทน ModelInterpreter wrapper ของ Firebase ได้

นับจากนี้ไป เราขอแนะนำให้ใช้แนวทางนี้ เนื่องจากเวอร์ชันโปรแกรมล่าม TensorFlow Lite ไม่ได้เชื่อมโยงกับเวอร์ชันไลบรารี Firebase อีกต่อไป คุณจึงมีความยืดหยุ่นมากขึ้นในการอัปเกรดเป็น TensorFlow Lite เวอร์ชันใหม่เมื่อต้องการ หรือใช้บิลด์ TensorFlow Lite ที่กําหนดเองได้ง่ายขึ้น

หน้านี้แสดงวิธีย้ายข้อมูลจากการใช้ ModelInterpreter ไปใช้ TensorFlow Lite Interpreter

1. อัปเดตทรัพยากร Dependency ของโปรเจ็กต์

อัปเดต Podfile ของโปรเจ็กต์ให้รวมไลบรารี Firebase/MLModelInterpreter เวอร์ชัน 0.20.0 (หรือใหม่กว่า) และไลบรารี TensorFlow Lite ดังนี้

ก่อน

Swift

pod 'Firebase/MLModelInterpreter', '0.19.0'

Objective-C

pod 'Firebase/MLModelInterpreter', '0.19.0'

หลัง

Swift

pod 'Firebase/MLModelInterpreter', '~> 0.20.0'
pod 'TensorFlowLiteSwift'

Objective-C

pod 'Firebase/MLModelInterpreter', '~> 0.20.0'
pod 'TensorFlowLiteObjC'

2. สร้างโปรแกรมตีความ TensorFlow Lite แทน Firebase ModelInterpreter

แทนที่จะสร้าง Firebase ModelInterpreter ให้รับตําแหน่งของโมเดลในอุปกรณ์ด้วย getLatestModelFilePath() และใช้เพื่อสร้าง TensorFlow Lite Interpreter

ก่อน

Swift

let remoteModel = CustomRemoteModel(
    name: "your_remote_model"  // The name you assigned in the Firebase console.
)
interpreter = ModelInterpreter.modelInterpreter(remoteModel: remoteModel)

Objective-C

// Initialize using the name you assigned in the Firebase console.
FIRCustomRemoteModel *remoteModel =
        [[FIRCustomRemoteModel alloc] initWithName:@"your_remote_model"];
interpreter = [FIRModelInterpreter modelInterpreterForRemoteModel:remoteModel];

หลัง

Swift

let remoteModel = CustomRemoteModel(
    name: "your_remote_model"  // The name you assigned in the Firebase console.
)
ModelManager.modelManager().getLatestModelFilePath(remoteModel) { (remoteModelPath, error) in
    guard error == nil, let remoteModelPath = remoteModelPath else { return }
    do {
        interpreter = try Interpreter(modelPath: remoteModelPath)
    } catch {
        // Error?
    }
}

Objective-C

FIRCustomRemoteModel *remoteModel =
        [[FIRCustomRemoteModel alloc] initWithName:@"your_remote_model"];
[[FIRModelManager modelManager] getLatestModelFilePath:remoteModel
                                            completion:^(NSString * _Nullable filePath,
                                                         NSError * _Nullable error) {
    if (error != nil || filePath == nil) { return; }

    NSError *tfError = nil;
    interpreter = [[TFLInterpreter alloc] initWithModelPath:filePath error:&tfError];
}];

3. อัปเดตโค้ดการเตรียมอินพุตและเอาต์พุต

เมื่อใช้ ModelInterpreter คุณจะระบุรูปแบบอินพุตและเอาต์พุตของโมเดลได้ด้วยการส่งออบเจ็กต์ ModelInputOutputOptions ไปยังโปรแกรมแปลเมื่อเรียกใช้

สําหรับโปรแกรมแปลภาษา TensorFlow Lite คุณจะเรียกใช้ allocateTensors() เพื่อจัดสรรพื้นที่สําหรับอินพุตและเอาต์พุตของโมเดลแทน จากนั้นคัดลอกข้อมูลอินพุตไปยังเทนเซอร์อินพุต

เช่น หากโมเดลของคุณมีรูปร่างอินพุตเป็นค่า float [1 224 224 3] และรูปร่างเอาต์พุตเป็นค่า float [1 1000] ให้ทําการเปลี่ยนแปลงต่อไปนี้

ก่อน

Swift

let ioOptions = ModelInputOutputOptions()
do {
    try ioOptions.setInputFormat(
        index: 0,
        type: .float32,
        dimensions: [1, 224, 224, 3]
    )
    try ioOptions.setOutputFormat(
        index: 0,
        type: .float32,
        dimensions: [1, 1000]
    )
} catch let error as NSError {
    print("Failed to set input or output format with error: \(error.localizedDescription)")
}

let inputs = ModelInputs()
do {
    let inputData = Data()
    // Then populate with input data.

    try inputs.addInput(inputData)
} catch let error {
    print("Failed to add input: \(error)")
}

interpreter.run(inputs: inputs, options: ioOptions) { outputs, error in
    guard error == nil, let outputs = outputs else { return }
    // Process outputs
    // ...
}

Objective-C

FIRModelInputOutputOptions *ioOptions = [[FIRModelInputOutputOptions alloc] init];
NSError *error;
[ioOptions setInputFormatForIndex:0
                             type:FIRModelElementTypeFloat32
                       dimensions:@[@1, @224, @224, @3]
                            error:&error];
if (error != nil) { return; }
[ioOptions setOutputFormatForIndex:0
                              type:FIRModelElementTypeFloat32
                        dimensions:@[@1, @1000]
                             error:&error];
if (error != nil) { return; }

FIRModelInputs *inputs = [[FIRModelInputs alloc] init];
NSMutableData *inputData = [[NSMutableData alloc] initWithCapacity:0];
// Then populate with input data.

[inputs addInput:inputData error:&error];
if (error != nil) { return; }

[interpreter runWithInputs:inputs
                   options:ioOptions
                completion:^(FIRModelOutputs * _Nullable outputs,
                             NSError * _Nullable error) {
  if (error != nil || outputs == nil) {
    return;
  }
  // Process outputs
  // ...
}];

หลัง

Swift

do {
    try interpreter.allocateTensors()

    let inputData = Data()
    // Then populate with input data.

    try interpreter.copy(inputData, toInputAt: 0)

    try interpreter.invoke()
} catch let err {
    print(err.localizedDescription)
}

Objective-C

NSError *error = nil;

[interpreter allocateTensorsWithError:&error];
if (error != nil) { return; }

TFLTensor *input = [interpreter inputTensorAtIndex:0 error:&error];
if (error != nil) { return; }

NSMutableData *inputData = [[NSMutableData alloc] initWithCapacity:0];
// Then populate with input data.

[input copyData:inputData error:&error];
if (error != nil) { return; }

[interpreter invokeWithError:&error];
if (error != nil) { return; }

4. อัปเดตโค้ดการจัดการเอาต์พุต

สุดท้าย ให้รับ Tensor เอาต์พุตจากโปรแกรมแปลภาษาและแปลงข้อมูลเป็นโครงสร้างที่สะดวกสำหรับกรณีการใช้งานของคุณแทนการรับเอาต์พุตของโมเดลด้วยเมธอด ModelOutputs ของออบเจ็กต์ output()

เช่น หากทําการจัดประเภท คุณอาจทําการเปลี่ยนแปลงต่อไปนี้

ก่อน

Swift

let output = try? outputs.output(index: 0) as? [[NSNumber]]
let probabilities = output?[0]

guard let labelPath = Bundle.main.path(
    forResource: "custom_labels",
    ofType: "txt"
) else { return }
let fileContents = try? String(contentsOfFile: labelPath)
guard let labels = fileContents?.components(separatedBy: "\n") else { return }

for i in 0 ..< labels.count {
    if let probability = probabilities?[i] {
        print("\(labels[i]): \(probability)")
    }
}

Objective-C

// Get first and only output of inference with a batch size of 1
NSError *error;
NSArray *probabilites = [outputs outputAtIndex:0 error:&error][0];
if (error != nil) { return; }

NSString *labelPath = [NSBundle.mainBundle pathForResource:@"retrained_labels"
                                                    ofType:@"txt"];
NSString *fileContents = [NSString stringWithContentsOfFile:labelPath
                                                   encoding:NSUTF8StringEncoding
                                                      error:&error];
if (error != nil || fileContents == NULL) { return; }
NSArray<NSString *> *labels = [fileContents componentsSeparatedByString:@"\n"];
for (int i = 0; i < labels.count; i++) {
    NSString *label = labels[i];
    NSNumber *probability = probabilites[i];
    NSLog(@"%@: %f", label, probability.floatValue);
}

หลัง

Swift

do {
    // After calling interpreter.invoke():
    let output = try interpreter.output(at: 0)
    let probabilities =
            UnsafeMutableBufferPointer<Float32>.allocate(capacity: 1000)
    output.data.copyBytes(to: probabilities)

    guard let labelPath = Bundle.main.path(
        forResource: "custom_labels",
        ofType: "txt"
    ) else { return }
    let fileContents = try? String(contentsOfFile: labelPath)
    guard let labels = fileContents?.components(separatedBy: "\n") else { return }

    for i in labels.indices {
        print("\(labels[i]): \(probabilities[i])")
    }
} catch let err {
    print(err.localizedDescription)
}

Objective-C

NSError *error = nil;

TFLTensor *output = [interpreter outputTensorAtIndex:0 error:&error];
if (error != nil) { return; }

NSData *outputData = [output dataWithError:&error];
if (error != nil) { return; }

Float32 probabilities[outputData.length / 4];
[outputData getBytes:&probabilities length:outputData.length];

NSString *labelPath = [NSBundle.mainBundle pathForResource:@"custom_labels"
                                                    ofType:@"txt"];
NSString *fileContents = [NSString stringWithContentsOfFile:labelPath
                                                   encoding:NSUTF8StringEncoding
                                                      error:&error];
if (error != nil || fileContents == nil) { return; }

NSArray<NSString *> *labels = [fileContents componentsSeparatedByString:@"\n"];
for (int i = 0; i < labels.count; i++) {
    NSLog(@"%@: %f", labels[i], probabilities[i]);
}