Criar sua própria API Task

A biblioteca de tarefas do TensorFlow Lite fornece recursos APIs C++, Android e iOS sobre a mesma infraestrutura que abstrai o TensorFlow. É possível ampliar a infraestrutura da API Task para criar APIs personalizadas se o modelo não for compatível com as bibliotecas Task existentes.

Visão geral

A infraestrutura da API Task tem uma estrutura de duas camadas: a camada C++ inferior encapsulando o tempo de execução do TFLite e a camada superior Java/ObjC que se comunica com a camada C++ por meio de JNI ou wrapper.

Implementar toda a lógica do TensorFlow apenas em C++ minimiza o custo, maximiza desempenho de inferência e simplifica o fluxo de trabalho geral em todas as plataformas.

Para criar uma classe Task, estenda o BaseTaskApi para fornecer lógica de conversão entre a interface do modelo TFLite e a API Task interface do usuário e use os utilitários do Java/ObjC para criar as APIs correspondentes. Com todos os detalhes do TensorFlow ocultos, é possível implantar o modelo do TFLite nos seus apps mesmo sem conhecimento de machine learning.

O TensorFlow Lite fornece algumas APIs pré-criadas para os Tarefas de visão e PLN. É possível criar suas próprias APIs para outras tarefas usando a infraestrutura da API do Google Tarefas.

prebuilt_task_apis
Figura 1. APIs Task pré-criadas

Criar sua própria API com a infraestrutura da API Task

API C++

Todos os detalhes do TFLite são implementados na API C++. Crie um objeto de API usando uma das funções de fábrica e chamar as funções para conseguir os resultados do modelo. definidos na interface.

Exemplo de uso

Este é um exemplo que usa BertQuestionAnswerer para MobileBert (link em inglês).

  char kBertModelPath[] = "path/to/model.tflite";
  // Create the API from a model file
  std::unique_ptr<BertQuestionAnswerer> question_answerer =
      BertQuestionAnswerer::CreateFromFile(kBertModelPath);

  char kContext[] = ...; // context of a question to be answered
  char kQuestion[] = ...; // question to be answered
  // ask a question
  std::vector<QaAnswer> answers = question_answerer.Answer(kContext, kQuestion);
  // answers[0].text is the best answer

Como criar a API

native_task_api
Figura 2. API Native Task

Para criar um objeto de API,você deve fornecer as seguintes informações estendendo BaseTaskApi

  • Determinar a E/S da API: a API precisa expor entradas/saídas semelhantes. em diferentes plataformas. Por exemplo: BertQuestionAnswerer usa duas strings (std::string& context, std::string& question) como entrada e gera uma saída vetor de respostas possíveis e probabilidades como std::vector<QaAnswer>. Isso é feito especificando os tipos correspondentes no arquivo BaseTaskApi parâmetro do modelo. Com os parâmetros do modelo especificados, BaseTaskApi::Infer terá os tipos corretos de entrada/saída. Essa função pode ser chamados diretamente pelos clientes da API, mas é uma prática recomendada envolvê-lo uma função específica do modelo, neste caso, BertQuestionAnswerer::Answer.

    class BertQuestionAnswerer : public BaseTaskApi<
                                  std::vector<QaAnswer>, // OutputType
                                  const std::string&, const std::string& // InputTypes
                                  > {
      // Model specific function delegating calls to BaseTaskApi::Infer
      std::vector<QaAnswer> Answer(const std::string& context, const std::string& question) {
        return Infer(context, question).value();
      }
    }
    
  • Forneça a lógica de conversão entre a E/S da API e o tensor de entrada/saída do model: com os tipos de entrada e saída especificados, as subclasses também precisam implementar as funções tipadas BaseTaskApi::Preprocess e BaseTaskApi::Postprocess As duas funções fornecem entradas e saídas no FlatBuffer do TFLite. A subclasse é responsável por atribuir valores dos tensores de E/S da API para E/S. Confira a implementação completa exemplo em BertQuestionAnswerer

    class BertQuestionAnswerer : public BaseTaskApi<
                                  std::vector<QaAnswer>, // OutputType
                                  const std::string&, const std::string& // InputTypes
                                  > {
      // Convert API input into tensors
      absl::Status BertQuestionAnswerer::Preprocess(
        const std::vector<TfLiteTensor*>& input_tensors, // input tensors of the model
        const std::string& context, const std::string& query // InputType of the API
      ) {
        // Perform tokenization on input strings
        ...
        // Populate IDs, Masks and SegmentIDs to corresponding input tensors
        PopulateTensor(input_ids, input_tensors[0]);
        PopulateTensor(input_mask, input_tensors[1]);
        PopulateTensor(segment_ids, input_tensors[2]);
        return absl::OkStatus();
      }
    
      // Convert output tensors into API output
      StatusOr<std::vector<QaAnswer>> // OutputType
      BertQuestionAnswerer::Postprocess(
        const std::vector<const TfLiteTensor*>& output_tensors, // output tensors of the model
      ) {
        // Get start/end logits of prediction result from output tensors
        std::vector<float> end_logits;
        std::vector<float> start_logits;
        // output_tensors[0]: end_logits FLOAT[1, 384]
        PopulateVector(output_tensors[0], &end_logits);
        // output_tensors[1]: start_logits FLOAT[1, 384]
        PopulateVector(output_tensors[1], &start_logits);
        ...
        std::vector<QaAnswer::Pos> orig_results;
        // Look up the indices from vocabulary file and build results
        ...
        return orig_results;
      }
    }
    
  • Criar funções de fábrica da API: um arquivo modelo e um OpResolver são necessários para inicializar tflite::Interpreter TaskAPIFactory fornece funções utilitárias para criar instâncias de BaseTaskApi.

    Você também precisa fornecer todos os arquivos associados ao modelo. Por exemplo: BertQuestionAnswerer também pode ter um arquivo adicional para o tokenizador vocabulário.

    class BertQuestionAnswerer : public BaseTaskApi<
                                  std::vector<QaAnswer>, // OutputType
                                  const std::string&, const std::string& // InputTypes
                                  > {
      // Factory function to create the API instance
      StatusOr<std::unique_ptr<QuestionAnswerer>>
      BertQuestionAnswerer::CreateBertQuestionAnswerer(
          const std::string& path_to_model, // model to passed to TaskApiFactory
          const std::string& path_to_vocab  // additional model specific files
      ) {
        // Creates an API object by calling one of the utils from TaskAPIFactory
        std::unique_ptr<BertQuestionAnswerer> api_to_init;
        ASSIGN_OR_RETURN(
            api_to_init,
            core::TaskAPIFactory::CreateFromFile<BertQuestionAnswerer>(
                path_to_model,
                absl::make_unique<tflite::ops::builtin::BuiltinOpResolver>(),
                kNumLiteThreads));
    
        // Perform additional model specific initializations
        // In this case building a vocabulary vector from the vocab file.
        api_to_init->InitializeVocab(path_to_vocab);
        return api_to_init;
      }
    }
    

API do Android

Criar APIs Android definindo a interface Java/Kotlin e delegando a lógica para a camada C++ pelo JNI. A API do Android exige que a API nativa seja criada primeiro.

Exemplo de uso

Este é um exemplo que usa Java BertQuestionAnswerer para MobileBert (link em inglês).

  String BERT_MODEL_FILE = "path/to/model.tflite";
  String VOCAB_FILE = "path/to/vocab.txt";
  // Create the API from a model file and vocabulary file
    BertQuestionAnswerer bertQuestionAnswerer =
        BertQuestionAnswerer.createBertQuestionAnswerer(
            ApplicationProvider.getApplicationContext(), BERT_MODEL_FILE, VOCAB_FILE);

  String CONTEXT = ...; // context of a question to be answered
  String QUESTION = ...; // question to be answered
  // ask a question
  List<QaAnswer> answers = bertQuestionAnswerer.answer(CONTEXT, QUESTION);
  // answers.get(0).text is the best answer

Como criar a API

android_task_api
Figura 3. API Android Task

Semelhante às APIs nativas, para criar um objeto de API, o cliente precisa fornecer o seguintes informações, estendendo BaseTaskApi, que fornece processamentos JNI para todas as APIs de tarefas Java.

  • Determinar a E/S da API: geralmente espelha as interfaces nativas. Por exemplo: BertQuestionAnswerer usa (String context, String question) como entrada. e gera List<QaAnswer>. A implementação chama um modelo nativo particular função com assinatura semelhante, mas tem um parâmetro extra long nativeHandle, que é o ponteiro retornado de 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
                                           );
    
    }
    
  • Criar funções de fábrica da API: isso também espelha o código nativo de fábrica exceto as funções de fábrica do Android, que também precisam tomar Context para acessar os arquivos. A implementação chama um dos utilitários TaskJniUtils para criar o objeto correspondente da API em C++ e passar seu ponteiro para a construtor 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);
    
      }
    
  • Implementar o módulo JNI para funções nativas: todos os métodos nativos do Java são implementados chamando uma função nativa correspondente do JNI mais tarde neste módulo. As funções de fábrica criariam um objeto de API nativo e retornariam seu ponteiro como um tipo longo para Java. Em chamadas posteriores à API Java, o é passado de volta para o JNI e convertido de volta para o objeto da API nativa. Os resultados da API nativa são convertidos de volta em resultados em Java.

    Por exemplo, é assim que bert_question_answerer_jni é implementado.

      // 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

Crie APIs para iOS encapsulando um objeto de API nativo em um objeto de API ObjC. A pode ser usado no ObjC ou no Swift. A API do iOS exige a API nativa seja criada primeiro.

Exemplo de uso

Este é um exemplo que usa ObjC TFLBertQuestionAnswerer para MobileBert em 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

Como criar a API

ios_task_api
Figura 4. API iOS Task

A API do iOS é um wrapper ObjC simples sobre a API nativa. Criar a API siga as etapas abaixo:

  • Definir o wrapper ObjC: defina uma classe ObjC e delegue o implementações ao objeto da API nativa correspondente. Observe o dependências só podem aparecer em um arquivo .mm devido à incapacidade do Swift de de interoperabilidade com o C++.

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