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

नेटिव एपीआई के समान, एपीआई ऑब्जेक्ट बनाने के लिए, क्लाइंट को BaseTaskApi विस्तार करके निम्नलिखित जानकारी प्रदान करने की आवश्यकता होती है, जो सभी जावा टास्क एपीआई के लिए जेएनआई हैंडलिंग प्रदान करता है।

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

• एपीआई के फ़ैक्टरी फ़ंक्शंस बनाएं - यह मूल फ़ैक्टरी फ़ंक्शंस को भी प्रतिबिंबित करता है, सिवाय इसके कि एंड्रॉइड फ़ैक्टरी फ़ंक्शंस को फ़ाइल एक्सेस के लिए Context लेने की भी आवश्यकता होती है। कार्यान्वयन संबंधित C++ API ऑब्जेक्ट बनाने और इसके पॉइंटर को BaseTaskApi कंस्ट्रक्टर को पास करने के लिए TaskJniUtils में उपयोगिताओं में से एक को कॉल करता है।

    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);
  
    }
  

• मूल कार्यों के लिए जेएनआई मॉड्यूल को कार्यान्वित करें - सभी जावा मूल तरीकों को जेएनआई मॉड्यूल से संबंधित मूल फ़ंक्शन को कॉल करके कार्यान्वित किया जाता है। फ़ैक्टरी फ़ंक्शंस एक मूल एपीआई ऑब्जेक्ट बनाएगा और उसके पॉइंटर को लंबे प्रकार के रूप में जावा में लौटाएगा। जावा एपीआई के बाद के कॉल में, लंबे प्रकार के पॉइंटर को जेएनआई को वापस भेज दिया जाता है और मूल एपीआई ऑब्जेक्ट पर वापस डाल दिया जाता है। फिर मूल एपीआई परिणाम वापस जावा परिणामों में परिवर्तित हो जाते हैं।

  उदाहरण के लिए, 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 API के लिए पहले मूल API बनाने की आवश्यकता होती है।

नमूना उपयोग

यहां स्विफ्ट में MobileBert के लिए ओबीजेसी TFLBertQuestionAnswerer उपयोग करने का एक उदाहरण दिया गया है।

  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

एपीआई का निर्माण

चित्र 4. आईओएस टास्क एपीआई

आईओएस एपीआई मूल एपीआई के शीर्ष पर एक सरल ओबीजेसी रैपर है। नीचे दिए गए चरणों का पालन करके एपीआई बनाएं:

• ओबीजेसी रैपर को परिभाषित करें - एक ओबीजेसी वर्ग को परिभाषित करें और कार्यान्वयन को संबंधित मूल एपीआई ऑब्जेक्ट को सौंपें। ध्यान दें कि स्विफ्ट की C++ के साथ इंटरऑप करने में असमर्थता के कारण मूल निर्भरताएँ केवल .mm फ़ाइल में दिखाई दे सकती हैं।

  • .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:));
  }
  

  • .मिमी फ़ाइल

    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];
    }
  }