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

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

قبل

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?
}