अपना टास्क एपीआई बनाएं

नेटिव एपीआई की तरह ही, एपीआई ऑब्जेक्ट बनाने के लिए, क्लाइंट को नीचे दी गई जानकारी को BaseTaskApi, जो सभी Java टास्क एपीआई के लिए, JNI हैंडलिंग उपलब्ध कराती है.

• एपीआई 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
                                         );
  
  }
  

• एपीआई के फ़ैक्ट्री फ़ंक्शन बनाएं - यह स्थानीय फ़ैक्ट्री की भी जानकारी देता है 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 से संबंधित नेटिव फ़ंक्शन को कॉल करके लागू किया जाता है मॉड्यूल का इस्तेमाल नहीं किया जाएगा. फ़ैक्ट्री फ़ंक्शन, नेटिव एपीआई ऑब्जेक्ट बनाएंगे और लंबे टाइप के रूप में इसका पॉइंटर है. Java API को बाद में की जाने वाली कॉल में, टाइप पॉइंटर को वापस JNI को पास करके, नेटिव एपीआई ऑब्जेक्ट पर वापस कास्ट किया जाता है. इसके बाद, नेटिव एपीआई के नतीजों को वापस 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);
    }
  

iOS एपीआई

नेटिव एपीआई ऑब्जेक्ट को ऑब्जेसी एपीआई ऑब्जेक्ट में रैप करके iOS एपीआई बनाएं. कॉन्टेंट बनाने बनाए गए एपीआई ऑब्जेक्ट का इस्तेमाल,objC या Swift में से किसी एक में किया जा सकता है. iOS API के लिए ज़रूरी है कि पहले बनाया जाने वाला नेटिव एपीआई.

इस्तेमाल के उदाहरण

यहां ऑब्जेसी का इस्तेमाल करके एक उदाहरण दिया गया है TFLBertQuestionAnswerer MobileBert के लिए स्विफ़्ट में.

  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

एपीआई बनाना

चौथी इमेज: iOS टास्क एपीआई

iOS API, नेटिव एपीआई के ऊपर एक सामान्य ऑब्जेसी रैपर है. एपीआई बनाएं इसके लिए, यह तरीका अपनाएं:

• ObjC रैपर तय करें - ऑब्जेसी क्लास तय करें और संबंधित नेटिव एपीआई ऑब्जेक्ट को लागू करना. नेटिव लेआउट चुनें डिपेंडेंसी किसी .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];
    }
  }