الترحيل من واجهة برمجة التطبيقات للنموذج المخصص القديم

يقدم الإصدار 22.0.2 من مكتبة firebase-ml-model-interpreter طريقة getLatestModelFile() جديدة، والتي تحصل على موقع النماذج المخصصة على الجهاز. يمكنك استخدام هذه الطريقة لإنشاء كائن TensorFlow Lite Interpreter مباشرةً، والذي يمكنك استخدامه بدلاً من غلاف FirebaseModelInterpreter .

للمضي قدمًا، هذا هو النهج المفضل. نظرًا لأن إصدار المترجم TensorFlow Lite لم يعد مقترنًا بإصدار مكتبة Firebase، فلديك مرونة أكبر للترقية إلى الإصدارات الجديدة من TensorFlow Lite عندما تريد، أو استخدام إصدارات TensorFlow Lite المخصصة بسهولة أكبر.

توضح هذه الصفحة كيف يمكنك الترحيل من استخدام FirebaseModelInterpreter إلى TensorFlow Lite Interpreter .

1. تحديث تبعيات المشروع

قم بتحديث تبعيات مشروعك لتشمل الإصدار 22.0.2 من مكتبة firebase-ml-model-interpreter (أو الأحدث) ومكتبة tensorflow-lite :

قبل

implementation("com.google.firebase:firebase-ml-model-interpreter:22.0.1")

بعد

implementation("com.google.firebase:firebase-ml-model-interpreter:22.0.2")
implementation("org.tensorflow:tensorflow-lite:2.0.0")

2. قم بإنشاء مترجم TensorFlow Lite بدلاً من FirebaseModelInterpreter

بدلاً من إنشاء FirebaseModelInterpreter ، احصل على موقع النموذج على الجهاز باستخدام getLatestModelFile() واستخدمه لإنشاء TensorFlow Lite Interpreter .

قبل

Kotlin+KTX

val remoteModel = FirebaseCustomRemoteModel.Builder("your_model").build()
val options = FirebaseModelInterpreterOptions.Builder(remoteModel).build()
val interpreter = FirebaseModelInterpreter.getInstance(options)

Java

FirebaseCustomRemoteModel remoteModel =
        new FirebaseCustomRemoteModel.Builder("your_model").build();
FirebaseModelInterpreterOptions options =
        new FirebaseModelInterpreterOptions.Builder(remoteModel).build();
FirebaseModelInterpreter interpreter = FirebaseModelInterpreter.getInstance(options);

بعد

Kotlin+KTX

val remoteModel = FirebaseCustomRemoteModel.Builder("your_model").build()
FirebaseModelManager.getInstance().getLatestModelFile(remoteModel)
    .addOnCompleteListener { task ->
        val modelFile = task.getResult()
        if (modelFile != null) {
            // Instantiate an org.tensorflow.lite.Interpreter object.
            interpreter = Interpreter(modelFile)
        }
    }

Java

FirebaseCustomRemoteModel remoteModel =
        new FirebaseCustomRemoteModel.Builder("your_model").build();
FirebaseModelManager.getInstance().getLatestModelFile(remoteModel)
        .addOnCompleteListener(new OnCompleteListener<File>() {
            @Override
            public void onComplete(@NonNull Task<File> task) {
                File modelFile = task.getResult();
                if (modelFile != null) {
                    // Instantiate an org.tensorflow.lite.Interpreter object.
                    Interpreter interpreter = new Interpreter(modelFile);
                }
            }
        });

3. تحديث كود إعداد الإدخال والإخراج

باستخدام FirebaseModelInterpreter ، يمكنك تحديد أشكال إدخال وإخراج النموذج عن طريق تمرير كائن FirebaseModelInputOutputOptions إلى المترجم عند تشغيله.

بالنسبة لمترجم TensorFlow Lite، يمكنك بدلاً من ذلك تخصيص كائنات ByteBuffer بالحجم المناسب لإدخال وإخراج النموذج الخاص بك.

على سبيل المثال، إذا كان النموذج الخاص بك يحتوي على شكل إدخال لقيم float [1 224 224 3] وشكل إخراج لقيم float [1 1000]، فقم بإجراء هذه التغييرات:

قبل

Kotlin+KTX

val inputOutputOptions = FirebaseModelInputOutputOptions.Builder()
    .setInputFormat(0, FirebaseModelDataType.FLOAT32, intArrayOf(1, 224, 224, 3))
    .setOutputFormat(0, FirebaseModelDataType.FLOAT32, intArrayOf(1, 1000))
    .build()

val input = ByteBuffer.allocateDirect(224*224*3*4).order(ByteOrder.nativeOrder())
// Then populate with input data.

val inputs = FirebaseModelInputs.Builder()
    .add(input)
    .build()

interpreter.run(inputs, inputOutputOptions)
    .addOnSuccessListener { outputs ->
        // ...
    }
    .addOnFailureListener {
        // Task failed with an exception.
        // ...
    }

Java

FirebaseModelInputOutputOptions inputOutputOptions =
        new FirebaseModelInputOutputOptions.Builder()
                .setInputFormat(0, FirebaseModelDataType.FLOAT32, new int[]{1, 224, 224, 3})
                .setOutputFormat(0, FirebaseModelDataType.FLOAT32, new int[]{1, 1000})
                .build();

float[][][][] input = new float[1][224][224][3];
// Then populate with input data.

FirebaseModelInputs inputs = new FirebaseModelInputs.Builder()
        .add(input)
        .build();

interpreter.run(inputs, inputOutputOptions)
        .addOnSuccessListener(
                new OnSuccessListener<FirebaseModelOutputs>() {
                    @Override
                    public void onSuccess(FirebaseModelOutputs result) {
                        // ...
                    }
                })
        .addOnFailureListener(
                new OnFailureListener() {
                    @Override
                    public void onFailure(@NonNull Exception e) {
                        // Task failed with an exception
                        // ...
                    }
                });

بعد

Kotlin+KTX

val inBufferSize = 1 * 224 * 224 * 3 * java.lang.Float.SIZE / java.lang.Byte.SIZE
val inputBuffer = ByteBuffer.allocateDirect(inBufferSize).order(ByteOrder.nativeOrder())
// Then populate with input data.

val outBufferSize = 1 * 1000 * java.lang.Float.SIZE / java.lang.Byte.SIZE
val outputBuffer = ByteBuffer.allocateDirect(outBufferSize).order(ByteOrder.nativeOrder())

interpreter.run(inputBuffer, outputBuffer)

Java

int inBufferSize = 1 * 224 * 224 * 3 * java.lang.Float.SIZE / java.lang.Byte.SIZE;
ByteBuffer inputBuffer =
        ByteBuffer.allocateDirect(inBufferSize).order(ByteOrder.nativeOrder());
// Then populate with input data.

int outBufferSize = 1 * 1000 * java.lang.Float.SIZE / java.lang.Byte.SIZE;
ByteBuffer outputBuffer =
        ByteBuffer.allocateDirect(outBufferSize).order(ByteOrder.nativeOrder());

interpreter.run(inputBuffer, outputBuffer);

4. تحديث رمز معالجة الإخراج

أخيرًا، بدلاً من الحصول على مخرجات النموذج باستخدام طريقة getOutput() الخاصة بكائن FirebaseModelOutputs ، قم بتحويل مخرجات ByteBuffer إلى أي بنية مناسبة لحالة الاستخدام الخاصة بك.

على سبيل المثال، إذا كنت تقوم بالتصنيف، فيمكنك إجراء تغييرات مثل ما يلي:

قبل

Kotlin+KTX

val output = result.getOutput(0)
val probabilities = output[0]
try {
    val reader = BufferedReader(InputStreamReader(assets.open("custom_labels.txt")))
    for (probability in probabilities) {
        val label: String = reader.readLine()
        println("$label: $probability")
    }
} catch (e: IOException) {
    // File not found?
}

Java

float[][] output = result.getOutput(0);
float[] probabilities = output[0];
try {
    BufferedReader reader = new BufferedReader(
          new InputStreamReader(getAssets().open("custom_labels.txt")));
    for (float probability : probabilities) {
        String label = reader.readLine();
        Log.i(TAG, String.format("%s: %1.4f", label, probability));
    }
} catch (IOException e) {
    // File not found?
}

بعد

Kotlin+KTX

modelOutput.rewind()
val probabilities = modelOutput.asFloatBuffer()
try {
    val reader = BufferedReader(
            InputStreamReader(assets.open("custom_labels.txt")))
    for (i in probabilities.capacity()) {
        val label: String = reader.readLine()
        val probability = probabilities.get(i)
        println("$label: $probability")
    }
} catch (e: IOException) {
    // File not found?
}

Java

modelOutput.rewind();
FloatBuffer probabilities = modelOutput.asFloatBuffer();
try {
    BufferedReader reader = new BufferedReader(
            new InputStreamReader(getAssets().open("custom_labels.txt")));
    for (int i = 0; i < probabilities.capacity(); i++) {
        String label = reader.readLine();
        float probability = probabilities.get(i);
        Log.i(TAG, String.format("%s: %1.4f", label, probability));
    }
} catch (IOException e) {
    // File not found?
}