สร้าง Task API ของคุณเอง

เช่นเดียวกับ API แบบเนทีฟ ในการสร้างออบเจ็กต์ API ไคลเอ็นต์จะต้องระบุ ดังต่อไปนี้โดยขยาย BaseTaskApi ซึ่งให้การจัดการ JNI สำหรับ Java Task API ทั้งหมด

• กำหนด API I/O - โดยปกติจะมิเรอร์อินเทอร์เฟซแบบเนทีฟ เช่น BertQuestionAnswerer ใช้เวลา (String context, String question) เป็นอินพุต และเอาต์พุต List<QaAnswer> การนำไปใช้จะเรียกโฆษณาเนทีฟส่วนตัว ที่มีลายเซ็นคล้ายกัน เพียงแต่มีพารามิเตอร์เพิ่มเติม long nativeHandle ซึ่งเป็นตัวชี้ที่ส่งคืนจาก C++

  class BertQuestionAnswerer extends BaseTaskApi {
    public List<QaAnswer> answer(String context, String question) {
      return answerNative(getNativeHandle(), context, question);
    }
  
    private static native List<QaAnswer> answerNative(
                                          long nativeHandle, // C++ pointer
                                          String context, String question // API I/O
                                         );
  
  }
  

• สร้างฟังก์ชันจากโรงงานของ API - มิเรอร์จากโรงงานโดยตรงด้วย ฟังก์ชัน ยกเว้นฟังก์ชันจากโรงงานของ Android จะต้องดำเนินการ Context สำหรับการเข้าถึงไฟล์ การนำไปใช้นี้เรียกหนึ่งในยูทิลิตีใน TaskJniUtils เพื่อสร้างออบเจ็กต์ C++ API ที่เกี่ยวข้องและส่งตัวชี้ไปยัง เครื่องมือสร้าง BaseTaskApi

    class BertQuestionAnswerer extends BaseTaskApi {
      private static final String BERT_QUESTION_ANSWERER_NATIVE_LIBNAME =
                                                "bert_question_answerer_jni";
  
      // Extending super constructor by providing the
      // native handle(pointer of corresponding C++ API object)
      private BertQuestionAnswerer(long nativeHandle) {
        super(nativeHandle);
      }
  
      public static BertQuestionAnswerer createBertQuestionAnswerer(
                                          Context context, // Accessing Android files
                                          String pathToModel, String pathToVocab) {
        return new BertQuestionAnswerer(
            // The util first try loads the JNI module with name
            // BERT_QUESTION_ANSWERER_NATIVE_LIBNAME, then opens two files,
            // converts them into ByteBuffer, finally ::initJniWithBertByteBuffers
            // is called with the buffer for a C++ API object pointer
            TaskJniUtils.createHandleWithMultipleAssetFilesFromLibrary(
                context,
                BertQuestionAnswerer::initJniWithBertByteBuffers,
                BERT_QUESTION_ANSWERER_NATIVE_LIBNAME,
                pathToModel,
                pathToVocab));
      }
  
      // modelBuffers[0] is tflite model file buffer, and modelBuffers[1] is vocab file buffer.
      // returns C++ API object pointer casted to long
      private static native long initJniWithBertByteBuffers(ByteBuffer... modelBuffers);
  
    }
  

• ใช้โมดูล JNI สำหรับฟังก์ชันเนทีฟ - วิธีเนทีฟของ Java ทั้งหมด ดำเนินการโดยการเรียกใช้ฟังก์ชันเนทีฟที่เกี่ยวข้องจาก JNI ฟังก์ชันจากโรงงานจะสร้างออบเจ็กต์ API แบบเนทีฟและส่งกลับ ตัวชี้เป็นชนิดยาวไปยัง Java ในการเรียกไปยัง Java API ภายหลัง ระบบจะใช้เวลา ระบบจะส่งตัวชี้ประเภทกลับไปยัง JNI และแคสต์กลับไปยังออบเจ็กต์ API แบบดั้งเดิม ผลลัพธ์ของ API แบบดั้งเดิมจะถูกแปลงกลับไปเป็นผลลัพธ์ของ Java

  ตัวอย่างเช่น นี่คือลักษณะ bert_question_answerer_jni มีการนำไปใช้

    // Implements BertQuestionAnswerer::initJniWithBertByteBuffers
    extern "C" JNIEXPORT jlong JNICALL
    Java_org_tensorflow_lite_task_text_qa_BertQuestionAnswerer_initJniWithBertByteBuffers(
        JNIEnv* env, jclass thiz, jobjectArray model_buffers) {
      // Convert Java ByteBuffer object into a buffer that can be read by native factory functions
      absl::string_view model =
          GetMappedFileBuffer(env, env->GetObjectArrayElement(model_buffers, 0));
  
      // Creates the native API object
      absl::StatusOr<std::unique_ptr<QuestionAnswerer>> status =
          BertQuestionAnswerer::CreateFromBuffer(
              model.data(), model.size());
      if (status.ok()) {
        // converts the object pointer to jlong and return to Java.
        return reinterpret_cast<jlong>(status->release());
      } else {
        return kInvalidPointer;
      }
    }
  
    // Implements BertQuestionAnswerer::answerNative
    extern "C" JNIEXPORT jobject JNICALL
    Java_org_tensorflow_lite_task_text_qa_BertQuestionAnswerer_answerNative(
    JNIEnv* env, jclass thiz, jlong native_handle, jstring context, jstring question) {
    // Convert long to native API object pointer
    QuestionAnswerer* question_answerer = reinterpret_cast<QuestionAnswerer*>(native_handle);
  
    // Calls the native API
    std::vector<QaAnswer> results = question_answerer->Answer(JStringToString(env, context),
                                           JStringToString(env, question));
  
    // Converts native result(std::vector<QaAnswer>) to Java result(List<QaAnswerer>)
    jclass qa_answer_class =
      env->FindClass("org/tensorflow/lite/task/text/qa/QaAnswer");
    jmethodID qa_answer_ctor =
      env->GetMethodID(qa_answer_class, "<init>", "(Ljava/lang/String;IIF)V");
    return ConvertVectorToArrayList<QaAnswer>(
      env, results,
      [env, qa_answer_class, qa_answer_ctor](const QaAnswer& ans) {
        jstring text = env->NewStringUTF(ans.text.data());
        jobject qa_answer =
            env->NewObject(qa_answer_class, qa_answer_ctor, text, ans.pos.start,
                           ans.pos.end, ans.pos.logit);
        env->DeleteLocalRef(text);
        return qa_answer;
      });
    }
  
    // Implements BaseTaskApi::deinitJni by delete the native object
    extern "C" JNIEXPORT void JNICALL Java_task_core_BaseTaskApi_deinitJni(
        JNIEnv* env, jobject thiz, jlong native_handle) {
      delete reinterpret_cast<QuestionAnswerer*>(native_handle);
    }
  

API ของ iOS

สร้าง iOS API โดยการรวมออบเจ็กต์ API แบบเนทีฟไว้ในออบเจ็กต์ ObjC API ออบเจ็กต์ API ที่สร้างขึ้นสามารถใช้ใน ObjC หรือ Swift iOS API จำเป็นต้องมี API แบบเนทีฟที่สร้างขึ้นก่อน

ตัวอย่างการใช้งาน

นี่คือตัวอย่างการใช้ ObjC TFLBertQuestionAnswerer สำหรับ MobileBert ใน Swift

  static let mobileBertModelPath = "path/to/model.tflite";
  // Create the API from a model file and vocabulary file
  let mobileBertAnswerer = TFLBertQuestionAnswerer.mobilebertQuestionAnswerer(
      modelPath: mobileBertModelPath)

  static let context = ...; // context of a question to be answered
  static let question = ...; // question to be answered
  // ask a question
  let answers = mobileBertAnswerer.answer(
      context: TFLBertQuestionAnswererTest.context, question: TFLBertQuestionAnswererTest.question)
  // answers.[0].text is the best answer

การสร้าง API

รูปที่ 4 iOS Task API

iOS API คือ ObjC Wrapper ที่เรียบง่ายนอกเหนือจาก API แบบเนทีฟ สร้าง API โดย โดยทำตามขั้นตอนด้านล่าง

• กำหนด Wrapper ของ ObjC - กำหนดคลาส ObjC และมอบสิทธิ์ฟังก์ชัน กับออบเจ็กต์ API เนทีฟที่เกี่ยวข้อง โปรดทราบว่าโฆษณาเนทีฟ ทรัพยากร Dependency จะปรากฏในไฟล์ .mm เท่านั้น เนื่องจาก Swift ไม่สามารถ ทำงานร่วมกันด้วย C++

  • ไฟล์ .h

    @interface TFLBertQuestionAnswerer : NSObject
  
    // Delegate calls to the native BertQuestionAnswerer::CreateBertQuestionAnswerer
    + (instancetype)mobilebertQuestionAnswererWithModelPath:(NSString*)modelPath
                                                  vocabPath:(NSString*)vocabPath
        NS_SWIFT_NAME(mobilebertQuestionAnswerer(modelPath:vocabPath:));
  
    // Delegate calls to the native BertQuestionAnswerer::Answer
    - (NSArray<TFLQAAnswer*>*)answerWithContext:(NSString*)context
                                       question:(NSString*)question
        NS_SWIFT_NAME(answer(context:question:));
  }
  

  • ไฟล์ .mm

    using BertQuestionAnswererCPP = ::tflite::task::text::BertQuestionAnswerer;
  
    @implementation TFLBertQuestionAnswerer {
      // define an iVar for the native API object
      std::unique_ptr<QuestionAnswererCPP> _bertQuestionAnswerwer;
    }
  
    // Initialize the native API object
    + (instancetype)mobilebertQuestionAnswererWithModelPath:(NSString *)modelPath
                                            vocabPath:(NSString *)vocabPath {
      absl::StatusOr<std::unique_ptr<QuestionAnswererCPP>> cQuestionAnswerer =
          BertQuestionAnswererCPP::CreateBertQuestionAnswerer(MakeString(modelPath),
                                                              MakeString(vocabPath));
      _GTMDevAssert(cQuestionAnswerer.ok(), @"Failed to create BertQuestionAnswerer");
      return [[TFLBertQuestionAnswerer alloc]
          initWithQuestionAnswerer:std::move(cQuestionAnswerer.value())];
    }
  
    // Calls the native API and converts C++ results into ObjC results
    - (NSArray<TFLQAAnswer *> *)answerWithContext:(NSString *)context question:(NSString *)question {
      std::vector<QaAnswerCPP> results =
        _bertQuestionAnswerwer->Answer(MakeString(context), MakeString(question));
      return [self arrayFromVector:results];
    }
  }